LaunchDarkly API Client for Typescript Node Server
OTHER License
Bot releases are visible (Hide)
Full Changelog: https://github.com/launchdarkly/api-client-typescript/compare/16.1.0...16.1.1
Published by ldhenry 5 months ago
notInExperimentVariationId
field to flags
inside iteration
in the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
(Create Experiment)notInExperimentVariationId
field in flags
in the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations
(Create Iteration)notInExperimentVariationId
field to the flags
object in the response bodies of:
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
(Create Experiment)POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations
(Create Iteration)PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
(Patch Experiment)GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
(Get Experiment)PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
(Patch Experiment)Published by lucywyman 6 months ago
totalCount
field to response of GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows
limit
and offset
query params to getWorkflows
and getCustomRoles
endpointsfollowerId
, hasDataExport
, status
, contextKindTargeted
, and segmentTargeted
filters for the getFeatureFlags
endpointprojects
and roles
options for the expand
query parameter in the getTeams
endpointPublished by lucywyman 7 months ago
deprecated
and deprecatedDate
to the rep returned by the flags endpointsdescription
field for a segment ruleIntegrations (beta)
endpoints for working with big segment persistent store integrationsenvironmentKey
to dependent experiment replastModified
to the unbounded
object returned by Segment APIsresults
field to GET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/results
, deprecating treatmentResults
critical
to Environment object and POST /api/v2/projects/{projectKey}/environments
endpoint request body.expand
query parameter to GET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/results
with support for expanding traffic
PATCH /api/v2/flags/{projectKey}/{flagKey}/release
GET /api/v2
, GET /api/v2/openapi.json
, and GET /api/v2/public-ip-list
key
to the rep returned by flag defaults endpointstype
to code references statistics repsstandard
as a metric group kindprimarySingleMetric
, primaryFunnel
, and metrics
to IterationRep
, deprecating primaryMetric
and secondaryMetric
primarySingleMetricKey
and primaryFunnelKey
to IterationInput
, deprecating primary
in MetricInput
_versionId
field to the metric rep returned by metric and experimentation endpointskey
and name
required in MaintainerTeam
to match API behaviorfilter
to /api/v2/projects/{projectKey}/release-pipelines
limit
and offset
to /api/v2/projects/{projectKey}/release-pipelines
nameInGroup
as optional in MetricInGroupRep
if and only if the group isn't a funnel
.Published by lucywyman 11 months ago
unitOfAnalysis
field to the metric listing rep returned by get all metrics endpointlastSeen
field to the metric listing rep returned by get all metrics endpoint_access
object to the release pipeline rep returned by several endpoints_links
field to the team summary object returned by several endpointsiterationId
query string parameter to /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
limit
and offset
to /api/v2/segments/{projKey}/{envKey}
lastModifiedDate
field to response of GET /api/v2/segments/{projectKey}/{environmentKey}
sort
to /api/v2/segments/{projKey}/{envKey}
filter
to /api/v2/segments/{projKey}/{envKey}
_id
field to the expanded project
information in Teams
endpointspurpose
field to the FlagPost
input objectmigrationSettings
field to the FlagPost
input objectarchived
field to GET /api/v2/projects/{projectKey}/context-kinds
and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
items
required in FlagFollowersGetRep
to match API behavior_flagCount
field to GET /api/v2/segments/{projectKey}/{environmentKey}
totalEvaluations
field to GET /api/v2/usage/evaluations/{projKey}/{envKey}/{flagKey}
code
and message
on error reps to be required to match API behaviorname
field to PhaseInfo
for GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
unitAggregationType
, analysisType
, and eventDefault
fields to GET /api/v2/metrics/{projectKey}
, GET /api/v2/metrics/{projectKey}/{metricKey}
, POST /api/v2/metrics/{projectKey}
, and PATCH /api/v2/metrics/{projectKey}/{metricKey}
items
as required in EnvironmentCollectionRep
to match API behaviorcolor
and name
as required in EnvironmentSummaryRep
to match API behavior@Failure 404
with a value of Member not found
to POST /api/v2/members/{id}/teams
migrationSettings
expand parameter to GET /api/v2/flags/{projectKey}
migrationSettings
expand parameter to GET /api/v2/flags/{projectKey}/{featureFlagKey}
limit
and offset
query params to GET /projects/{projKey}/release-pipelines/{pipelineKey}/releases
items
as required on ExperimentCollectionRep
to match API behaviorisGroup
and metrics
fields to DependentMetricOrMetricGroupRep
isGroup
field to MetricInput
randomizationUnits
field to MetricInGroupRep
metricGroups
and metricGroupCount
expand parameters to the getMetric
endpointPATCH /projects/{projKey}/release-pipelines/{pipelineKey}
out of hidden docsdeprecated
property on legacy experimentation operation which has already been deprecated
/api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}
deprecated
on offset
parameter which has already been deprecated
/api/v2/user-search/{projectKey}
deprecated
on flag-related schema properties that have already been deprecatedReviewOutput
to optionally return serviceTokenId
, omitted when approval reviewer was a memberReviewResponse
to optionally return serviceTokenId
, omitted when approval reviewer was a memberFlagConfigApprovalRequestResponse
to optionally return appliedByServiceTokenId
, omitted when a member applies an approvaldeprecated
property on legacy users endpoints, which are replaced by contexts endpoints
/api/v2/users/{projectKey}/{environmentKey}/{userKey}
/api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}
/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags
/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}
/api/v2/users/{projectKey}/{environmentKey}
/api/v2/users/{projectKey}/{environmentKey}/{userKey}
/api/v2/user-attributes/{projectKey}/{environmentKey}
/api/v2/user-search/{projectKey}/{environmentKey}
/api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}
/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}
Member
struct to clarify that in the permissionGrants
, only one of actions
or actionSet
is requiredPrimaryMetric
in IterationRep
maintainerId
to be an optional parameter when creating a new experimentcontextTargets
field for flags endpoints to be requiredmetricWrapper
to MetricWrapper
Effect
in custom roles to string
expand
query parameter for the getExperiment
endpoint
/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
archived
field on GET /api/v2/projects/{projectKey}/context-kinds
and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
hideInTargeting
field on GET /api/v2/projects/{projectKey}/context-kinds
and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
/api/v2/flags/{projectKey}/{flagKey}/release
and PATCH /api/v2/flags/{projectKey}/{flagKey}/release
to include MemberSummary
and TokenSummary
in each phase's completedBy
field instead of having flat values.activeReleases
and completedReleases
to activeCount
and totalCount
for GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
FeatureFlag
and FeatureFlagConfig
to return migrationSettings
when calling PATCH /api/v2/flags/{projectKey}/{featureFlagKey}
deprecated
property on archived
query param for GET /api/v2/flags/{projectKey}
DependentMetricRep
to DependentMetricOrMetricGroupRep
kind
field in DependentMetricOrMetricGroupRep
to allow enum value funnel
, used for metric groupsMetricWrapper
to MetricInGroupRep
metricGroups
and metricGroupCount
fields are expandable, omitted by defaultRootResponse
schema was incorrectPublished by lucywyman over 1 year ago
Published by goyanespaula over 1 year ago
customRoles
expand parameter to GET /api/v2/members
contextKindTargeted
filter parameter to GET /api/v2/flags/{projectKey}
contextKindsEvaluated
filter parameter to GET /api/v2/flags/{projectKey}
evaluation
expand parameter to GET /api/v2/flags/{projectKey}
evaluation
expand parameter to GET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}
memberId
in follow flag endpoints putFlagFollowers
and deleteFlagFollowers
to reflect the limitation of Reader roles.ExpandableApprovalRequestResponse
to optionally return environments
instead of environment
which is only used in beta APIsPublished by lucywyman over 1 year ago
StopDate
to ExecutionOutput
objectGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows
user
context and of a context instanceuser
context kindresults
field to the experiment metric results response for contexts that have data slicing enabledresourceId
and approvalSettings
fields to the responses for getApprovalRequest
and getApprovalRequests
status
query parameters to the getWorkflows
beta endpointexperimentalProperties
field to experiment create post bodyrandomizationUnit
to
IterationInput
objectgetExperiment
, getExperiments
, and createIteration
randomizationUnits
to
MetricPost
objectgetMetric
and getMetrics
getAuditLogEntries
to reflect that audit logs aren't specific to feature flagspostApprovalRequest
to postApprovalRequestForFlag
to reflect that it's flag specific. The title has also been updated to reflect this.postApprovalRequestReview
to postApprovalRequestReviewForFlag
to reflect that it's flag specific. The title has also been updated to reflect this.postApprovalRequestApplyRequest
to postApprovalRequestApplyForFlag
to reflect that it's flag specific. The title has also been updated to reflect this.deleteApprovalRequest
to deleteApprovalRequestForFlag
to reflect that it's flag specific. The title has also been updated to reflect this.getApprovalRequests
. Support for the old syntax is being dropped. See documentation for new syntax.Links
in FlagConfigApprovalRequestResponse
postWorkflow
beta endpoint
name
is required
(previously incorrectly marked as optional)description
is optional
(previously incorrectly marked as required)Published by lucywyman almost 2 years ago
targetingRuleDescription
to experiment iteration flag responsetargetingRuleClauses
to experiment iteration flag responseprobabilityOfMismatch
to experiment result responsearchivedDate
field to experiment response, omitted when experiment is not archivedarchivedDate
field to expanded experiment for the Get metric endpoint, omitted when experiment is not archivedlifecycleState
parameter to Get experiments to query by archived and/or active experiments_idpSynced
parameter to Team
objectMaintainerTeam
in preparation for teams as flag maintainers (not yet released)kind
field in the metric types to only include the allowed enum values (pageview
, click
, custom
)experiments
field is expandable, omitted by defaultexperimentCount
field is expandable, omitted by defaultexperimentCount
field is expandable, omitted by defaultExpiringUserTargetError
to ExpiringTargetError
to prepare for expiring context targetsdefaultBranch
to main
if you do not specify a value during creationgitlab
is now a supported repoType
null
values with project-level flag defaultsgetApprovals
and getApproval
endpoints to getApprovalsForFlag
and getApprovalForFlag
respectivelysort
query param on GET /projects
ResourceIdentifier
from an empty Object to a string typeUUID
to be a string with format uuid
Published by carmenquan over 2 years ago
https://app.launchdarkly.us
ruleClause
to ParameterDefault
objectoauthProviders
to Member
objecttemplateKey
to CustomWorkflowInputRep
objectnotifyTeamKeys
parameter to
StatementRep
to Statement
StatementRep
to Statement
environment
field is expandable, omitted by defaultenvironment
field is expandable, omitted by defaultnotifyMemberIds
from required to optional for create approval and flag config copy approval requestsreviewStatus
and status
in FlagConfigApprovalRequestResponse
kind
in ReviewResponse
variationJsonSchema
from FeatureFlagBody
variations
to FlagSummary
objectGET /api/v2/flags/{projectKey}
response that are only shown when the request contains ?summary=false
Published by jazanne over 2 years ago
Published by carmenquan over 2 years ago
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
reason
to ExecutionOutputRep
executeConditionsInSequence
to StageInputRep
fileCount
to StatisticRep
Published by carmenquan over 2 years ago
GET /api/v2/tags
GET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}
POST /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}
DELETE /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}
PATCH /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}
GET /api/v2/integration-capabilities/featureStore
GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}
POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}
GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
DELETE /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
PATCH /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validate
POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports
GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID}
POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports
GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID}
GET /api/v2/teams/{teamKey}/maintainers
GET /api/v2/teams/{teamKey}/roles
source
to EnvironmentPost
compare
query parameter to GET /api/v2/flags/{projectKey}
totalCountWithDifferences
property to FeatureFlags
objectderived
property from User
object409
conflict response to DELETE /api/v2/flags/{projectKey}/{featureFlagKey}
Published by carmenquan almost 3 years ago
postMemberTeams
from MemberTeamsFormPost
to MemberTeamsPostInput
StatementPost
and StatementPostData
had incorrectly marked resources
and actions
as required propertiesPublished by carmenquan almost 3 years ago
GET /api/v2/integrations/{integrationKey}
POST /api/v2/integrations/{integrationKey}
GET /api/v2/integrations/{integrationKey}/{id}
DELETE /api/v2/integrations/{integrationKey}/{id}
PATCH /api/v2/integrations/{integrationKey}/{id}
GET /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}
POST /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}
GET /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}/{id}
DELETE /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}/{id}
PATCH /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}/{id}
POST /api/v2/teams/{key}/members
POST /api/v2/members/{id}/teams
to
and from
query parameters in getExtinctions
ref
property to rule
objectcommitTime
property to branch
objectminutesAgo
to timestamp
in our beta GET /api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey}
responsesuccessCriteria
property now expects a string
with value HigherThanBaseline
or LowerThanBaseline
, it was previously incorrectly expecting an int
GET /api/v2/teams/{key}
was incorrectly returning TeamRep
. It’s been corrected to return ExpandedTeamRep
PATCH /api/v2/teams/{key}
was incorrectly returning TeamCollectionRep
. It’s been corrected to return ExpandedTeamRep
Published by carmenquan almost 3 years ago
limit
, offset
, and filter
query parameters for getTeams
basePermissions
setting to custom rolesfilter
query parameter to getSearchUsers
sort
query parameter for getSearchUsers
creationDate
to Member
metricSeen
to ExperimentResultsRep
requireComments
, confirmChanges
to Environment
getRoot
was previously undocumentedpostExtinction
was previously undocumentedpostMembers
was previously undocumentedresources
and notResources
types in StatementRep
was previously undocumentedenvironments
type in ProjectPost
was previously undocumentedVariate
to Variation
postCustomRole
post bodygetCustomRole
customWorkflowMetaData
to customWorkflowMetadata
in FlagConfigApprovalRequestResponse
putBranch
post bodypostFlagCopyConfigApprovalRequest
getUser
to return full user
payloadPublished by InTheCloudDan about 3 years ago