/** * LaunchDarkly REST API * This documentation describes LaunchDarkly\'s REST API. To access the complete OpenAPI spec directly, use [Get OpenAPI spec](https://launchdarkly.com/docs/api/other/get-openapi-spec). ## Authentication LaunchDarkly\'s REST API uses the HTTPS protocol with a minimum TLS version of 1.2. All REST API resources are authenticated with either [personal or service access tokens](https://launchdarkly.com/docs/home/account/api), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [**Authorization**](https://app.launchdarkly.com/settings/authorization) page in the LaunchDarkly UI. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and JavaScript-based SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations such as fetching feature flag settings. | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal or service access tokens](https://launchdarkly.com/docs/home/account/api) | Can be customized on a per-token basis | Building scripts, custom integrations, data export. | | SDK keys | Can only access read-only resources specific to server-side SDKs. Restricted to a single environment. | Server-side SDKs | | Mobile keys | Can only access read-only resources specific to mobile SDKs, and only for flags marked available to mobile keys. Restricted to a single environment. | Mobile SDKs | | Client-side ID | Can only access read-only resources specific to JavaScript-based client-side SDKs, and only for flags marked available to client-side. Restricted to a single environment. | Client-side JavaScript | > #### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [**Authorization**](https://app.launchdarkly.com/settings/authorization) page. > > The client-side ID is safe to embed in untrusted contexts. It\'s designed for use in client-side JavaScript. ### Authentication using request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [**Authorization**](https://app.launchdarkly.com/settings/authorization) page. ### Authentication using session cookie For testing purposes, you can make API calls directly from your web browser. If you are logged in to the LaunchDarkly application, the API will use your existing session to authenticate calls. If you have a [role](https://launchdarkly.com/docs/home/account/built-in-roles) other than Admin, or have a [custom role](https://launchdarkly.com/docs/home/account/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what\'s expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. ## Representations All resources expect and return JSON response bodies. Error responses also send a JSON body. To learn more about the error format of the API, read [Errors](https://launchdarkly.com/docs/api#errors). In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PATCH`, `POST`, and `PUT` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ### Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource, such as a single feature flag, you receive a _detailed representation_ of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ### Expanding responses Sometimes the detailed representation of a resource does not include all of the attributes of the resource by default. If this is the case, the request method will clearly document this and describe which attributes you can include in an expanded response. To include the additional attributes, append the `expand` request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append `?expand=members,maintainers` to the [Get team](https://launchdarkly.com/docs/api/teams/get-team) endpoint, the expanded response includes both of these attributes. ### Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link Each link has two attributes: - An `href`, which contains the URL - A `type`, which describes the content type For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. ## Updates Resources that accept partial updates use the `PATCH` verb. Most resources support the [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) format. Some resources also support the [JSON merge patch](https://launchdarkly.com/docs/api#updates-using-json-merge-patch) format, and some resources support the [semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch) format, which is a way to specify the modifications to perform as a set of executable instructions. Each resource supports optional [comments](https://launchdarkly.com/docs/api#updates-with-comments) that you can submit with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. When a resource supports both JSON patch and semantic patch, we document both in the request method. However, the specific request body fields and descriptions included in our documentation only match one type of patch or the other. ### Updates using JSON patch [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) is a way to specify the modifications to perform on a resource. JSON patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. JSON patch documents are always arrays, where each element contains an operation, a path to the field to update, and the new value. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag\'s description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag\'s `version` is `10`, and if so, changes the feature flag\'s description. Attributes that are not editable, such as a resource\'s `_links`, have names that start with an underscore. ### Updates using JSON merge patch [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) is another format for specifying the modifications to perform on a resource. JSON merge patch is less expressive than JSON patch. However, in many cases it is simpler to construct a merge patch document. For example, you can change a feature flag\'s description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ### Updates using semantic patch Some resources support the semantic patch format. A semantic patch is a way to specify the modifications to perform on a resource as a set of executable instructions. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, you can define semantic patch instructions independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. Here\'s how: ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ``` If you call a semantic patch resource without this header, you will receive a `400` response because your semantic patch will be interpreted as a JSON patch. The body of a semantic patch request takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required for some resources only) The environment key. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the instruction requires parameters, you must include those parameters as additional fields in the object. The documentation for each resource that supports semantic patch includes the available instructions and any additional parameters. For example: ```json { \"comment\": \"optional comment\", \"instructions\": [ {\"kind\": \"turnFlagOn\"} ] } ``` Semantic patches are not applied partially; either all of the instructions are applied or none of them are. If **any** instruction is invalid, the endpoint returns an error and will not change the resource. If all instructions are valid, the request succeeds and the resources are updated if necessary, or left unchanged if they are already in the state you request. ### Updates with comments You can submit optional comments with `PATCH` changes. To submit a comment along with a JSON patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON merge patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` To submit a comment along with a semantic patch, use the following format: ```json { \"comment\": \"This is a comment string\", \"instructions\": [ {\"kind\": \"turnFlagOn\"} ] } ``` ## Errors The API always returns errors in a common format. Here\'s an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The `code` indicates the general class of error. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you\'re working with LaunchDarkly Support to debug a problem with a specific API call. ### HTTP status error response codes | Code | Definition | Description | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Invalid request | The request cannot be understood. | Ensure JSON syntax in request body is correct. | | 401 | Invalid access token | Requestor is unauthorized or does not have permission for this API call. | Ensure your API access token is valid and has the appropriate permissions. | | 403 | Forbidden | Requestor does not have access to this resource. | Ensure that the account member or access token has proper permissions set. | | 404 | Invalid resource identifier | The requested resource is not valid. | Ensure that the resource is correctly identified by ID or key. | | 405 | Method not allowed | The request method is not allowed on this resource. | Ensure that the HTTP verb is correct. | | 409 | Conflict | The API request can not be completed because it conflicts with a concurrent API request. | Retry your request. | | 422 | Unprocessable entity | The API request can not be completed because the update description can not be understood. | Ensure that the request body is correct for the type of patch you are using, either JSON patch or semantic patch. | 429 | Too many requests | Read [Rate limiting](https://launchdarkly.com/docs/api#rate-limiting). | Wait and try again later. | ## CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise the request returns a wildcard, `Access-Control-Allow-Origin: *`. For more information on CORS, read the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](https://launchdarkly.com/docs/api#authentication). If you are using session authentication, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted entities. ## Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs return a `429` status code. Calls to our APIs include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. ### Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that your account can make to the API per ten seconds. All service and personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits may return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ### Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any service or personal access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](https://launchdarkly.com/docs/api/environments/delete-environment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that an account can make to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ### IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. ## OpenAPI (Swagger) and client libraries We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit the [collection of client libraries on GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). You can also use this specification to generate client libraries to interact with our REST API in your language of choice. Our OpenAPI specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to explore our APIs. ## Method overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `DELETE`, `PATCH`, and `PUT` verbs are inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `DELETE`, `PATCH`, and `PUT` requests using a `POST` request. For example, to call a `PATCH` endpoint using a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. ## Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we\'re satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](https://launchdarkly.com/docs/api#beta-resources). > > Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. ### Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you receive a `403` response. Use this header: ``` LD-API-Version: beta ``` ## Federal environments The version of LaunchDarkly that is available on domains controlled by the United States government is different from the version of LaunchDarkly available to the general public. If you are an employee or contractor for a United States federal agency and use LaunchDarkly in your work, you likely use the federal instance of LaunchDarkly. If you are working in the federal instance of LaunchDarkly, the base URI for each request is `https://app.launchdarkly.us`. To learn more, read [LaunchDarkly in federal environments](https://launchdarkly.com/docs/home/infrastructure/federal). ## Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don\'t prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ### Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20240415 ``` The header value is the version number of the API version you would like to request. The number for each version corresponds to the date the version was released in `yyyymmdd` format. In the example above the version `20240415` corresponds to April 15, 2024. ### Setting the API version per access token When you create an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426`, which is the version of the API that existed before the current versioning scheme, so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing. ### API version changelog
Version Changes End of life (EOL)
`20240415`
  • Changed several endpoints from unpaginated to paginated. Use the `limit` and `offset` query parameters to page through the results.
  • Changed the [list access tokens](https://launchdarkly.com/docs/api/access-tokens/get-tokens) endpoint:
    • Response is now paginated with a default limit of `25`
  • Changed the [list account members](https://launchdarkly.com/docs/api/account-members/get-members) endpoint:
    • The `accessCheck` filter is no longer available
  • Changed the [list custom roles](https://launchdarkly.com/docs/api/custom-roles/get-custom-roles) endpoint:
    • Response is now paginated with a default limit of `20`
  • Changed the [list feature flags](https://launchdarkly.com/docs/api/feature-flags/get-feature-flags) endpoint:
    • Response is now paginated with a default limit of `20`
    • The `environments` field is now only returned if the request is filtered by environment, using the `filterEnv` query parameter
    • The `followerId`, `hasDataExport`, `status`, `contextKindTargeted`, and `segmentTargeted` filters are no longer available
    • The `compare` query parameter is no longer available
  • Changed the [list segments](https://launchdarkly.com/docs/api/segments/get-segments) endpoint:
    • Response is now paginated with a default limit of `20`
  • Changed the [list teams](https://launchdarkly.com/docs/api/teams/get-teams) endpoint:
    • The `expand` parameter no longer supports including `projects` or `roles`
    • In paginated results, the maximum page size is now 100
  • Changed the [get workflows](https://launchdarkly.com/docs/api/workflows/get-workflows) endpoint:
    • Response is now paginated with a default limit of `20`
    • The `_conflicts` field in the response is no longer available
 Current
`20220603`
  • Changed the [list projects](https://launchdarkly.com/docs/api/projects/get-projects) return value:
    • Response is now paginated with a default limit of `20`.
    • Added support for filter and sort.
    • The project `environments` field is now expandable. This field is omitted by default.
  • Changed the [get project](https://launchdarkly.com/docs/api/projects/get-project) return value:
    • The `environments` field is now expandable. This field is omitted by default.
 2025-04-15
`20210729`
  • Changed the [create approval request](https://launchdarkly.com/docs/api/approvals/post-approval-request) return value. It now returns HTTP Status Code `201` instead of `200`.
  • Changed the [get user](https://launchdarkly.com/docs/api/users/get-user) return value. It now returns a user record, not a user.
  • Added additional optional fields to environment, segments, flags, members, and segments, including the ability to create big segments.
  • Added default values for flag variations when new environments are created.
  • Added filtering and pagination for getting flags and members, including `limit`, `number`, `filter`, and `sort` query parameters.
  • Added endpoints for expiring user targets for flags and segments, scheduled changes, access tokens, Relay Proxy configuration, integrations and subscriptions, and approvals.
2023-06-03
`20191212`
  • [List feature flags](https://launchdarkly.com/docs/api/feature-flags/get-feature-flags) now defaults to sending summaries of feature flag configurations, equivalent to setting the query parameter `summary=true`. Summaries omit flag targeting rules and individual user targets from the payload.
  • Added endpoints for flags, flag status, projects, environments, audit logs, members, users, custom roles, segments, usage, streams, events, and data export.
2022-07-29
`20160426`
  • Initial versioning of API. Tokens created before versioning have their version set to this.
 2020-12-12
To learn more about how EOL is determined, read LaunchDarkly\'s [End of Life (EOL) Policy](https://launchdarkly.com/policies/end-of-life-policy/). * * The version of the OpenAPI document: 2.0 * Contact: support@launchdarkly.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface AIConfig */ export interface AIConfig { /** * * @type {AiConfigsAccess} * @memberof AIConfig */ '_access'?: AiConfigsAccess; /** * * @type {ParentAndSelfLinks} * @memberof AIConfig */ '_links'?: ParentAndSelfLinks; /** * * @type {string} * @memberof AIConfig */ 'description': string; /** * * @type {string} * @memberof AIConfig */ 'key': string; /** * * @type {AIConfigMaintainer} * @memberof AIConfig */ '_maintainer'?: AIConfigMaintainer; /** * * @type {string} * @memberof AIConfig */ 'name': string; /** * * @type {Array} * @memberof AIConfig */ 'tags': Array; /** * * @type {number} * @memberof AIConfig */ 'version': number; /** * * @type {Array} * @memberof AIConfig */ 'variations': Array; /** * * @type {number} * @memberof AIConfig */ 'createdAt': number; /** * * @type {number} * @memberof AIConfig */ 'updatedAt': number; } /** * @type AIConfigMaintainer * @export */ export type AIConfigMaintainer = AiConfigsMaintainerTeam | MaintainerMember; /** * * @export * @interface AIConfigPatch */ export interface AIConfigPatch { /** * * @type {string} * @memberof AIConfigPatch */ 'description'?: string; /** * * @type {string} * @memberof AIConfigPatch */ 'maintainerId'?: string; /** * * @type {string} * @memberof AIConfigPatch */ 'maintainerTeamKey'?: string; /** * * @type {string} * @memberof AIConfigPatch */ 'name'?: string; /** * * @type {Array} * @memberof AIConfigPatch */ 'tags'?: Array; } /** * * @export * @interface AIConfigPost */ export interface AIConfigPost { /** * * @type {string} * @memberof AIConfigPost */ 'description'?: string; /** * * @type {string} * @memberof AIConfigPost */ 'key': string; /** * * @type {string} * @memberof AIConfigPost */ 'maintainerId'?: string; /** * * @type {string} * @memberof AIConfigPost */ 'maintainerTeamKey'?: string; /** * * @type {string} * @memberof AIConfigPost */ 'name': string; /** * * @type {Array} * @memberof AIConfigPost */ 'tags'?: Array; } /** * * @export * @interface AIConfigVariation */ export interface AIConfigVariation { /** * * @type {ParentLink} * @memberof AIConfigVariation */ '_links'?: ParentLink; /** * * @type {string} * @memberof AIConfigVariation */ 'key': string; /** * * @type {Array} * @memberof AIConfigVariation */ 'messages': Array; /** * * @type {object} * @memberof AIConfigVariation */ 'model': object; /** * * @type {string} * @memberof AIConfigVariation */ 'modelConfigKey'?: string; /** * * @type {string} * @memberof AIConfigVariation */ 'name': string; /** * * @type {number} * @memberof AIConfigVariation */ 'createdAt': number; /** * * @type {number} * @memberof AIConfigVariation */ 'version': number; /** * * @type {string} * @memberof AIConfigVariation */ 'state'?: string; /** * * @type {number} * @memberof AIConfigVariation */ '_archivedAt'?: number; /** * * @type {number} * @memberof AIConfigVariation */ '_publishedAt'?: number; } /** * * @export * @interface AIConfigVariationPatch */ export interface AIConfigVariationPatch { /** * * @type {Array} * @memberof AIConfigVariationPatch */ 'messages'?: Array; /** * * @type {object} * @memberof AIConfigVariationPatch */ 'model'?: object; /** * * @type {string} * @memberof AIConfigVariationPatch */ 'modelConfigKey'?: string; /** * * @type {string} * @memberof AIConfigVariationPatch */ 'name'?: string; /** * * @type {boolean} * @memberof AIConfigVariationPatch */ 'published'?: boolean; /** * One of \'archived\', \'published\' * @type {string} * @memberof AIConfigVariationPatch */ 'state'?: string; } /** * * @export * @interface AIConfigVariationPost */ export interface AIConfigVariationPost { /** * * @type {string} * @memberof AIConfigVariationPost */ 'key': string; /** * * @type {Array} * @memberof AIConfigVariationPost */ 'messages': Array; /** * * @type {object} * @memberof AIConfigVariationPost */ 'model': object; /** * * @type {string} * @memberof AIConfigVariationPost */ 'name': string; /** * * @type {string} * @memberof AIConfigVariationPost */ 'modelConfigKey'?: string; } /** * * @export * @interface AIConfigVariationsResponse */ export interface AIConfigVariationsResponse { /** * * @type {Array} * @memberof AIConfigVariationsResponse */ 'items': Array; /** * * @type {number} * @memberof AIConfigVariationsResponse */ 'totalCount': number; } /** * * @export * @interface AIConfigs */ export interface AIConfigs { /** * * @type {PaginatedLinks} * @memberof AIConfigs */ '_links'?: PaginatedLinks; /** * * @type {Array} * @memberof AIConfigs */ 'items': Array; /** * * @type {number} * @memberof AIConfigs */ 'totalCount': number; } /** * * @export * @interface Access */ export interface Access { /** * * @type {Array} * @memberof Access */ 'denied': Array; /** * * @type {Array} * @memberof Access */ 'allowed': Array; } /** * * @export * @interface AccessAllowedReason */ export interface AccessAllowedReason { /** * Resource specifier strings * @type {Array} * @memberof AccessAllowedReason */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field. * @type {Array} * @memberof AccessAllowedReason */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof AccessAllowedReason */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field. * @type {Array} * @memberof AccessAllowedReason */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof AccessAllowedReason */ 'effect': AccessAllowedReasonEffectEnum; /** * * @type {string} * @memberof AccessAllowedReason */ 'role_name'?: string; } export declare const AccessAllowedReasonEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type AccessAllowedReasonEffectEnum = typeof AccessAllowedReasonEffectEnum[keyof typeof AccessAllowedReasonEffectEnum]; /** * * @export * @interface AccessAllowedRep */ export interface AccessAllowedRep { /** * * @type {string} * @memberof AccessAllowedRep */ 'action': string; /** * * @type {AccessAllowedReason} * @memberof AccessAllowedRep */ 'reason': AccessAllowedReason; } /** * * @export * @interface AccessDenied */ export interface AccessDenied { /** * * @type {string} * @memberof AccessDenied */ 'action': string; /** * * @type {AccessDeniedReason} * @memberof AccessDenied */ 'reason': AccessDeniedReason; } /** * * @export * @interface AccessDeniedReason */ export interface AccessDeniedReason { /** * Resource specifier strings * @type {Array} * @memberof AccessDeniedReason */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field. * @type {Array} * @memberof AccessDeniedReason */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof AccessDeniedReason */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field. * @type {Array} * @memberof AccessDeniedReason */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof AccessDeniedReason */ 'effect': AccessDeniedReasonEffectEnum; /** * * @type {string} * @memberof AccessDeniedReason */ 'role_name'?: string; } export declare const AccessDeniedReasonEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type AccessDeniedReasonEffectEnum = typeof AccessDeniedReasonEffectEnum[keyof typeof AccessDeniedReasonEffectEnum]; /** * * @export * @interface AccessTokenPost */ export interface AccessTokenPost { /** * A human-friendly name for the access token * @type {string} * @memberof AccessTokenPost */ 'name'?: string; /** * A description for the access token * @type {string} * @memberof AccessTokenPost */ 'description'?: string; /** * Built-in role for the token * @type {string} * @memberof AccessTokenPost */ 'role'?: AccessTokenPostRoleEnum; /** * A list of custom role IDs to use as access limits for the access token * @type {Array} * @memberof AccessTokenPost */ 'customRoleIds'?: Array; /** * A JSON array of statements represented as JSON objects with three attributes: effect, resources, actions. May be used in place of a built-in or custom role. * @type {Array} * @memberof AccessTokenPost */ 'inlineRole'?: Array; /** * Whether the token is a service token * @type {boolean} * @memberof AccessTokenPost */ 'serviceToken'?: boolean; /** * The default API version for this token * @type {number} * @memberof AccessTokenPost */ 'defaultApiVersion'?: number; } export declare const AccessTokenPostRoleEnum: { readonly Reader: "reader"; readonly Writer: "writer"; readonly Admin: "admin"; }; export type AccessTokenPostRoleEnum = typeof AccessTokenPostRoleEnum[keyof typeof AccessTokenPostRoleEnum]; /** * * @export * @interface ActionInput */ export interface ActionInput { /** * An array of instructions for the stage. Each object in the array uses the semantic patch format for updating a feature flag. * @type {any} * @memberof ActionInput */ 'instructions'?: any; } /** * * @export * @interface ActionOutput */ export interface ActionOutput { /** * The type of action for this stage * @type {string} * @memberof ActionOutput */ 'kind': string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof ActionOutput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface AiConfigsAccess */ export interface AiConfigsAccess { /** * * @type {Array} * @memberof AiConfigsAccess */ 'denied': Array; /** * * @type {Array} * @memberof AiConfigsAccess */ 'allowed': Array; } /** * * @export * @interface AiConfigsAccessAllowedReason */ export interface AiConfigsAccessAllowedReason { /** * Resource specifier strings * @type {Array} * @memberof AiConfigsAccessAllowedReason */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field. * @type {Array} * @memberof AiConfigsAccessAllowedReason */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof AiConfigsAccessAllowedReason */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field. * @type {Array} * @memberof AiConfigsAccessAllowedReason */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof AiConfigsAccessAllowedReason */ 'effect': AiConfigsAccessAllowedReasonEffectEnum; /** * * @type {string} * @memberof AiConfigsAccessAllowedReason */ 'role_name'?: string; } export declare const AiConfigsAccessAllowedReasonEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type AiConfigsAccessAllowedReasonEffectEnum = typeof AiConfigsAccessAllowedReasonEffectEnum[keyof typeof AiConfigsAccessAllowedReasonEffectEnum]; /** * * @export * @interface AiConfigsAccessAllowedRep */ export interface AiConfigsAccessAllowedRep { /** * * @type {string} * @memberof AiConfigsAccessAllowedRep */ 'action': string; /** * * @type {AiConfigsAccessAllowedReason} * @memberof AiConfigsAccessAllowedRep */ 'reason': AiConfigsAccessAllowedReason; } /** * * @export * @interface AiConfigsAccessDenied */ export interface AiConfigsAccessDenied { /** * * @type {string} * @memberof AiConfigsAccessDenied */ 'action': string; /** * * @type {AiConfigsAccessDeniedReason} * @memberof AiConfigsAccessDenied */ 'reason': AiConfigsAccessDeniedReason; } /** * * @export * @interface AiConfigsAccessDeniedReason */ export interface AiConfigsAccessDeniedReason { /** * Resource specifier strings * @type {Array} * @memberof AiConfigsAccessDeniedReason */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field. * @type {Array} * @memberof AiConfigsAccessDeniedReason */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof AiConfigsAccessDeniedReason */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field. * @type {Array} * @memberof AiConfigsAccessDeniedReason */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof AiConfigsAccessDeniedReason */ 'effect': AiConfigsAccessDeniedReasonEffectEnum; /** * * @type {string} * @memberof AiConfigsAccessDeniedReason */ 'role_name'?: string; } export declare const AiConfigsAccessDeniedReasonEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type AiConfigsAccessDeniedReasonEffectEnum = typeof AiConfigsAccessDeniedReasonEffectEnum[keyof typeof AiConfigsAccessDeniedReasonEffectEnum]; /** * * @export * @interface AiConfigsLink */ export interface AiConfigsLink { /** * * @type {string} * @memberof AiConfigsLink */ 'href'?: string; /** * * @type {string} * @memberof AiConfigsLink */ 'type'?: string; } /** * * @export * @interface AiConfigsMaintainerTeam */ export interface AiConfigsMaintainerTeam { /** * * @type {string} * @memberof AiConfigsMaintainerTeam */ 'key': string; /** * * @type {string} * @memberof AiConfigsMaintainerTeam */ 'name': string; } /** * * @export * @interface AnnouncementAccess */ export interface AnnouncementAccess { /** * * @type {Array} * @memberof AnnouncementAccess */ 'denied': Array; /** * * @type {Array} * @memberof AnnouncementAccess */ 'allowed': Array; } /** * * @export * @interface AnnouncementAccessAllowedReason */ export interface AnnouncementAccessAllowedReason { /** * Resource specifier strings * @type {Array} * @memberof AnnouncementAccessAllowedReason */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field. * @type {Array} * @memberof AnnouncementAccessAllowedReason */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof AnnouncementAccessAllowedReason */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field. * @type {Array} * @memberof AnnouncementAccessAllowedReason */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof AnnouncementAccessAllowedReason */ 'effect': AnnouncementAccessAllowedReasonEffectEnum; /** * * @type {string} * @memberof AnnouncementAccessAllowedReason */ 'role_name'?: string; } export declare const AnnouncementAccessAllowedReasonEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type AnnouncementAccessAllowedReasonEffectEnum = typeof AnnouncementAccessAllowedReasonEffectEnum[keyof typeof AnnouncementAccessAllowedReasonEffectEnum]; /** * * @export * @interface AnnouncementAccessAllowedRep */ export interface AnnouncementAccessAllowedRep { /** * * @type {string} * @memberof AnnouncementAccessAllowedRep */ 'action': string; /** * * @type {AnnouncementAccessAllowedReason} * @memberof AnnouncementAccessAllowedRep */ 'reason': AnnouncementAccessAllowedReason; } /** * * @export * @interface AnnouncementAccessDenied */ export interface AnnouncementAccessDenied { /** * * @type {string} * @memberof AnnouncementAccessDenied */ 'action': string; /** * * @type {AnnouncementAccessDeniedReason} * @memberof AnnouncementAccessDenied */ 'reason': AnnouncementAccessDeniedReason; } /** * * @export * @interface AnnouncementAccessDeniedReason */ export interface AnnouncementAccessDeniedReason { /** * Resource specifier strings * @type {Array} * @memberof AnnouncementAccessDeniedReason */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field. * @type {Array} * @memberof AnnouncementAccessDeniedReason */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof AnnouncementAccessDeniedReason */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field. * @type {Array} * @memberof AnnouncementAccessDeniedReason */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof AnnouncementAccessDeniedReason */ 'effect': AnnouncementAccessDeniedReasonEffectEnum; /** * * @type {string} * @memberof AnnouncementAccessDeniedReason */ 'role_name'?: string; } export declare const AnnouncementAccessDeniedReasonEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type AnnouncementAccessDeniedReasonEffectEnum = typeof AnnouncementAccessDeniedReasonEffectEnum[keyof typeof AnnouncementAccessDeniedReasonEffectEnum]; /** * * @export * @interface AnnouncementAccessRep */ export interface AnnouncementAccessRep { /** * * @type {Array} * @memberof AnnouncementAccessRep */ 'denied': Array; /** * * @type {Array} * @memberof AnnouncementAccessRep */ 'allowed': Array; } /** * * @export * @interface AnnouncementLink */ export interface AnnouncementLink { /** * * @type {string} * @memberof AnnouncementLink */ 'href'?: string; /** * * @type {string} * @memberof AnnouncementLink */ 'type'?: string; } /** * * @export * @interface AnnouncementPaginatedLinks */ export interface AnnouncementPaginatedLinks { /** * * @type {AnnouncementLink} * @memberof AnnouncementPaginatedLinks */ 'first'?: AnnouncementLink; /** * * @type {AnnouncementLink} * @memberof AnnouncementPaginatedLinks */ 'last'?: AnnouncementLink; /** * * @type {AnnouncementLink} * @memberof AnnouncementPaginatedLinks */ 'next'?: AnnouncementLink; /** * * @type {AnnouncementLink} * @memberof AnnouncementPaginatedLinks */ 'prev'?: AnnouncementLink; /** * * @type {AnnouncementLink} * @memberof AnnouncementPaginatedLinks */ 'self': AnnouncementLink; } /** * * @export * @interface AnnouncementPatchOperation */ export interface AnnouncementPatchOperation { /** * The type of operation to perform * @type {string} * @memberof AnnouncementPatchOperation */ 'op': string; /** * A JSON Pointer string specifying the part of the document to operate on * @type {string} * @memberof AnnouncementPatchOperation */ 'path': string; /** * A JSON value used in \"add\", \"replace\", and \"test\" operations * @type {any} * @memberof AnnouncementPatchOperation */ 'value'?: any; } /** * Announcement response * @export * @interface AnnouncementResponse */ export interface AnnouncementResponse { /** * The ID of the announcement * @type {string} * @memberof AnnouncementResponse */ '_id': string; /** * true if the announcement is dismissible * @type {boolean} * @memberof AnnouncementResponse */ 'isDismissible': boolean; /** * The title of the announcement * @type {string} * @memberof AnnouncementResponse */ 'title': string; /** * The message of the announcement * @type {string} * @memberof AnnouncementResponse */ 'message': string; /** * The start time of the announcement. This is a Unix timestamp in milliseconds. * @type {number} * @memberof AnnouncementResponse */ 'startTime': number; /** * The end time of the announcement. This is a Unix timestamp in milliseconds. * @type {number} * @memberof AnnouncementResponse */ 'endTime'?: number; /** * The severity of the announcement * @type {string} * @memberof AnnouncementResponse */ 'severity': AnnouncementResponseSeverityEnum; /** * The status of the announcement * @type {string} * @memberof AnnouncementResponse */ '_status': AnnouncementResponseStatusEnum; /** * * @type {AnnouncementAccessRep} * @memberof AnnouncementResponse */ '_access'?: AnnouncementAccessRep; /** * * @type {AnnouncementResponseLinks} * @memberof AnnouncementResponse */ '_links': AnnouncementResponseLinks; } export declare const AnnouncementResponseSeverityEnum: { readonly Info: "info"; readonly Warning: "warning"; readonly Critical: "critical"; }; export type AnnouncementResponseSeverityEnum = typeof AnnouncementResponseSeverityEnum[keyof typeof AnnouncementResponseSeverityEnum]; export declare const AnnouncementResponseStatusEnum: { readonly Active: "active"; readonly Inactive: "inactive"; readonly Scheduled: "scheduled"; }; export type AnnouncementResponseStatusEnum = typeof AnnouncementResponseStatusEnum[keyof typeof AnnouncementResponseStatusEnum]; /** * * @export * @interface AnnouncementResponseLinks */ export interface AnnouncementResponseLinks { /** * * @type {AnnouncementLink} * @memberof AnnouncementResponseLinks */ 'parent': AnnouncementLink; } /** * * @export * @interface ApplicationCollectionRep */ export interface ApplicationCollectionRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ApplicationCollectionRep */ '_links'?: { [key: string]: Link; }; /** * A list of applications * @type {Array} * @memberof ApplicationCollectionRep */ 'items'?: Array; /** * The number of applications * @type {number} * @memberof ApplicationCollectionRep */ 'totalCount'?: number; } /** * * @export * @interface ApplicationFlagCollectionRep */ export interface ApplicationFlagCollectionRep { /** * A list of the flags that have been evaluated by the application * @type {Array} * @memberof ApplicationFlagCollectionRep */ 'items'?: Array; /** * The number of flags that have been evaluated by the application * @type {number} * @memberof ApplicationFlagCollectionRep */ 'totalCount'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ApplicationFlagCollectionRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface ApplicationRep */ export interface ApplicationRep { /** * * @type {ApplicationFlagCollectionRep} * @memberof ApplicationRep */ 'flags'?: ApplicationFlagCollectionRep; /** * * @type {Access} * @memberof ApplicationRep */ '_access'?: Access; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ApplicationRep */ '_links'?: { [key: string]: Link; }; /** * Version of the application * @type {number} * @memberof ApplicationRep */ '_version'?: number; /** * Whether the application was automatically created because it was included in a context when a LaunchDarkly SDK evaluated a feature flag, or was created through the LaunchDarkly UI or REST API. * @type {boolean} * @memberof ApplicationRep */ 'autoAdded': boolean; /** * * @type {number} * @memberof ApplicationRep */ 'creationDate'?: number; /** * The application description * @type {string} * @memberof ApplicationRep */ 'description'?: string; /** * The unique identifier of this application * @type {string} * @memberof ApplicationRep */ 'key': string; /** * To distinguish the kind of application * @type {string} * @memberof ApplicationRep */ 'kind': ApplicationRepKindEnum; /** * * @type {MaintainerRep} * @memberof ApplicationRep */ '_maintainer'?: MaintainerRep; /** * The name of the application * @type {string} * @memberof ApplicationRep */ 'name': string; } export declare const ApplicationRepKindEnum: { readonly Browser: "browser"; readonly Mobile: "mobile"; readonly Server: "server"; }; export type ApplicationRepKindEnum = typeof ApplicationRepKindEnum[keyof typeof ApplicationRepKindEnum]; /** * * @export * @interface ApplicationVersionRep */ export interface ApplicationVersionRep { /** * * @type {Access} * @memberof ApplicationVersionRep */ '_access'?: Access; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ApplicationVersionRep */ '_links'?: { [key: string]: Link; }; /** * Version of the application version * @type {number} * @memberof ApplicationVersionRep */ '_version'?: number; /** * Whether the application version was automatically created, because it was included in a context when a LaunchDarkly SDK evaluated a feature flag, or if the application version was created through the LaunchDarkly UI or REST API. * @type {boolean} * @memberof ApplicationVersionRep */ 'autoAdded': boolean; /** * * @type {number} * @memberof ApplicationVersionRep */ 'creationDate'?: number; /** * The unique identifier of this application version * @type {string} * @memberof ApplicationVersionRep */ 'key': string; /** * The name of this version * @type {string} * @memberof ApplicationVersionRep */ 'name': string; /** * Whether this version is supported. Only applicable if the application kind is mobile. * @type {boolean} * @memberof ApplicationVersionRep */ 'supported'?: boolean; } /** * * @export * @interface ApplicationVersionsCollectionRep */ export interface ApplicationVersionsCollectionRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ApplicationVersionsCollectionRep */ '_links'?: { [key: string]: Link; }; /** * A list of the versions for this application * @type {Array} * @memberof ApplicationVersionsCollectionRep */ 'items'?: Array; /** * The number of versions for this application * @type {number} * @memberof ApplicationVersionsCollectionRep */ 'totalCount'?: number; } /** * * @export * @interface ApprovalRequestResponse */ export interface ApprovalRequestResponse { /** * The ID of this approval request * @type {string} * @memberof ApprovalRequestResponse */ '_id': string; /** * Version of the approval request * @type {number} * @memberof ApprovalRequestResponse */ '_version': number; /** * * @type {number} * @memberof ApprovalRequestResponse */ 'creationDate': number; /** * * @type {string} * @memberof ApprovalRequestResponse */ 'serviceKind': string; /** * The ID of the member who requested the approval * @type {string} * @memberof ApprovalRequestResponse */ 'requestorId'?: string; /** * A human-friendly name for the approval request * @type {string} * @memberof ApprovalRequestResponse */ 'description'?: string; /** * Current status of the review of this approval request * @type {string} * @memberof ApprovalRequestResponse */ 'reviewStatus': ApprovalRequestResponseReviewStatusEnum; /** * An array of individual reviews of this approval request * @type {Array} * @memberof ApprovalRequestResponse */ 'allReviews': Array; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof ApprovalRequestResponse */ 'notifyMemberIds': Array; /** * * @type {number} * @memberof ApprovalRequestResponse */ 'appliedDate'?: number; /** * The member ID of the member who applied the approval request * @type {string} * @memberof ApprovalRequestResponse */ 'appliedByMemberId'?: string; /** * The service token ID of the service token which applied the approval request * @type {string} * @memberof ApprovalRequestResponse */ 'appliedByServiceTokenId'?: string; /** * Current status of the approval request * @type {string} * @memberof ApprovalRequestResponse */ 'status': ApprovalRequestResponseStatusEnum; /** * * @type {Array<{ [key: string]: any; }>} * @memberof ApprovalRequestResponse */ 'instructions': Array<{ [key: string]: any; }>; /** * Details on any conflicting approval requests * @type {Array} * @memberof ApprovalRequestResponse */ 'conflicts': Array; /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof ApprovalRequestResponse */ '_links': { [key: string]: any; }; /** * * @type {number} * @memberof ApprovalRequestResponse */ 'executionDate'?: number; /** * ID of scheduled change to edit or delete * @type {string} * @memberof ApprovalRequestResponse */ 'operatingOnId'?: string; /** * * @type {IntegrationMetadata} * @memberof ApprovalRequestResponse */ 'integrationMetadata'?: IntegrationMetadata; /** * * @type {CopiedFromEnv} * @memberof ApprovalRequestResponse */ 'source'?: CopiedFromEnv; /** * * @type {CustomWorkflowMeta} * @memberof ApprovalRequestResponse */ 'customWorkflowMetadata'?: CustomWorkflowMeta; /** * String representation of a resource * @type {string} * @memberof ApprovalRequestResponse */ 'resourceId'?: string; /** * * @type {ApprovalSettings} * @memberof ApprovalRequestResponse */ 'approvalSettings'?: ApprovalSettings; } export declare const ApprovalRequestResponseReviewStatusEnum: { readonly Approved: "approved"; readonly Declined: "declined"; readonly Pending: "pending"; }; export type ApprovalRequestResponseReviewStatusEnum = typeof ApprovalRequestResponseReviewStatusEnum[keyof typeof ApprovalRequestResponseReviewStatusEnum]; export declare const ApprovalRequestResponseStatusEnum: { readonly Pending: "pending"; readonly Completed: "completed"; readonly Failed: "failed"; readonly Scheduled: "scheduled"; }; export type ApprovalRequestResponseStatusEnum = typeof ApprovalRequestResponseStatusEnum[keyof typeof ApprovalRequestResponseStatusEnum]; /** * * @export * @interface ApprovalSettings */ export interface ApprovalSettings { /** * If approvals are required for this environment * @type {boolean} * @memberof ApprovalSettings */ 'required': boolean; /** * Whether to skip approvals for pending changes * @type {boolean} * @memberof ApprovalSettings */ 'bypassApprovalsForPendingChanges': boolean; /** * Sets the amount of approvals required before a member can apply a change. The minimum is one and the maximum is five. * @type {number} * @memberof ApprovalSettings */ 'minNumApprovals': number; /** * Allow someone who makes an approval request to apply their own change * @type {boolean} * @memberof ApprovalSettings */ 'canReviewOwnRequest': boolean; /** * Allow applying the change as long as at least one person has approved * @type {boolean} * @memberof ApprovalSettings */ 'canApplyDeclinedChanges': boolean; /** * Automatically apply changes that have been approved by all reviewers. This field is only applicable for approval services other than LaunchDarkly. * @type {boolean} * @memberof ApprovalSettings */ 'autoApplyApprovedChanges'?: boolean; /** * Which service to use for managing approvals * @type {string} * @memberof ApprovalSettings */ 'serviceKind': string; /** * * @type {{ [key: string]: any; }} * @memberof ApprovalSettings */ 'serviceConfig': { [key: string]: any; }; /** * Require approval only on flags with the provided tags. Otherwise all flags will require approval. * @type {Array} * @memberof ApprovalSettings */ 'requiredApprovalTags': Array; /** * Optional field for integration configuration ID of a custom approval integration. This is an Enterprise-only feature. * @type {string} * @memberof ApprovalSettings */ 'serviceKindConfigurationId'?: string; /** * The kind of resource for which the approval settings apply, for example, flag or segment * @type {string} * @memberof ApprovalSettings */ 'resourceKind'?: string; } /** * * @export * @interface ApprovalsCapabilityConfig */ export interface ApprovalsCapabilityConfig { /** * The additional form variables for the approvals capability * @type {Array} * @memberof ApprovalsCapabilityConfig */ 'additionalFormVariables'?: Array; } /** * * @export * @interface AssignedToRep */ export interface AssignedToRep { /** * The number of individual members this role is assigned to * @type {number} * @memberof AssignedToRep */ 'membersCount'?: number; /** * The number of teams this role is assigned to * @type {number} * @memberof AssignedToRep */ 'teamsCount'?: number; } /** * * @export * @interface Audience */ export interface Audience { /** * * @type {EnvironmentSummary} * @memberof Audience */ 'environment'?: EnvironmentSummary; /** * The release phase name * @type {string} * @memberof Audience */ 'name': string; /** * * @type {AudienceConfiguration} * @memberof Audience */ 'configuration'?: AudienceConfiguration; /** * A list of segment keys * @type {Array} * @memberof Audience */ 'segmentKeys'?: Array; } /** * * @export * @interface AudienceConfiguration */ export interface AudienceConfiguration { /** * * @type {string} * @memberof AudienceConfiguration */ 'releaseStrategy': string; /** * Whether or not the audience requires approval * @type {boolean} * @memberof AudienceConfiguration */ 'requireApproval': boolean; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof AudienceConfiguration */ 'notifyMemberIds'?: Array; /** * An array of team keys. The members of these teams are notified to review the approval request. * @type {Array} * @memberof AudienceConfiguration */ 'notifyTeamKeys'?: Array; /** * * @type {ReleaseGuardianConfiguration} * @memberof AudienceConfiguration */ 'releaseGuardianConfiguration'?: ReleaseGuardianConfiguration; } /** * * @export * @interface AudiencePost */ export interface AudiencePost { /** * A project-unique key for the environment. * @type {string} * @memberof AudiencePost */ 'environmentKey': string; /** * The audience name * @type {string} * @memberof AudiencePost */ 'name': string; /** * Segments targeted by this audience. * @type {Array} * @memberof AudiencePost */ 'segmentKeys'?: Array; /** * * @type {AudienceConfiguration} * @memberof AudiencePost */ 'configuration'?: AudienceConfiguration; } /** * * @export * @interface AuditLogEntryListingRep */ export interface AuditLogEntryListingRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof AuditLogEntryListingRep */ '_links': { [key: string]: Link; }; /** * The ID of the audit log entry * @type {string} * @memberof AuditLogEntryListingRep */ '_id': string; /** * The ID of the account to which this audit log entry belongs * @type {string} * @memberof AuditLogEntryListingRep */ '_accountId': string; /** * * @type {number} * @memberof AuditLogEntryListingRep */ 'date': number; /** * Details on the actions performed and resources acted on in this audit log entry * @type {Array} * @memberof AuditLogEntryListingRep */ 'accesses': Array; /** * * @type {string} * @memberof AuditLogEntryListingRep */ 'kind': string; /** * The name of the resource this audit log entry refers to * @type {string} * @memberof AuditLogEntryListingRep */ 'name': string; /** * Description of the change recorded in the audit log entry * @type {string} * @memberof AuditLogEntryListingRep */ 'description': string; /** * Shorter version of the change recorded in the audit log entry * @type {string} * @memberof AuditLogEntryListingRep */ 'shortDescription': string; /** * Optional comment for the audit log entry * @type {string} * @memberof AuditLogEntryListingRep */ 'comment'?: string; /** * * @type {SubjectDataRep} * @memberof AuditLogEntryListingRep */ 'subject'?: SubjectDataRep; /** * * @type {MemberDataRep} * @memberof AuditLogEntryListingRep */ 'member'?: MemberDataRep; /** * * @type {TokenSummary} * @memberof AuditLogEntryListingRep */ 'token'?: TokenSummary; /** * * @type {AuthorizedAppDataRep} * @memberof AuditLogEntryListingRep */ 'app'?: AuthorizedAppDataRep; /** * The action and resource recorded in this audit log entry * @type {string} * @memberof AuditLogEntryListingRep */ 'titleVerb'?: string; /** * A description of what occurred, in the format member titleVerb target * @type {string} * @memberof AuditLogEntryListingRep */ 'title'?: string; /** * * @type {TargetResourceRep} * @memberof AuditLogEntryListingRep */ 'target'?: TargetResourceRep; /** * * @type {ParentResourceRep} * @memberof AuditLogEntryListingRep */ 'parent'?: ParentResourceRep; } /** * * @export * @interface AuditLogEntryListingRepCollection */ export interface AuditLogEntryListingRepCollection { /** * An array of audit log entries * @type {Array} * @memberof AuditLogEntryListingRepCollection */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof AuditLogEntryListingRepCollection */ '_links': { [key: string]: Link; }; } /** * * @export * @interface AuditLogEntryRep */ export interface AuditLogEntryRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof AuditLogEntryRep */ '_links': { [key: string]: Link; }; /** * The ID of the audit log entry * @type {string} * @memberof AuditLogEntryRep */ '_id': string; /** * The ID of the account to which this audit log entry belongs * @type {string} * @memberof AuditLogEntryRep */ '_accountId': string; /** * * @type {number} * @memberof AuditLogEntryRep */ 'date': number; /** * Details on the actions performed and resources acted on in this audit log entry * @type {Array} * @memberof AuditLogEntryRep */ 'accesses': Array; /** * * @type {string} * @memberof AuditLogEntryRep */ 'kind': string; /** * The name of the resource this audit log entry refers to * @type {string} * @memberof AuditLogEntryRep */ 'name': string; /** * Description of the change recorded in the audit log entry * @type {string} * @memberof AuditLogEntryRep */ 'description': string; /** * Shorter version of the change recorded in the audit log entry * @type {string} * @memberof AuditLogEntryRep */ 'shortDescription': string; /** * Optional comment for the audit log entry * @type {string} * @memberof AuditLogEntryRep */ 'comment'?: string; /** * * @type {SubjectDataRep} * @memberof AuditLogEntryRep */ 'subject'?: SubjectDataRep; /** * * @type {MemberDataRep} * @memberof AuditLogEntryRep */ 'member'?: MemberDataRep; /** * * @type {TokenSummary} * @memberof AuditLogEntryRep */ 'token'?: TokenSummary; /** * * @type {AuthorizedAppDataRep} * @memberof AuditLogEntryRep */ 'app'?: AuthorizedAppDataRep; /** * The action and resource recorded in this audit log entry * @type {string} * @memberof AuditLogEntryRep */ 'titleVerb'?: string; /** * A description of what occurred, in the format member titleVerb target * @type {string} * @memberof AuditLogEntryRep */ 'title'?: string; /** * * @type {TargetResourceRep} * @memberof AuditLogEntryRep */ 'target'?: TargetResourceRep; /** * * @type {ParentResourceRep} * @memberof AuditLogEntryRep */ 'parent'?: ParentResourceRep; /** * If the audit log entry has been updated, this is the JSON patch body that was used in the request to update the entity * @type {any} * @memberof AuditLogEntryRep */ 'delta'?: any; /** * A JSON representation of the external trigger for this audit log entry, if any * @type {any} * @memberof AuditLogEntryRep */ 'triggerBody'?: any; /** * A JSON representation of the merge information for this audit log entry, if any * @type {any} * @memberof AuditLogEntryRep */ 'merge'?: any; /** * If the audit log entry has been updated, this is a JSON representation of the previous version of the entity * @type {any} * @memberof AuditLogEntryRep */ 'previousVersion'?: any; /** * If the audit log entry has been updated, this is a JSON representation of the current version of the entity * @type {any} * @memberof AuditLogEntryRep */ 'currentVersion'?: any; /** * * @type {Array} * @memberof AuditLogEntryRep */ 'subentries'?: Array; } /** * * @export * @interface AuditLogEventsHookCapabilityConfigPost */ export interface AuditLogEventsHookCapabilityConfigPost { /** * * @type {Array} * @memberof AuditLogEventsHookCapabilityConfigPost */ 'statements'?: Array; } /** * * @export * @interface AuditLogEventsHookCapabilityConfigRep */ export interface AuditLogEventsHookCapabilityConfigRep { /** * The set of resources you wish to subscribe to audit log notifications for. * @type {Array} * @memberof AuditLogEventsHookCapabilityConfigRep */ 'statements'?: Array; } /** * * @export * @interface AuthorizedAppDataRep */ export interface AuthorizedAppDataRep { /** * * @type {{ [key: string]: Link; }} * @memberof AuthorizedAppDataRep */ '_links'?: { [key: string]: Link; }; /** * The ID of the authorized application * @type {string} * @memberof AuthorizedAppDataRep */ '_id'?: string; /** * Whether the application is authorized through SCIM * @type {boolean} * @memberof AuthorizedAppDataRep */ 'isScim'?: boolean; /** * The authorized application name * @type {string} * @memberof AuthorizedAppDataRep */ 'name'?: string; /** * The name of the maintainer for this authorized application * @type {string} * @memberof AuthorizedAppDataRep */ 'maintainerName'?: string; } /** * * @export * @interface BayesianBetaBinomialStatsRep */ export interface BayesianBetaBinomialStatsRep { /** * Sum of converted pseudo-units for prior distribution * @type {number} * @memberof BayesianBetaBinomialStatsRep */ 'priorAlpha'?: number; /** * Sum of non-converted pseudo-units for prior distribution * @type {number} * @memberof BayesianBetaBinomialStatsRep */ 'priorBeta'?: number; /** * Mean of the prior distribution * @type {number} * @memberof BayesianBetaBinomialStatsRep */ 'priorMean'?: number; /** * The precision weight of the data mean * @type {number} * @memberof BayesianBetaBinomialStatsRep */ 'dataWeight'?: number; } /** * * @export * @interface BayesianNormalStatsRep */ export interface BayesianNormalStatsRep { /** * The precision weight of the data mean * @type {number} * @memberof BayesianNormalStatsRep */ 'dataWeight'?: number; /** * Mean of the prior distribution * @type {number} * @memberof BayesianNormalStatsRep */ 'priorMean'?: number; } /** * * @export * @interface BigSegmentStoreIntegration */ export interface BigSegmentStoreIntegration { /** * * @type {BigSegmentStoreIntegrationLinks} * @memberof BigSegmentStoreIntegration */ '_links': BigSegmentStoreIntegrationLinks; /** * The integration ID * @type {string} * @memberof BigSegmentStoreIntegration */ '_id': string; /** * The integration key * @type {string} * @memberof BigSegmentStoreIntegration */ 'integrationKey': BigSegmentStoreIntegrationIntegrationKeyEnum; /** * The project key * @type {string} * @memberof BigSegmentStoreIntegration */ 'projectKey': string; /** * The environment key * @type {string} * @memberof BigSegmentStoreIntegration */ 'environmentKey': string; /** * * @type {{ [key: string]: any; }} * @memberof BigSegmentStoreIntegration */ 'config': { [key: string]: any; }; /** * Whether the configuration is turned on * @type {boolean} * @memberof BigSegmentStoreIntegration */ 'on': boolean; /** * List of tags for this configuration * @type {Array} * @memberof BigSegmentStoreIntegration */ 'tags': Array; /** * Name of the configuration * @type {string} * @memberof BigSegmentStoreIntegration */ 'name': string; /** * Version of the current configuration * @type {number} * @memberof BigSegmentStoreIntegration */ 'version': number; /** * * @type {Access} * @memberof BigSegmentStoreIntegration */ '_access'?: Access; /** * * @type {BigSegmentStoreStatus} * @memberof BigSegmentStoreIntegration */ '_status': BigSegmentStoreStatus; } export declare const BigSegmentStoreIntegrationIntegrationKeyEnum: { readonly Redis: "redis"; readonly Dynamodb: "dynamodb"; }; export type BigSegmentStoreIntegrationIntegrationKeyEnum = typeof BigSegmentStoreIntegrationIntegrationKeyEnum[keyof typeof BigSegmentStoreIntegrationIntegrationKeyEnum]; /** * * @export * @interface BigSegmentStoreIntegrationCollection */ export interface BigSegmentStoreIntegrationCollection { /** * * @type {BigSegmentStoreIntegrationCollectionLinks} * @memberof BigSegmentStoreIntegrationCollection */ '_links': BigSegmentStoreIntegrationCollectionLinks; /** * An array of persistent store integration configurations * @type {Array} * @memberof BigSegmentStoreIntegrationCollection */ 'items': Array; } /** * * @export * @interface BigSegmentStoreIntegrationCollectionLinks */ export interface BigSegmentStoreIntegrationCollectionLinks { /** * * @type {Link} * @memberof BigSegmentStoreIntegrationCollectionLinks */ 'self': Link; /** * * @type {Link} * @memberof BigSegmentStoreIntegrationCollectionLinks */ 'parent'?: Link; } /** * * @export * @interface BigSegmentStoreIntegrationLinks */ export interface BigSegmentStoreIntegrationLinks { /** * * @type {Link} * @memberof BigSegmentStoreIntegrationLinks */ 'self': Link; /** * * @type {Link} * @memberof BigSegmentStoreIntegrationLinks */ 'parent': Link; /** * * @type {Link} * @memberof BigSegmentStoreIntegrationLinks */ 'project': Link; /** * * @type {Link} * @memberof BigSegmentStoreIntegrationLinks */ 'environment': Link; } /** * * @export * @interface BigSegmentStoreStatus */ export interface BigSegmentStoreStatus { /** * Whether the persistent store integration is fully synchronized with the LaunchDarkly environment, and the lastSync occurred within a few minutes * @type {boolean} * @memberof BigSegmentStoreStatus */ 'available'?: boolean; /** * Whether the persistent store integration may not be fully synchronized with the LaunchDarkly environment. true if the integration could be stale. * @type {boolean} * @memberof BigSegmentStoreStatus */ 'potentiallyStale'?: boolean; /** * * @type {number} * @memberof BigSegmentStoreStatus */ 'lastSync'?: number; /** * * @type {number} * @memberof BigSegmentStoreStatus */ 'lastError'?: number; /** * * @type {Array} * @memberof BigSegmentStoreStatus */ 'errors'?: Array; } /** * * @export * @interface BigSegmentTarget */ export interface BigSegmentTarget { /** * The target key * @type {string} * @memberof BigSegmentTarget */ 'userKey': string; /** * Indicates whether the target is included.
Included targets are always segment members, regardless of segment rules. * @type {boolean} * @memberof BigSegmentTarget */ 'included': boolean; /** * Indicates whether the target is excluded.
Segment rules bypass excluded targets, so they will never be included based on rules. Excluded targets may still be included explicitly. * @type {boolean} * @memberof BigSegmentTarget */ 'excluded': boolean; } /** * * @export * @interface BooleanDefaults */ export interface BooleanDefaults { /** * The display name for the true variation, displayed in the LaunchDarkly user interface * @type {string} * @memberof BooleanDefaults */ 'trueDisplayName'?: string; /** * The display name for the false variation, displayed in the LaunchDarkly user interface * @type {string} * @memberof BooleanDefaults */ 'falseDisplayName'?: string; /** * The description for the true variation * @type {string} * @memberof BooleanDefaults */ 'trueDescription'?: string; /** * The description for the false variation * @type {string} * @memberof BooleanDefaults */ 'falseDescription'?: string; /** * The variation index of the flag variation to use for the default targeting behavior when a flag\'s targeting is on and the target did not match any rules * @type {number} * @memberof BooleanDefaults */ 'onVariation'?: number; /** * The variation index of the flag variation to use for the default targeting behavior when a flag\'s targeting is off * @type {number} * @memberof BooleanDefaults */ 'offVariation'?: number; } /** * * @export * @interface BooleanFlagDefaults */ export interface BooleanFlagDefaults { /** * The display name for the true variation, displayed in the LaunchDarkly user interface * @type {string} * @memberof BooleanFlagDefaults */ 'trueDisplayName': string; /** * The display name for the false variation, displayed in the LaunchDarkly user interface * @type {string} * @memberof BooleanFlagDefaults */ 'falseDisplayName': string; /** * The description for the true variation * @type {string} * @memberof BooleanFlagDefaults */ 'trueDescription': string; /** * The description for the false variation * @type {string} * @memberof BooleanFlagDefaults */ 'falseDescription': string; /** * The variation index of the flag variation to use for the default targeting behavior when a flag\'s targeting is on and the target did not match any rules * @type {number} * @memberof BooleanFlagDefaults */ 'onVariation': number; /** * The variation index of the flag variation to use for the default targeting behavior when a flag\'s targeting is off * @type {number} * @memberof BooleanFlagDefaults */ 'offVariation': number; } /** * * @export * @interface BranchCollectionRep */ export interface BranchCollectionRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof BranchCollectionRep */ '_links': { [key: string]: Link; }; /** * An array of branches * @type {Array} * @memberof BranchCollectionRep */ 'items': Array; } /** * * @export * @interface BranchRep */ export interface BranchRep { /** * The branch name * @type {string} * @memberof BranchRep */ 'name': string; /** * An ID representing the branch HEAD. For example, a commit SHA. * @type {string} * @memberof BranchRep */ 'head': string; /** * An optional ID used to prevent older data from overwriting newer data * @type {number} * @memberof BranchRep */ 'updateSequenceId'?: number; /** * * @type {number} * @memberof BranchRep */ 'syncTime': number; /** * An array of flag references found on the branch * @type {Array} * @memberof BranchRep */ 'references'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof BranchRep */ '_links': { [key: string]: any; }; } /** * * @export * @interface BulkEditMembersRep */ export interface BulkEditMembersRep { /** * A list of members IDs of the members who were successfully updated. * @type {Array} * @memberof BulkEditMembersRep */ 'members'?: Array; /** * A list of member IDs and errors for the members whose updates failed. * @type {Array<{ [key: string]: string; }>} * @memberof BulkEditMembersRep */ 'errors'?: Array<{ [key: string]: string; }>; } /** * * @export * @interface BulkEditTeamsRep */ export interface BulkEditTeamsRep { /** * A list of member IDs of the members who were added to the teams. * @type {Array} * @memberof BulkEditTeamsRep */ 'memberIDs'?: Array; /** * A list of team keys of the teams that were successfully updated. * @type {Array} * @memberof BulkEditTeamsRep */ 'teamKeys'?: Array; /** * A list of team keys and errors for the teams whose updates failed. * @type {Array<{ [key: string]: string; }>} * @memberof BulkEditTeamsRep */ 'errors'?: Array<{ [key: string]: string; }>; } /** * * @export * @interface CallerIdentityRep */ export interface CallerIdentityRep { /** * * @type {string} * @memberof CallerIdentityRep */ 'accountId'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'environmentId'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'projectId'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'environmentName'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'projectName'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'authKind'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'tokenKind'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'clientId'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'tokenName'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'tokenId'?: string; /** * * @type {string} * @memberof CallerIdentityRep */ 'memberId'?: string; /** * * @type {boolean} * @memberof CallerIdentityRep */ 'serviceToken'?: boolean; } /** * * @export * @interface CapabilityConfigPost */ export interface CapabilityConfigPost { /** * * @type {ApprovalsCapabilityConfig} * @memberof CapabilityConfigPost */ 'approvals'?: ApprovalsCapabilityConfig; /** * * @type {AuditLogEventsHookCapabilityConfigPost} * @memberof CapabilityConfigPost */ 'auditLogEventsHook'?: AuditLogEventsHookCapabilityConfigPost; } /** * * @export * @interface CapabilityConfigRep */ export interface CapabilityConfigRep { /** * * @type {ApprovalsCapabilityConfig} * @memberof CapabilityConfigRep */ 'approvals'?: ApprovalsCapabilityConfig; /** * * @type {AuditLogEventsHookCapabilityConfigRep} * @memberof CapabilityConfigRep */ 'auditLogEventsHook'?: AuditLogEventsHookCapabilityConfigRep; } /** * * @export * @interface Clause */ export interface Clause { /** * * @type {string} * @memberof Clause */ '_id'?: string; /** * * @type {string} * @memberof Clause */ 'attribute': string; /** * * @type {string} * @memberof Clause */ 'op': string; /** * * @type {Array} * @memberof Clause */ 'values': Array; /** * * @type {string} * @memberof Clause */ 'contextKind'?: string; /** * * @type {boolean} * @memberof Clause */ 'negate': boolean; } /** * * @export * @interface Client */ export interface Client { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Client */ '_links': { [key: string]: Link; }; /** * Client name * @type {string} * @memberof Client */ 'name': string; /** * Client description * @type {string} * @memberof Client */ 'description'?: string; /** * The account ID the client is registered under * @type {string} * @memberof Client */ '_accountId': string; /** * The client\'s unique ID * @type {string} * @memberof Client */ '_clientId': string; /** * The client secret. This will only be shown upon creation. * @type {string} * @memberof Client */ '_clientSecret'?: string; /** * The client\'s redirect URI * @type {string} * @memberof Client */ 'redirectUri': string; /** * * @type {number} * @memberof Client */ '_creationDate': number; } /** * * @export * @interface ClientCollection */ export interface ClientCollection { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ClientCollection */ '_links': { [key: string]: Link; }; /** * List of client objects * @type {Array} * @memberof ClientCollection */ 'items': Array; } /** * * @export * @interface ClientSideAvailability */ export interface ClientSideAvailability { /** * * @type {boolean} * @memberof ClientSideAvailability */ 'usingMobileKey'?: boolean; /** * * @type {boolean} * @memberof ClientSideAvailability */ 'usingEnvironmentId'?: boolean; } /** * * @export * @interface ClientSideAvailabilityPost */ export interface ClientSideAvailabilityPost { /** * Whether to enable availability for client-side SDKs. Defaults to false. * @type {boolean} * @memberof ClientSideAvailabilityPost */ 'usingEnvironmentId': boolean; /** * Whether to enable availability for mobile SDKs. Defaults to true. * @type {boolean} * @memberof ClientSideAvailabilityPost */ 'usingMobileKey': boolean; } /** * * @export * @interface CompletedBy */ export interface CompletedBy { /** * * @type {MemberSummary} * @memberof CompletedBy */ 'member'?: MemberSummary; /** * * @type {TokenSummary} * @memberof CompletedBy */ 'token'?: TokenSummary; } /** * * @export * @interface ConditionInput */ export interface ConditionInput { /** * * @type {string} * @memberof ConditionInput */ 'scheduleKind'?: string; /** * * @type {number} * @memberof ConditionInput */ 'executionDate'?: number; /** * For workflow stages whose scheduled execution is relative, how far in the future the stage should start. * @type {number} * @memberof ConditionInput */ 'waitDuration'?: number; /** * * @type {string} * @memberof ConditionInput */ 'waitDurationUnit'?: string; /** * Whether the workflow stage should be executed immediately * @type {boolean} * @memberof ConditionInput */ 'executeNow'?: boolean; /** * A description of the approval required for this stage * @type {string} * @memberof ConditionInput */ 'description'?: string; /** * A list of member IDs for the members to request approval from for this stage * @type {Array} * @memberof ConditionInput */ 'notifyMemberIds'?: Array; /** * A list of team keys for the teams to request approval from for this stage * @type {Array} * @memberof ConditionInput */ 'notifyTeamKeys'?: Array; /** * * @type {string} * @memberof ConditionInput */ 'kind'?: string; } /** * * @export * @interface ConditionOutput */ export interface ConditionOutput { /** * * @type {string} * @memberof ConditionOutput */ '_id': string; /** * * @type {string} * @memberof ConditionOutput */ 'kind'?: string; /** * * @type {ExecutionOutput} * @memberof ConditionOutput */ '_execution': ExecutionOutput; /** * * @type {string} * @memberof ConditionOutput */ 'scheduleKind'?: string; /** * * @type {number} * @memberof ConditionOutput */ 'executionDate'?: number; /** * * @type {number} * @memberof ConditionOutput */ 'waitDuration'?: number; /** * * @type {string} * @memberof ConditionOutput */ 'waitDurationUnit'?: string; /** * * @type {string} * @memberof ConditionOutput */ 'description': string; /** * * @type {Array} * @memberof ConditionOutput */ 'notifyMemberIds': Array; /** * * @type {Array} * @memberof ConditionOutput */ 'allReviews': Array; /** * * @type {string} * @memberof ConditionOutput */ 'reviewStatus': string; /** * * @type {number} * @memberof ConditionOutput */ 'appliedDate'?: number; } /** * * @export * @interface Conflict */ export interface Conflict { /** * * @type {{ [key: string]: any; }} * @memberof Conflict */ 'instruction'?: { [key: string]: any; }; /** * Reason why the conflict exists * @type {string} * @memberof Conflict */ 'reason'?: string; } /** * * @export * @interface ConflictOutput */ export interface ConflictOutput { /** * The stage ID * @type {string} * @memberof ConflictOutput */ 'stageId': string; /** * Message about the conflict * @type {string} * @memberof ConflictOutput */ 'message': string; } /** * * @export * @interface ContextAttributeName */ export interface ContextAttributeName { /** * A context attribute\'s name. * @type {string} * @memberof ContextAttributeName */ 'name': string; /** * A relative estimate of the number of contexts seen recently that have an attribute with the associated name. * @type {number} * @memberof ContextAttributeName */ 'weight': number; /** * Whether or not the attribute has one or more redacted values. * @type {boolean} * @memberof ContextAttributeName */ 'redacted'?: boolean; } /** * * @export * @interface ContextAttributeNames */ export interface ContextAttributeNames { /** * The kind associated with this collection of context attribute names. * @type {string} * @memberof ContextAttributeNames */ 'kind': string; /** * A collection of context attribute names. * @type {Array} * @memberof ContextAttributeNames */ 'names': Array; } /** * * @export * @interface ContextAttributeNamesCollection */ export interface ContextAttributeNamesCollection { /** * A collection of context attribute name data grouped by kind. * @type {Array} * @memberof ContextAttributeNamesCollection */ 'items': Array; } /** * * @export * @interface ContextAttributeValue */ export interface ContextAttributeValue { /** * A value for a context attribute. * @type {any} * @memberof ContextAttributeValue */ 'name': any; /** * A relative estimate of the number of contexts seen recently that have a matching value for a given attribute. * @type {number} * @memberof ContextAttributeValue */ 'weight': number; } /** * * @export * @interface ContextAttributeValues */ export interface ContextAttributeValues { /** * The kind associated with this collection of context attribute values. * @type {string} * @memberof ContextAttributeValues */ 'kind': string; /** * A collection of context attribute values. * @type {Array} * @memberof ContextAttributeValues */ 'values': Array; } /** * * @export * @interface ContextAttributeValuesCollection */ export interface ContextAttributeValuesCollection { /** * A collection of context attribute value data grouped by kind. * @type {Array} * @memberof ContextAttributeValuesCollection */ 'items': Array; } /** * * @export * @interface ContextInstanceEvaluation */ export interface ContextInstanceEvaluation { /** * Name of the flag. * @type {string} * @memberof ContextInstanceEvaluation */ 'name': string; /** * Key of the flag. * @type {string} * @memberof ContextInstanceEvaluation */ 'key': string; /** * The value of the flag variation that the context receives. If there is no defined default rule, this is null. * @type {any} * @memberof ContextInstanceEvaluation */ '_value': any; /** * * @type {ContextInstanceEvaluationReason} * @memberof ContextInstanceEvaluation */ 'reason'?: ContextInstanceEvaluationReason; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextInstanceEvaluation */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ContextInstanceEvaluationReason */ export interface ContextInstanceEvaluationReason { /** * Describes the general reason that LaunchDarkly selected this variation. * @type {string} * @memberof ContextInstanceEvaluationReason */ 'kind': string; /** * The positional index of the matching rule if the kind is \'RULE_MATCH\'. The index is 0-based. * @type {number} * @memberof ContextInstanceEvaluationReason */ 'ruleIndex'?: number; /** * The unique identifier of the matching rule if the kind is \'RULE_MATCH\'. * @type {string} * @memberof ContextInstanceEvaluationReason */ 'ruleID'?: string; /** * The key of the flag that failed if the kind is \'PREREQUISITE_FAILED\'. * @type {string} * @memberof ContextInstanceEvaluationReason */ 'prerequisiteKey'?: string; /** * Indicates whether the context was evaluated as part of an experiment. * @type {boolean} * @memberof ContextInstanceEvaluationReason */ 'inExperiment'?: boolean; /** * The specific error type if the kind is \'ERROR\'. * @type {string} * @memberof ContextInstanceEvaluationReason */ 'errorKind'?: string; } /** * * @export * @interface ContextInstanceEvaluations */ export interface ContextInstanceEvaluations { /** * Details on the flag evaluations for this context instance * @type {Array} * @memberof ContextInstanceEvaluations */ 'items': Array; /** * The number of flags * @type {number} * @memberof ContextInstanceEvaluations */ 'totalCount'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextInstanceEvaluations */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ContextInstanceRecord */ export interface ContextInstanceRecord { /** * Timestamp of the last time an evaluation occurred for this context instance * @type {string} * @memberof ContextInstanceRecord */ 'lastSeen'?: string; /** * The context instance ID * @type {string} * @memberof ContextInstanceRecord */ 'id': string; /** * An identifier representing the application where the LaunchDarkly SDK is running * @type {string} * @memberof ContextInstanceRecord */ 'applicationId'?: string; /** * A list of the context kinds this context was associated with that the SDK removed because they were marked as anonymous at flag evaluation * @type {Array} * @memberof ContextInstanceRecord */ 'anonymousKinds'?: Array; /** * The context, including its kind and attributes * @type {any} * @memberof ContextInstanceRecord */ 'context': any; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextInstanceRecord */ '_links'?: { [key: string]: Link; }; /** * * @type {Access} * @memberof ContextInstanceRecord */ '_access'?: Access; } /** * * @export * @interface ContextInstanceSearch */ export interface ContextInstanceSearch { /** * A collection of context instance filters * @type {string} * @memberof ContextInstanceSearch */ 'filter'?: string; /** * Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts. * @type {string} * @memberof ContextInstanceSearch */ 'sort'?: string; /** * Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @type {number} * @memberof ContextInstanceSearch */ 'limit'?: number; /** * Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the next link instead, because this value is an obfuscated string. * @type {string} * @memberof ContextInstanceSearch */ 'continuationToken'?: string; } /** * * @export * @interface ContextInstanceSegmentMembership */ export interface ContextInstanceSegmentMembership { /** * A human-friendly name for the segment * @type {string} * @memberof ContextInstanceSegmentMembership */ 'name': string; /** * A unique key used to reference the segment * @type {string} * @memberof ContextInstanceSegmentMembership */ 'key': string; /** * A description of the segment\'s purpose * @type {string} * @memberof ContextInstanceSegmentMembership */ 'description': string; /** * Whether this is an unbounded segment. Unbounded segments, also called big segments, may be list-based segments with more than 15,000 entries, or synced segments. * @type {boolean} * @memberof ContextInstanceSegmentMembership */ 'unbounded': boolean; /** * If the segment is a synced segment, the name of the external source * @type {string} * @memberof ContextInstanceSegmentMembership */ 'external': string; /** * Whether the context is a member of this segment, either by explicit inclusion or by rule matching * @type {boolean} * @memberof ContextInstanceSegmentMembership */ 'isMember': boolean; /** * Whether the context is explicitly included in this segment * @type {boolean} * @memberof ContextInstanceSegmentMembership */ 'isIndividuallyTargeted': boolean; /** * Whether the context is captured by this segment\'s rules. The value of this field is undefined if the context is also explicitly included (isIndividuallyTargeted is true). * @type {boolean} * @memberof ContextInstanceSegmentMembership */ 'isRuleTargeted': boolean; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextInstanceSegmentMembership */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ContextInstanceSegmentMemberships */ export interface ContextInstanceSegmentMemberships { /** * * @type {Array} * @memberof ContextInstanceSegmentMemberships */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextInstanceSegmentMemberships */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ContextInstances */ export interface ContextInstances { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextInstances */ '_links'?: { [key: string]: Link; }; /** * The number of unique context instances * @type {number} * @memberof ContextInstances */ 'totalCount'?: number; /** * The environment ID * @type {string} * @memberof ContextInstances */ '_environmentId': string; /** * An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the next link instead. * @type {string} * @memberof ContextInstances */ 'continuationToken'?: string; /** * A collection of context instances. Can include multiple versions of context instances that have the same id, but different applicationIds. * @type {Array} * @memberof ContextInstances */ 'items': Array; } /** * * @export * @interface ContextKindRep */ export interface ContextKindRep { /** * The context kind key * @type {string} * @memberof ContextKindRep */ 'key': string; /** * The context kind name * @type {string} * @memberof ContextKindRep */ 'name': string; /** * The context kind description * @type {string} * @memberof ContextKindRep */ 'description': string; /** * The context kind version * @type {number} * @memberof ContextKindRep */ 'version': number; /** * * @type {number} * @memberof ContextKindRep */ 'creationDate': number; /** * * @type {number} * @memberof ContextKindRep */ 'lastModified': number; /** * * @type {number} * @memberof ContextKindRep */ 'lastSeen'?: number; /** * * @type {string} * @memberof ContextKindRep */ 'createdFrom': string; /** * Alias for archived. * @type {boolean} * @memberof ContextKindRep */ 'hideInTargeting'?: boolean; /** * Whether the context kind is archived. Archived context kinds are unavailable for targeting. * @type {boolean} * @memberof ContextKindRep */ 'archived'?: boolean; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextKindRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface ContextKindsCollectionRep */ export interface ContextKindsCollectionRep { /** * An array of context kinds * @type {Array} * @memberof ContextKindsCollectionRep */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextKindsCollectionRep */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ContextRecord */ export interface ContextRecord { /** * Timestamp of the last time an evaluation occurred for this context * @type {string} * @memberof ContextRecord */ 'lastSeen'?: string; /** * An identifier representing the application where the LaunchDarkly SDK is running * @type {string} * @memberof ContextRecord */ 'applicationId'?: string; /** * The context, including its kind and attributes * @type {any} * @memberof ContextRecord */ 'context': any; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ContextRecord */ '_links'?: { [key: string]: Link; }; /** * * @type {Access} * @memberof ContextRecord */ '_access'?: Access; /** * The total number of associated contexts. Associated contexts are contexts that have appeared in the same context instance, that is, they were part of the same flag evaluation. * @type {number} * @memberof ContextRecord */ 'associatedContexts'?: number; } /** * * @export * @interface ContextSearch */ export interface ContextSearch { /** * A collection of context filters * @type {string} * @memberof ContextSearch */ 'filter'?: string; /** * Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts. * @type {string} * @memberof ContextSearch */ 'sort'?: string; /** * Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @type {number} * @memberof ContextSearch */ 'limit'?: number; /** * Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the next link instead, because this value is an obfuscated string. * @type {string} * @memberof ContextSearch */ 'continuationToken'?: string; } /** * * @export * @interface Contexts */ export interface Contexts { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Contexts */ '_links'?: { [key: string]: Link; }; /** * The number of contexts * @type {number} * @memberof Contexts */ 'totalCount'?: number; /** * The environment ID where the context was evaluated * @type {string} * @memberof Contexts */ '_environmentId': string; /** * An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the next link instead. * @type {string} * @memberof Contexts */ 'continuationToken'?: string; /** * A collection of contexts. Can include multiple versions of contexts that have the same kind and key, but different applicationIds. * @type {Array} * @memberof Contexts */ 'items': Array; } /** * * @export * @interface CopiedFromEnv */ export interface CopiedFromEnv { /** * Key of feature flag copied * @type {string} * @memberof CopiedFromEnv */ 'key': string; /** * Version of feature flag copied * @type {number} * @memberof CopiedFromEnv */ 'version'?: number; } /** * * @export * @interface CoreLink */ export interface CoreLink { /** * * @type {string} * @memberof CoreLink */ 'href': string; /** * * @type {string} * @memberof CoreLink */ 'type': string; } /** * Create announcement request body * @export * @interface CreateAnnouncementBody */ export interface CreateAnnouncementBody { /** * true if the announcement is dismissible * @type {boolean} * @memberof CreateAnnouncementBody */ 'isDismissible': boolean; /** * The title of the announcement * @type {string} * @memberof CreateAnnouncementBody */ 'title': string; /** * The message of the announcement * @type {string} * @memberof CreateAnnouncementBody */ 'message': string; /** * The start time of the announcement. This is a Unix timestamp in milliseconds. * @type {number} * @memberof CreateAnnouncementBody */ 'startTime': number; /** * The end time of the announcement. This is a Unix timestamp in milliseconds. * @type {number} * @memberof CreateAnnouncementBody */ 'endTime'?: number; /** * The severity of the announcement * @type {string} * @memberof CreateAnnouncementBody */ 'severity': CreateAnnouncementBodySeverityEnum; } export declare const CreateAnnouncementBodySeverityEnum: { readonly Info: "info"; readonly Warning: "warning"; readonly Critical: "critical"; }; export type CreateAnnouncementBodySeverityEnum = typeof CreateAnnouncementBodySeverityEnum[keyof typeof CreateAnnouncementBodySeverityEnum]; /** * * @export * @interface CreateApprovalRequestRequest */ export interface CreateApprovalRequestRequest { /** * String representation of the resource specifier * @type {string} * @memberof CreateApprovalRequestRequest */ 'resourceId': string; /** * Optional comment describing the approval request * @type {string} * @memberof CreateApprovalRequestRequest */ 'comment'?: string; /** * A brief description of the changes you\'re requesting * @type {string} * @memberof CreateApprovalRequestRequest */ 'description': string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof CreateApprovalRequestRequest */ 'instructions': Array<{ [key: string]: any; }>; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof CreateApprovalRequestRequest */ 'notifyMemberIds'?: Array; /** * An array of team keys. The members of these teams are notified to review the approval request. * @type {Array} * @memberof CreateApprovalRequestRequest */ 'notifyTeamKeys'?: Array; /** * * @type {{ [key: string]: any; }} * @memberof CreateApprovalRequestRequest */ 'integrationConfig'?: { [key: string]: any; }; } /** * * @export * @interface CreateCopyFlagConfigApprovalRequestRequest */ export interface CreateCopyFlagConfigApprovalRequestRequest { /** * Optional comment describing the approval request * @type {string} * @memberof CreateCopyFlagConfigApprovalRequestRequest */ 'comment'?: string; /** * A brief description of your changes * @type {string} * @memberof CreateCopyFlagConfigApprovalRequestRequest */ 'description': string; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof CreateCopyFlagConfigApprovalRequestRequest */ 'notifyMemberIds'?: Array; /** * An array of team keys. The members of these teams are notified to review the approval request. * @type {Array} * @memberof CreateCopyFlagConfigApprovalRequestRequest */ 'notifyTeamKeys'?: Array; /** * * @type {SourceFlag} * @memberof CreateCopyFlagConfigApprovalRequestRequest */ 'source': SourceFlag; /** * Optional list of the flag changes to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If neither are included, then all flag changes will be copied. * @type {Array} * @memberof CreateCopyFlagConfigApprovalRequestRequest */ 'includedActions'?: Array; /** * Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If neither are included, then all flag changes will be copied. * @type {Array} * @memberof CreateCopyFlagConfigApprovalRequestRequest */ 'excludedActions'?: Array; } export declare const CreateCopyFlagConfigApprovalRequestRequestIncludedActionsEnum: { readonly UpdateOn: "updateOn"; readonly UpdateFallthrough: "updateFallthrough"; readonly UpdateOffVariation: "updateOffVariation"; readonly UpdateRules: "updateRules"; readonly UpdateTargets: "updateTargets"; readonly UpdatePrerequisites: "updatePrerequisites"; }; export type CreateCopyFlagConfigApprovalRequestRequestIncludedActionsEnum = typeof CreateCopyFlagConfigApprovalRequestRequestIncludedActionsEnum[keyof typeof CreateCopyFlagConfigApprovalRequestRequestIncludedActionsEnum]; export declare const CreateCopyFlagConfigApprovalRequestRequestExcludedActionsEnum: { readonly UpdateOn: "updateOn"; readonly UpdateFallthrough: "updateFallthrough"; readonly UpdateOffVariation: "updateOffVariation"; readonly UpdateRules: "updateRules"; readonly UpdateTargets: "updateTargets"; readonly UpdatePrerequisites: "updatePrerequisites"; }; export type CreateCopyFlagConfigApprovalRequestRequestExcludedActionsEnum = typeof CreateCopyFlagConfigApprovalRequestRequestExcludedActionsEnum[keyof typeof CreateCopyFlagConfigApprovalRequestRequestExcludedActionsEnum]; /** * * @export * @interface CreateFlagConfigApprovalRequestRequest */ export interface CreateFlagConfigApprovalRequestRequest { /** * Optional comment describing the approval request * @type {string} * @memberof CreateFlagConfigApprovalRequestRequest */ 'comment'?: string; /** * A brief description of the changes you\'re requesting * @type {string} * @memberof CreateFlagConfigApprovalRequestRequest */ 'description': string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof CreateFlagConfigApprovalRequestRequest */ 'instructions': Array<{ [key: string]: any; }>; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof CreateFlagConfigApprovalRequestRequest */ 'notifyMemberIds'?: Array; /** * An array of team keys. The members of these teams are notified to review the approval request. * @type {Array} * @memberof CreateFlagConfigApprovalRequestRequest */ 'notifyTeamKeys'?: Array; /** * * @type {number} * @memberof CreateFlagConfigApprovalRequestRequest */ 'executionDate'?: number; /** * The ID of a scheduled change. Include this if your instructions include editing or deleting a scheduled change. * @type {string} * @memberof CreateFlagConfigApprovalRequestRequest */ 'operatingOnId'?: string; /** * * @type {{ [key: string]: any; }} * @memberof CreateFlagConfigApprovalRequestRequest */ 'integrationConfig'?: { [key: string]: any; }; } /** * * @export * @interface CreatePhaseInput */ export interface CreatePhaseInput { /** * An ordered list of the audiences for this release phase. Each audience corresponds to a LaunchDarkly environment. * @type {Array} * @memberof CreatePhaseInput */ 'audiences': Array; /** * The release phase name * @type {string} * @memberof CreatePhaseInput */ 'name': string; /** * * @type {object} * @memberof CreatePhaseInput */ 'configuration'?: object; } /** * * @export * @interface CreateReleaseInput */ export interface CreateReleaseInput { /** * The variation id to release to across all phases * @type {string} * @memberof CreateReleaseInput */ 'releaseVariationId'?: string; /** * The key of the release pipeline to attach the flag to * @type {string} * @memberof CreateReleaseInput */ 'releasePipelineKey': string; } /** * * @export * @interface CreateReleasePipelineInput */ export interface CreateReleasePipelineInput { /** * The release pipeline description * @type {string} * @memberof CreateReleasePipelineInput */ 'description'?: string; /** * The unique identifier of this release pipeline * @type {string} * @memberof CreateReleasePipelineInput */ 'key': string; /** * The name of the release pipeline * @type {string} * @memberof CreateReleasePipelineInput */ 'name': string; /** * A logical grouping of one or more environments that share attributes for rolling out changes * @type {Array} * @memberof CreateReleasePipelineInput */ 'phases': Array; /** * A list of tags for this release pipeline * @type {Array} * @memberof CreateReleasePipelineInput */ 'tags'?: Array; /** * Whether or not the newly created pipeline should be set as the default pipeline for this project * @type {boolean} * @memberof CreateReleasePipelineInput */ 'isProjectDefault'?: boolean; /** * Whether or not the pipeline is enabled for Release Automation. * @type {boolean} * @memberof CreateReleasePipelineInput */ 'isLegacy'?: boolean; } /** * * @export * @interface CreateWorkflowTemplateInput */ export interface CreateWorkflowTemplateInput { /** * * @type {string} * @memberof CreateWorkflowTemplateInput */ 'key': string; /** * * @type {string} * @memberof CreateWorkflowTemplateInput */ 'name'?: string; /** * * @type {string} * @memberof CreateWorkflowTemplateInput */ 'description'?: string; /** * * @type {string} * @memberof CreateWorkflowTemplateInput */ 'workflowId'?: string; /** * * @type {Array} * @memberof CreateWorkflowTemplateInput */ 'stages'?: Array; /** * * @type {string} * @memberof CreateWorkflowTemplateInput */ 'projectKey'?: string; /** * * @type {string} * @memberof CreateWorkflowTemplateInput */ 'environmentKey'?: string; /** * * @type {string} * @memberof CreateWorkflowTemplateInput */ 'flagKey'?: string; } /** * * @export * @interface CredibleIntervalRep */ export interface CredibleIntervalRep { /** * The upper bound * @type {number} * @memberof CredibleIntervalRep */ 'upper'?: number; /** * The lower bound * @type {number} * @memberof CredibleIntervalRep */ 'lower'?: number; } /** * * @export * @interface CustomProperty */ export interface CustomProperty { /** * The name of the custom property of this type. * @type {string} * @memberof CustomProperty */ 'name': string; /** * An array of values for the custom property data to associate with this flag. * @type {Array} * @memberof CustomProperty */ 'value': Array; } /** * * @export * @interface CustomRole */ export interface CustomRole { /** * The ID of the custom role * @type {string} * @memberof CustomRole */ '_id': string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof CustomRole */ '_links': { [key: string]: Link; }; /** * * @type {Access} * @memberof CustomRole */ '_access'?: Access; /** * The description of the custom role * @type {string} * @memberof CustomRole */ 'description'?: string; /** * The key of the custom role * @type {string} * @memberof CustomRole */ 'key': string; /** * The name of the custom role * @type {string} * @memberof CustomRole */ 'name': string; /** * An array of the policies that comprise this custom role * @type {Array} * @memberof CustomRole */ 'policy': Array; /** * * @type {string} * @memberof CustomRole */ 'basePermissions'?: string; /** * * @type {string} * @memberof CustomRole */ 'resourceCategory'?: string; /** * * @type {AssignedToRep} * @memberof CustomRole */ 'assignedTo'?: AssignedToRep; /** * If created from a preset, the preset bundle version * @type {number} * @memberof CustomRole */ '_presetBundleVersion'?: number; /** * If created from a preset, the read-only statements copied from the preset * @type {Array} * @memberof CustomRole */ '_presetStatements'?: Array; } /** * * @export * @interface CustomRolePost */ export interface CustomRolePost { /** * A human-friendly name for the custom role * @type {string} * @memberof CustomRolePost */ 'name': string; /** * The custom role key * @type {string} * @memberof CustomRolePost */ 'key': string; /** * Description of custom role * @type {string} * @memberof CustomRolePost */ 'description'?: string; /** * * @type {Array} * @memberof CustomRolePost */ 'policy': Array; /** * * @type {string} * @memberof CustomRolePost */ 'basePermissions'?: string; /** * * @type {string} * @memberof CustomRolePost */ 'resourceCategory'?: string; } /** * * @export * @interface CustomRoles */ export interface CustomRoles { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof CustomRoles */ '_links'?: { [key: string]: Link; }; /** * An array of custom roles * @type {Array} * @memberof CustomRoles */ 'items': Array; /** * The total number of custom roles * @type {number} * @memberof CustomRoles */ 'totalCount'?: number; } /** * * @export * @interface CustomWorkflowInput */ export interface CustomWorkflowInput { /** * * @type {string} * @memberof CustomWorkflowInput */ 'maintainerId'?: string; /** * The workflow name * @type {string} * @memberof CustomWorkflowInput */ 'name': string; /** * The workflow description * @type {string} * @memberof CustomWorkflowInput */ 'description'?: string; /** * A list of the workflow stages * @type {Array} * @memberof CustomWorkflowInput */ 'stages'?: Array; /** * The template key * @type {string} * @memberof CustomWorkflowInput */ 'templateKey'?: string; } /** * * @export * @interface CustomWorkflowMeta */ export interface CustomWorkflowMeta { /** * The name of the workflow stage that required this approval request * @type {string} * @memberof CustomWorkflowMeta */ 'name'?: string; /** * * @type {CustomWorkflowStageMeta} * @memberof CustomWorkflowMeta */ 'stage'?: CustomWorkflowStageMeta; } /** * * @export * @interface CustomWorkflowOutput */ export interface CustomWorkflowOutput { /** * The ID of the workflow * @type {string} * @memberof CustomWorkflowOutput */ '_id': string; /** * The version of the workflow * @type {number} * @memberof CustomWorkflowOutput */ '_version': number; /** * Any conflicts that are present in the workflow stages * @type {Array} * @memberof CustomWorkflowOutput */ '_conflicts': Array; /** * * @type {number} * @memberof CustomWorkflowOutput */ '_creationDate': number; /** * The member ID of the maintainer of the workflow. Defaults to the workflow creator. * @type {string} * @memberof CustomWorkflowOutput */ '_maintainerId': string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof CustomWorkflowOutput */ '_links': { [key: string]: Link; }; /** * The name of the workflow * @type {string} * @memberof CustomWorkflowOutput */ 'name': string; /** * A brief description of the workflow * @type {string} * @memberof CustomWorkflowOutput */ 'description'?: string; /** * The kind of workflow * @type {string} * @memberof CustomWorkflowOutput */ 'kind'?: string; /** * The stages that make up the workflow. Each stage contains conditions and actions. * @type {Array} * @memberof CustomWorkflowOutput */ 'stages'?: Array; /** * * @type {ExecutionOutput} * @memberof CustomWorkflowOutput */ '_execution': ExecutionOutput; /** * * @type {WorkflowTemplateMetadata} * @memberof CustomWorkflowOutput */ 'meta'?: WorkflowTemplateMetadata; /** * For workflows being created from a workflow template, this value is the template\'s key * @type {string} * @memberof CustomWorkflowOutput */ 'templateKey'?: string; } /** * * @export * @interface CustomWorkflowStageMeta */ export interface CustomWorkflowStageMeta { /** * The zero-based index of the workflow stage * @type {number} * @memberof CustomWorkflowStageMeta */ 'index'?: number; /** * The name of the workflow stage * @type {string} * @memberof CustomWorkflowStageMeta */ 'name'?: string; } /** * * @export * @interface CustomWorkflowsListingOutput */ export interface CustomWorkflowsListingOutput { /** * An array of workflows * @type {Array} * @memberof CustomWorkflowsListingOutput */ 'items': Array; /** * Total number of workflows * @type {number} * @memberof CustomWorkflowsListingOutput */ 'totalCount': number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof CustomWorkflowsListingOutput */ '_links': { [key: string]: Link; }; } /** * * @export * @interface DefaultClientSideAvailability */ export interface DefaultClientSideAvailability { /** * Whether to enable availability for mobile SDKs * @type {boolean} * @memberof DefaultClientSideAvailability */ 'usingMobileKey': boolean; /** * Whether to enable availability for client-side SDKs * @type {boolean} * @memberof DefaultClientSideAvailability */ 'usingEnvironmentId': boolean; } /** * * @export * @interface DefaultClientSideAvailabilityPost */ export interface DefaultClientSideAvailabilityPost { /** * Whether to enable availability for client-side SDKs. * @type {boolean} * @memberof DefaultClientSideAvailabilityPost */ 'usingEnvironmentId': boolean; /** * Whether to enable availability for mobile SDKs. * @type {boolean} * @memberof DefaultClientSideAvailabilityPost */ 'usingMobileKey': boolean; } /** * * @export * @interface Defaults */ export interface Defaults { /** * The index, from the array of variations for this flag, of the variation to serve by default when targeting is on. * @type {number} * @memberof Defaults */ 'onVariation': number; /** * The index, from the array of variations for this flag, of the variation to serve by default when targeting is off. * @type {number} * @memberof Defaults */ 'offVariation': number; } /** * * @export * @interface DependentExperimentRep */ export interface DependentExperimentRep { /** * The experiment key * @type {string} * @memberof DependentExperimentRep */ 'key': string; /** * The experiment name * @type {string} * @memberof DependentExperimentRep */ 'name': string; /** * The environment ID * @type {string} * @memberof DependentExperimentRep */ 'environmentId': string; /** * The environment key * @type {string} * @memberof DependentExperimentRep */ 'environmentKey': string; /** * * @type {number} * @memberof DependentExperimentRep */ 'creationDate': number; /** * * @type {number} * @memberof DependentExperimentRep */ 'archivedDate'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DependentExperimentRep */ '_links': { [key: string]: Link; }; } /** * * @export * @interface DependentFlag */ export interface DependentFlag { /** * The flag name * @type {string} * @memberof DependentFlag */ 'name'?: string; /** * The flag key * @type {string} * @memberof DependentFlag */ 'key': string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DependentFlag */ '_links': { [key: string]: Link; }; /** * * @type {Link} * @memberof DependentFlag */ '_site': Link; } /** * * @export * @interface DependentFlagEnvironment */ export interface DependentFlagEnvironment { /** * The environment name * @type {string} * @memberof DependentFlagEnvironment */ 'name'?: string; /** * The environment key * @type {string} * @memberof DependentFlagEnvironment */ 'key': string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DependentFlagEnvironment */ '_links': { [key: string]: Link; }; /** * * @type {Link} * @memberof DependentFlagEnvironment */ '_site': Link; } /** * * @export * @interface DependentFlagsByEnvironment */ export interface DependentFlagsByEnvironment { /** * A list of dependent flags, which are flags that use the requested flag as a prerequisite * @type {Array} * @memberof DependentFlagsByEnvironment */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DependentFlagsByEnvironment */ '_links': { [key: string]: Link; }; /** * * @type {Link} * @memberof DependentFlagsByEnvironment */ '_site': Link; } /** * * @export * @interface DependentMetricGroupRep */ export interface DependentMetricGroupRep { /** * A unique key to reference the metric group * @type {string} * @memberof DependentMetricGroupRep */ 'key': string; /** * A human-friendly name for the metric group * @type {string} * @memberof DependentMetricGroupRep */ 'name': string; /** * The type of the metric group * @type {string} * @memberof DependentMetricGroupRep */ 'kind': DependentMetricGroupRepKindEnum; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DependentMetricGroupRep */ '_links': { [key: string]: Link; }; } export declare const DependentMetricGroupRepKindEnum: { readonly Funnel: "funnel"; readonly Standard: "standard"; }; export type DependentMetricGroupRepKindEnum = typeof DependentMetricGroupRepKindEnum[keyof typeof DependentMetricGroupRepKindEnum]; /** * * @export * @interface DependentMetricGroupRepWithMetrics */ export interface DependentMetricGroupRepWithMetrics { /** * A unique key to reference the metric group * @type {string} * @memberof DependentMetricGroupRepWithMetrics */ 'key': string; /** * A human-friendly name for the metric group * @type {string} * @memberof DependentMetricGroupRepWithMetrics */ 'name': string; /** * The type of the metric group * @type {string} * @memberof DependentMetricGroupRepWithMetrics */ 'kind': DependentMetricGroupRepWithMetricsKindEnum; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DependentMetricGroupRepWithMetrics */ '_links': { [key: string]: Link; }; /** * The metrics in the metric group * @type {Array} * @memberof DependentMetricGroupRepWithMetrics */ 'metrics'?: Array; } export declare const DependentMetricGroupRepWithMetricsKindEnum: { readonly Funnel: "funnel"; readonly Standard: "standard"; }; export type DependentMetricGroupRepWithMetricsKindEnum = typeof DependentMetricGroupRepWithMetricsKindEnum[keyof typeof DependentMetricGroupRepWithMetricsKindEnum]; /** * * @export * @interface DependentMetricOrMetricGroupRep */ export interface DependentMetricOrMetricGroupRep { /** * A unique key to reference the metric or metric group * @type {string} * @memberof DependentMetricOrMetricGroupRep */ 'key': string; /** * The version ID of the metric or metric group * @type {string} * @memberof DependentMetricOrMetricGroupRep */ '_versionId': string; /** * A human-friendly name for the metric or metric group * @type {string} * @memberof DependentMetricOrMetricGroupRep */ 'name': string; /** * If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type * @type {string} * @memberof DependentMetricOrMetricGroupRep */ 'kind': DependentMetricOrMetricGroupRepKindEnum; /** * For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). * @type {boolean} * @memberof DependentMetricOrMetricGroupRep */ 'isNumeric'?: boolean; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DependentMetricOrMetricGroupRep */ '_links': { [key: string]: Link; }; /** * Whether this is a metric group or a metric * @type {boolean} * @memberof DependentMetricOrMetricGroupRep */ 'isGroup': boolean; /** * An ordered list of the metrics in this metric group * @type {Array} * @memberof DependentMetricOrMetricGroupRep */ 'metrics'?: Array; } export declare const DependentMetricOrMetricGroupRepKindEnum: { readonly Pageview: "pageview"; readonly Click: "click"; readonly Custom: "custom"; readonly Funnel: "funnel"; readonly Standard: "standard"; }; export type DependentMetricOrMetricGroupRepKindEnum = typeof DependentMetricOrMetricGroupRepKindEnum[keyof typeof DependentMetricOrMetricGroupRepKindEnum]; /** * * @export * @interface DeploymentCollectionRep */ export interface DeploymentCollectionRep { /** * The total number of deployments * @type {number} * @memberof DeploymentCollectionRep */ 'totalCount': number; /** * A list of deployments * @type {Array} * @memberof DeploymentCollectionRep */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof DeploymentCollectionRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface DeploymentRep */ export interface DeploymentRep { /** * The deployment ID * @type {string} * @memberof DeploymentRep */ 'id': string; /** * The application key * @type {string} * @memberof DeploymentRep */ 'applicationKey': string; /** * The application version * @type {string} * @memberof DeploymentRep */ 'applicationVersion': string; /** * * @type {number} * @memberof DeploymentRep */ 'startedAt': number; /** * * @type {number} * @memberof DeploymentRep */ 'endedAt'?: number; /** * The duration of the deployment in milliseconds * @type {number} * @memberof DeploymentRep */ 'durationMs'?: number; /** * * @type {string} * @memberof DeploymentRep */ 'status': string; /** * * @type {string} * @memberof DeploymentRep */ 'kind': string; /** * Whether the deployment is active * @type {boolean} * @memberof DeploymentRep */ 'active': boolean; /** * The metadata associated with the deployment * @type {{ [key: string]: any; }} * @memberof DeploymentRep */ 'metadata'?: { [key: string]: any; }; /** * Whether the deployment is archived * @type {boolean} * @memberof DeploymentRep */ 'archived': boolean; /** * The environment key * @type {string} * @memberof DeploymentRep */ 'environmentKey': string; /** * The number of contributors * @type {number} * @memberof DeploymentRep */ 'numberOfContributors': number; /** * The number of pull requests * @type {number} * @memberof DeploymentRep */ 'numberOfPullRequests': number; /** * The number of lines added * @type {number} * @memberof DeploymentRep */ 'linesAdded': number; /** * The number of lines deleted * @type {number} * @memberof DeploymentRep */ 'linesDeleted': number; /** * The total lead time from first commit to deployment end in milliseconds * @type {number} * @memberof DeploymentRep */ 'leadTime': number; /** * * @type {PullRequestCollectionRep} * @memberof DeploymentRep */ 'pullRequests'?: PullRequestCollectionRep; /** * * @type {FlagReferenceCollectionRep} * @memberof DeploymentRep */ 'flagReferences'?: FlagReferenceCollectionRep; /** * * @type {LeadTimeStagesRep} * @memberof DeploymentRep */ 'leadTimeStages'?: LeadTimeStagesRep; } /** * * @export * @interface Destination */ export interface Destination { /** * The ID of this Data Export destination * @type {string} * @memberof Destination */ '_id'?: string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Destination */ '_links'?: { [key: string]: Link; }; /** * A human-readable name for your Data Export destination * @type {string} * @memberof Destination */ 'name'?: string; /** * The type of Data Export destination * @type {string} * @memberof Destination */ 'kind'?: DestinationKindEnum; /** * * @type {number} * @memberof Destination */ 'version'?: number; /** * An object with the configuration parameters required for the destination type * @type {any} * @memberof Destination */ 'config'?: any; /** * Whether the export is on, that is, the status of the integration * @type {boolean} * @memberof Destination */ 'on'?: boolean; /** * * @type {Access} * @memberof Destination */ '_access'?: Access; } export declare const DestinationKindEnum: { readonly GooglePubsub: "google-pubsub"; readonly Kinesis: "kinesis"; readonly Mparticle: "mparticle"; readonly Segment: "segment"; readonly AzureEventHubs: "azure-event-hubs"; readonly SnowflakeV2: "snowflake-v2"; }; export type DestinationKindEnum = typeof DestinationKindEnum[keyof typeof DestinationKindEnum]; /** * * @export * @interface DestinationPost */ export interface DestinationPost { /** * A human-readable name for your Data Export destination * @type {string} * @memberof DestinationPost */ 'name'?: string; /** * The type of Data Export destination * @type {string} * @memberof DestinationPost */ 'kind'?: DestinationPostKindEnum; /** * An object with the configuration parameters required for the destination type * @type {any} * @memberof DestinationPost */ 'config'?: any; /** * Whether the export is on. Displayed as the integration status in the LaunchDarkly UI. * @type {boolean} * @memberof DestinationPost */ 'on'?: boolean; } export declare const DestinationPostKindEnum: { readonly GooglePubsub: "google-pubsub"; readonly Kinesis: "kinesis"; readonly Mparticle: "mparticle"; readonly Segment: "segment"; readonly AzureEventHubs: "azure-event-hubs"; readonly SnowflakeV2: "snowflake-v2"; }; export type DestinationPostKindEnum = typeof DestinationPostKindEnum[keyof typeof DestinationPostKindEnum]; /** * * @export * @interface Destinations */ export interface Destinations { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Destinations */ '_links'?: { [key: string]: Link; }; /** * An array of Data Export destinations * @type {Array} * @memberof Destinations */ 'items'?: Array; } /** * * @export * @interface Distribution */ export interface Distribution { /** * The type of distribution. * @type {string} * @memberof Distribution */ 'kind'?: DistributionKindEnum; /** * The parameters of the distribution. The parameters are different for each distribution type. When kind is normal, the parameters of the distribution are \'mu\' and \'sigma\'. When kind is beta, the parameters of the distribution are \'alpha\' and \'beta.\' * @type {{ [key: string]: number; }} * @memberof Distribution */ 'parameters'?: { [key: string]: number; }; } export declare const DistributionKindEnum: { readonly Normal: "normal"; readonly Beta: "beta"; }; export type DistributionKindEnum = typeof DistributionKindEnum[keyof typeof DistributionKindEnum]; /** * * @export * @interface DynamicOptions */ export interface DynamicOptions { /** * * @type {Endpoint} * @memberof DynamicOptions */ 'endpoint'?: Endpoint; /** * * @type {DynamicOptionsParser} * @memberof DynamicOptions */ 'parser'?: DynamicOptionsParser; } /** * * @export * @interface DynamicOptionsParser */ export interface DynamicOptionsParser { /** * * @type {OptionsArray} * @memberof DynamicOptionsParser */ 'optionsItems'?: OptionsArray; /** * * @type {string} * @memberof DynamicOptionsParser */ 'optionsPath'?: string; } /** * * @export * @interface Endpoint */ export interface Endpoint { /** * * @type {Array} * @memberof Endpoint */ 'headers'?: Array; /** * * @type {HMACSignature} * @memberof Endpoint */ 'hmacSignature'?: HMACSignature; /** * * @type {string} * @memberof Endpoint */ 'method'?: string; /** * * @type {string} * @memberof Endpoint */ 'url'?: string; } /** * * @export * @interface Environment */ export interface Environment { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Environment */ '_links': { [key: string]: Link; }; /** * The ID for the environment. Use this as the client-side ID for authorization in some client-side SDKs, and to associate LaunchDarkly environments with CDN integrations in edge SDKs. * @type {string} * @memberof Environment */ '_id': string; /** * A project-unique key for the new environment * @type {string} * @memberof Environment */ 'key': string; /** * A human-friendly name for the new environment * @type {string} * @memberof Environment */ 'name': string; /** * The SDK key for the environment. Use this for authorization in server-side SDKs. * @type {string} * @memberof Environment */ 'apiKey': string; /** * The mobile key for the environment. Use this for authorization in mobile SDKs. * @type {string} * @memberof Environment */ 'mobileKey': string; /** * The color used to indicate this environment in the UI * @type {string} * @memberof Environment */ 'color': string; /** * The default time (in minutes) that the PHP SDK can cache feature flag rules locally * @type {number} * @memberof Environment */ 'defaultTtl': number; /** * Ensures that one end user of the client-side SDK cannot inspect the variations for another end user * @type {boolean} * @memberof Environment */ 'secureMode': boolean; /** * Enables tracking detailed information for new flags by default * @type {boolean} * @memberof Environment */ 'defaultTrackEvents': boolean; /** * Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment * @type {boolean} * @memberof Environment */ 'requireComments': boolean; /** * Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes * @type {boolean} * @memberof Environment */ 'confirmChanges': boolean; /** * A list of tags for this environment * @type {Array} * @memberof Environment */ 'tags': Array; /** * * @type {ApprovalSettings} * @memberof Environment */ 'approvalSettings'?: ApprovalSettings; /** * Details on the approval settings for this environment for each resource kind * @type {{ [key: string]: ApprovalSettings; }} * @memberof Environment */ 'resourceApprovalSettings'?: { [key: string]: ApprovalSettings; }; /** * Whether the environment is critical * @type {boolean} * @memberof Environment */ 'critical': boolean; } /** * * @export * @interface EnvironmentPost */ export interface EnvironmentPost { /** * A human-friendly name for the new environment * @type {string} * @memberof EnvironmentPost */ 'name': string; /** * A project-unique key for the new environment * @type {string} * @memberof EnvironmentPost */ 'key': string; /** * A color to indicate this environment in the UI * @type {string} * @memberof EnvironmentPost */ 'color': string; /** * The default time (in minutes) that the PHP SDK can cache feature flag rules locally * @type {number} * @memberof EnvironmentPost */ 'defaultTtl'?: number; /** * Ensures that one end user of the client-side SDK cannot inspect the variations for another end user * @type {boolean} * @memberof EnvironmentPost */ 'secureMode'?: boolean; /** * Enables tracking detailed information for new flags by default * @type {boolean} * @memberof EnvironmentPost */ 'defaultTrackEvents'?: boolean; /** * Requires confirmation for all flag and segment changes via the UI in this environment * @type {boolean} * @memberof EnvironmentPost */ 'confirmChanges'?: boolean; /** * Requires comments for all flag and segment changes via the UI in this environment * @type {boolean} * @memberof EnvironmentPost */ 'requireComments'?: boolean; /** * Tags to apply to the new environment * @type {Array} * @memberof EnvironmentPost */ 'tags'?: Array; /** * * @type {SourceEnv} * @memberof EnvironmentPost */ 'source'?: SourceEnv; /** * Whether the environment is critical * @type {boolean} * @memberof EnvironmentPost */ 'critical'?: boolean; } /** * * @export * @interface EnvironmentSummary */ export interface EnvironmentSummary { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof EnvironmentSummary */ '_links': { [key: string]: Link; }; /** * A project-unique key for the environment * @type {string} * @memberof EnvironmentSummary */ 'key': string; /** * A human-friendly name for the environment * @type {string} * @memberof EnvironmentSummary */ 'name': string; /** * The color used to indicate this environment in the UI * @type {string} * @memberof EnvironmentSummary */ 'color': string; } /** * * @export * @interface Environments */ export interface Environments { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Environments */ '_links'?: { [key: string]: Link; }; /** * The number of environments returned * @type {number} * @memberof Environments */ 'totalCount'?: number; /** * An array of environments * @type {Array} * @memberof Environments */ 'items': Array; } /** * * @export * @interface EvaluationReason */ export interface EvaluationReason { /** * Describes the general reason that LaunchDarkly selected this variation. * @type {string} * @memberof EvaluationReason */ 'kind': string; /** * The positional index of the matching rule if the kind is \'RULE_MATCH\'. The index is 0-based. * @type {number} * @memberof EvaluationReason */ 'ruleIndex'?: number; /** * The unique identifier of the matching rule if the kind is \'RULE_MATCH\'. * @type {string} * @memberof EvaluationReason */ 'ruleID'?: string; /** * The key of the flag that failed if the kind is \'PREREQUISITE_FAILED\'. * @type {string} * @memberof EvaluationReason */ 'prerequisiteKey'?: string; /** * Indicates whether the evaluation occurred as part of an experiment. * @type {boolean} * @memberof EvaluationReason */ 'inExperiment'?: boolean; /** * The specific error type if the kind is \'ERROR\'. * @type {string} * @memberof EvaluationReason */ 'errorKind'?: string; } /** * * @export * @interface EvaluationsSummary */ export interface EvaluationsSummary { /** * A list of variation evaluations * @type {Array} * @memberof EvaluationsSummary */ 'variations'?: Array; } /** * * @export * @interface ExecutionOutput */ export interface ExecutionOutput { /** * The status of the execution of this workflow stage * @type {string} * @memberof ExecutionOutput */ 'status': string; /** * * @type {number} * @memberof ExecutionOutput */ 'stopDate'?: number; } /** * * @export * @interface ExpandableApprovalRequestResponse */ export interface ExpandableApprovalRequestResponse { /** * The ID of this approval request * @type {string} * @memberof ExpandableApprovalRequestResponse */ '_id': string; /** * Version of the approval request * @type {number} * @memberof ExpandableApprovalRequestResponse */ '_version': number; /** * * @type {number} * @memberof ExpandableApprovalRequestResponse */ 'creationDate': number; /** * * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'serviceKind': string; /** * The ID of the member who requested the approval * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'requestorId'?: string; /** * A human-friendly name for the approval request * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'description'?: string; /** * Current status of the review of this approval request * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'reviewStatus': ExpandableApprovalRequestResponseReviewStatusEnum; /** * An array of individual reviews of this approval request * @type {Array} * @memberof ExpandableApprovalRequestResponse */ 'allReviews': Array; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof ExpandableApprovalRequestResponse */ 'notifyMemberIds': Array; /** * * @type {number} * @memberof ExpandableApprovalRequestResponse */ 'appliedDate'?: number; /** * The member ID of the member who applied the approval request * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'appliedByMemberId'?: string; /** * The service token ID of the service token which applied the approval request * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'appliedByServiceTokenId'?: string; /** * Current status of the approval request * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'status': ExpandableApprovalRequestResponseStatusEnum; /** * * @type {Array<{ [key: string]: any; }>} * @memberof ExpandableApprovalRequestResponse */ 'instructions': Array<{ [key: string]: any; }>; /** * Details on any conflicting approval requests * @type {Array} * @memberof ExpandableApprovalRequestResponse */ 'conflicts': Array; /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof ExpandableApprovalRequestResponse */ '_links': { [key: string]: any; }; /** * * @type {number} * @memberof ExpandableApprovalRequestResponse */ 'executionDate'?: number; /** * ID of scheduled change to edit or delete * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'operatingOnId'?: string; /** * * @type {IntegrationMetadata} * @memberof ExpandableApprovalRequestResponse */ 'integrationMetadata'?: IntegrationMetadata; /** * * @type {CopiedFromEnv} * @memberof ExpandableApprovalRequestResponse */ 'source'?: CopiedFromEnv; /** * * @type {CustomWorkflowMeta} * @memberof ExpandableApprovalRequestResponse */ 'customWorkflowMetadata'?: CustomWorkflowMeta; /** * String representation of a resource * @type {string} * @memberof ExpandableApprovalRequestResponse */ 'resourceId'?: string; /** * * @type {ApprovalSettings} * @memberof ExpandableApprovalRequestResponse */ 'approvalSettings'?: ApprovalSettings; /** * * @type {Project} * @memberof ExpandableApprovalRequestResponse */ 'project'?: Project; /** * List of environments the approval impacts * @type {Array} * @memberof ExpandableApprovalRequestResponse */ 'environments'?: Array; /** * * @type {ExpandedFlagRep} * @memberof ExpandableApprovalRequestResponse */ 'flag'?: ExpandedFlagRep; /** * * @type {ExpandedResourceRep} * @memberof ExpandableApprovalRequestResponse */ 'resource'?: ExpandedResourceRep; } export declare const ExpandableApprovalRequestResponseReviewStatusEnum: { readonly Approved: "approved"; readonly Declined: "declined"; readonly Pending: "pending"; }; export type ExpandableApprovalRequestResponseReviewStatusEnum = typeof ExpandableApprovalRequestResponseReviewStatusEnum[keyof typeof ExpandableApprovalRequestResponseReviewStatusEnum]; export declare const ExpandableApprovalRequestResponseStatusEnum: { readonly Pending: "pending"; readonly Completed: "completed"; readonly Failed: "failed"; readonly Scheduled: "scheduled"; }; export type ExpandableApprovalRequestResponseStatusEnum = typeof ExpandableApprovalRequestResponseStatusEnum[keyof typeof ExpandableApprovalRequestResponseStatusEnum]; /** * * @export * @interface ExpandableApprovalRequestsResponse */ export interface ExpandableApprovalRequestsResponse { /** * An array of approval requests * @type {Array} * @memberof ExpandableApprovalRequestsResponse */ 'items': Array; /** * Total number of approval requests * @type {number} * @memberof ExpandableApprovalRequestsResponse */ 'totalCount': number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExpandableApprovalRequestsResponse */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ExpandedFlagRep */ export interface ExpandedFlagRep { /** * A human-friendly name for the feature flag * @type {string} * @memberof ExpandedFlagRep */ 'name': string; /** * Kind of feature flag * @type {string} * @memberof ExpandedFlagRep */ 'kind': ExpandedFlagRepKindEnum; /** * Description of the feature flag * @type {string} * @memberof ExpandedFlagRep */ 'description'?: string; /** * A unique key used to reference the flag in your code * @type {string} * @memberof ExpandedFlagRep */ 'key': string; /** * Version of the feature flag * @type {number} * @memberof ExpandedFlagRep */ '_version': number; /** * * @type {number} * @memberof ExpandedFlagRep */ 'creationDate': number; /** * Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK * @type {boolean} * @memberof ExpandedFlagRep * @deprecated */ 'includeInSnippet'?: boolean; /** * * @type {ClientSideAvailability} * @memberof ExpandedFlagRep */ 'clientSideAvailability'?: ClientSideAvailability; /** * An array of possible variations for the flag * @type {Array} * @memberof ExpandedFlagRep */ 'variations': Array; /** * Whether the flag is a temporary flag * @type {boolean} * @memberof ExpandedFlagRep */ 'temporary': boolean; /** * Tags for the feature flag * @type {Array} * @memberof ExpandedFlagRep */ 'tags': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExpandedFlagRep */ '_links': { [key: string]: Link; }; /** * The ID of the member who maintains the flag * @type {string} * @memberof ExpandedFlagRep */ 'maintainerId'?: string; /** * * @type {MemberSummary} * @memberof ExpandedFlagRep */ '_maintainer'?: MemberSummary; /** * * @type {{ [key: string]: CustomProperty; }} * @memberof ExpandedFlagRep */ 'customProperties': { [key: string]: CustomProperty; }; /** * Boolean indicating if the feature flag is archived * @type {boolean} * @memberof ExpandedFlagRep */ 'archived': boolean; /** * * @type {number} * @memberof ExpandedFlagRep */ 'archivedDate'?: number; /** * * @type {Defaults} * @memberof ExpandedFlagRep */ 'defaults'?: Defaults; } export declare const ExpandedFlagRepKindEnum: { readonly Boolean: "boolean"; readonly Multivariate: "multivariate"; }; export type ExpandedFlagRepKindEnum = typeof ExpandedFlagRepKindEnum[keyof typeof ExpandedFlagRepKindEnum]; /** * * @export * @interface ExpandedResourceRep */ export interface ExpandedResourceRep { /** * The type of resource * @type {string} * @memberof ExpandedResourceRep */ 'kind': string; /** * * @type {ExpandedFlagRep} * @memberof ExpandedResourceRep */ 'flag'?: ExpandedFlagRep; /** * * @type {UserSegment} * @memberof ExpandedResourceRep */ 'segment'?: UserSegment; } /** * * @export * @interface Experiment */ export interface Experiment { /** * The experiment ID * @type {string} * @memberof Experiment */ '_id'?: string; /** * The experiment key * @type {string} * @memberof Experiment */ 'key': string; /** * The experiment name * @type {string} * @memberof Experiment */ 'name': string; /** * The experiment description * @type {string} * @memberof Experiment */ 'description'?: string; /** * The ID of the member who maintains this experiment. * @type {string} * @memberof Experiment */ '_maintainerId': string; /** * * @type {number} * @memberof Experiment */ '_creationDate': number; /** * * @type {string} * @memberof Experiment */ 'environmentKey': string; /** * * @type {number} * @memberof Experiment */ 'archivedDate'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Experiment */ '_links': { [key: string]: Link; }; /** * The holdout ID * @type {string} * @memberof Experiment */ 'holdoutId'?: string; /** * * @type {IterationRep} * @memberof Experiment */ 'currentIteration'?: IterationRep; /** * * @type {IterationRep} * @memberof Experiment */ 'draftIteration'?: IterationRep; /** * Details on the previous iterations for this experiment. * @type {Array} * @memberof Experiment */ 'previousIterations'?: Array; } /** * * @export * @interface ExperimentAllocationRep */ export interface ExperimentAllocationRep { /** * * @type {number} * @memberof ExperimentAllocationRep */ 'defaultVariation': number; /** * * @type {boolean} * @memberof ExperimentAllocationRep */ 'canReshuffle': boolean; } /** * * @export * @interface ExperimentBayesianResultsRep */ export interface ExperimentBayesianResultsRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExperimentBayesianResultsRep */ '_links'?: { [key: string]: Link; }; /** * Deprecated, use results instead. Only populated when response does not contain results sliced by multiple attributes. * @type {Array} * @memberof ExperimentBayesianResultsRep * @deprecated */ 'treatmentResults'?: Array; /** * * @type {MetricSeen} * @memberof ExperimentBayesianResultsRep */ 'metricSeen'?: MetricSeen; /** * The probability of a Sample Ratio Mismatch * @type {number} * @memberof ExperimentBayesianResultsRep */ 'probabilityOfMismatch'?: number; /** * A list of attribute values and their corresponding treatment results * @type {Array} * @memberof ExperimentBayesianResultsRep */ 'results'?: Array; } /** * * @export * @interface ExperimentCollectionRep */ export interface ExperimentCollectionRep { /** * An array of experiments * @type {Array} * @memberof ExperimentCollectionRep */ 'items': Array; /** * The total number of experiments in this project and environment. Does not include legacy experiments. * @type {number} * @memberof ExperimentCollectionRep */ 'total_count'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExperimentCollectionRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface ExperimentEnabledPeriodRep */ export interface ExperimentEnabledPeriodRep { /** * * @type {number} * @memberof ExperimentEnabledPeriodRep */ 'startDate'?: number; /** * * @type {number} * @memberof ExperimentEnabledPeriodRep */ 'stopDate'?: number; } /** * * @export * @interface ExperimentEnvironmentSettingRep */ export interface ExperimentEnvironmentSettingRep { /** * * @type {number} * @memberof ExperimentEnvironmentSettingRep */ 'startDate'?: number; /** * * @type {number} * @memberof ExperimentEnvironmentSettingRep */ 'stopDate'?: number; /** * * @type {Array} * @memberof ExperimentEnvironmentSettingRep */ 'enabledPeriods'?: Array; } /** * * @export * @interface ExperimentInfoRep */ export interface ExperimentInfoRep { /** * * @type {number} * @memberof ExperimentInfoRep */ 'baselineIdx': number; /** * * @type {Array} * @memberof ExperimentInfoRep */ 'items': Array; } /** * * @export * @interface ExperimentPatchInput */ export interface ExperimentPatchInput { /** * Optional comment describing the update * @type {string} * @memberof ExperimentPatchInput */ 'comment'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof ExperimentPatchInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface ExperimentPost */ export interface ExperimentPost { /** * The experiment name * @type {string} * @memberof ExperimentPost */ 'name': string; /** * The experiment description * @type {string} * @memberof ExperimentPost */ 'description'?: string; /** * The ID of the member who maintains this experiment * @type {string} * @memberof ExperimentPost */ 'maintainerId'?: string; /** * The experiment key * @type {string} * @memberof ExperimentPost */ 'key': string; /** * * @type {IterationInput} * @memberof ExperimentPost */ 'iteration': IterationInput; /** * The ID of the holdout * @type {string} * @memberof ExperimentPost */ 'holdoutId'?: string; } /** * * @export * @interface ExpiringTarget */ export interface ExpiringTarget { /** * The ID of this expiring target * @type {string} * @memberof ExpiringTarget */ '_id': string; /** * The version of this expiring target * @type {number} * @memberof ExpiringTarget */ '_version': number; /** * * @type {number} * @memberof ExpiringTarget */ 'expirationDate': number; /** * The context kind of the context to be removed * @type {string} * @memberof ExpiringTarget */ 'contextKind': string; /** * A unique key used to represent the context to be removed * @type {string} * @memberof ExpiringTarget */ 'contextKey': string; /** * A segment\'s target type, included or excluded. Included when expiring targets are updated on a segment. * @type {string} * @memberof ExpiringTarget */ 'targetType'?: string; /** * A unique ID used to represent the flag variation. Included when expiring targets are updated on a feature flag. * @type {string} * @memberof ExpiringTarget */ 'variationId'?: string; /** * * @type {ResourceId} * @memberof ExpiringTarget */ '_resourceId': ResourceId; } /** * * @export * @interface ExpiringTargetError */ export interface ExpiringTargetError { /** * The index of the PATCH instruction where the error occurred * @type {number} * @memberof ExpiringTargetError */ 'instructionIndex': number; /** * The error message related to a failed PATCH instruction * @type {string} * @memberof ExpiringTargetError */ 'message': string; } /** * * @export * @interface ExpiringTargetGetResponse */ export interface ExpiringTargetGetResponse { /** * A list of expiring targets * @type {Array} * @memberof ExpiringTargetGetResponse */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExpiringTargetGetResponse */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface ExpiringTargetPatchResponse */ export interface ExpiringTargetPatchResponse { /** * A list of the results from each instruction * @type {Array} * @memberof ExpiringTargetPatchResponse */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExpiringTargetPatchResponse */ '_links'?: { [key: string]: Link; }; /** * * @type {number} * @memberof ExpiringTargetPatchResponse */ 'totalInstructions'?: number; /** * * @type {number} * @memberof ExpiringTargetPatchResponse */ 'successfulInstructions'?: number; /** * * @type {number} * @memberof ExpiringTargetPatchResponse */ 'failedInstructions'?: number; /** * * @type {Array} * @memberof ExpiringTargetPatchResponse */ 'errors'?: Array; } /** * * @export * @interface ExpiringUserTargetGetResponse */ export interface ExpiringUserTargetGetResponse { /** * An array of expiring user targets * @type {Array} * @memberof ExpiringUserTargetGetResponse */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExpiringUserTargetGetResponse */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface ExpiringUserTargetItem */ export interface ExpiringUserTargetItem { /** * The ID of this expiring user target * @type {string} * @memberof ExpiringUserTargetItem */ '_id': string; /** * The version of this expiring user target * @type {number} * @memberof ExpiringUserTargetItem */ '_version': number; /** * * @type {number} * @memberof ExpiringUserTargetItem */ 'expirationDate': number; /** * A unique key used to represent the user * @type {string} * @memberof ExpiringUserTargetItem */ 'userKey': string; /** * A segment\'s target type. Included when expiring user targets are updated on a segment. * @type {string} * @memberof ExpiringUserTargetItem */ 'targetType'?: string; /** * A unique key used to represent the flag variation. Included when expiring user targets are updated on a feature flag. * @type {string} * @memberof ExpiringUserTargetItem */ 'variationId'?: string; /** * * @type {ResourceIDResponse} * @memberof ExpiringUserTargetItem */ '_resourceId': ResourceIDResponse; } /** * * @export * @interface ExpiringUserTargetPatchResponse */ export interface ExpiringUserTargetPatchResponse { /** * An array of expiring user targets * @type {Array} * @memberof ExpiringUserTargetPatchResponse */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExpiringUserTargetPatchResponse */ '_links'?: { [key: string]: Link; }; /** * The total count of instructions sent in the PATCH request * @type {number} * @memberof ExpiringUserTargetPatchResponse */ 'totalInstructions'?: number; /** * The total count of successful instructions sent in the PATCH request * @type {number} * @memberof ExpiringUserTargetPatchResponse */ 'successfulInstructions'?: number; /** * The total count of the failed instructions sent in the PATCH request * @type {number} * @memberof ExpiringUserTargetPatchResponse */ 'failedInstructions'?: number; /** * An array of error messages for the failed instructions * @type {Array} * @memberof ExpiringUserTargetPatchResponse */ 'errors'?: Array; } /** * * @export * @interface Export */ export interface Export { /** * The export ID * @type {string} * @memberof Export */ 'id': string; /** * The segment key * @type {string} * @memberof Export */ 'segmentKey': string; /** * * @type {number} * @memberof Export */ 'creationTime': number; /** * The export status * @type {string} * @memberof Export */ 'status': string; /** * The export size, in bytes * @type {number} * @memberof Export */ 'sizeBytes': number; /** * The export size, with units * @type {string} * @memberof Export */ 'size': string; /** * * @type {InitiatorRep} * @memberof Export */ 'initiator': InitiatorRep; /** * The location and content type of related resources, including the location of the exported file * @type {{ [key: string]: Link; }} * @memberof Export */ '_links': { [key: string]: Link; }; } /** * * @export * @interface Extinction */ export interface Extinction { /** * The identifier for the revision where flag became extinct. For example, a commit SHA. * @type {string} * @memberof Extinction */ 'revision': string; /** * Description of the extinction. For example, the commit message for the revision. * @type {string} * @memberof Extinction */ 'message': string; /** * * @type {number} * @memberof Extinction */ 'time': number; /** * The feature flag key * @type {string} * @memberof Extinction */ 'flagKey': string; /** * The project key * @type {string} * @memberof Extinction */ 'projKey': string; } /** * * @export * @interface ExtinctionCollectionRep */ export interface ExtinctionCollectionRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ExtinctionCollectionRep */ '_links': { [key: string]: Link; }; /** * An array of extinction events * @type {{ [key: string]: Array; }} * @memberof ExtinctionCollectionRep */ 'items': { [key: string]: Array; }; } /** * * @export * @interface FailureReasonRep */ export interface FailureReasonRep { /** * The attribute that failed validation * @type {string} * @memberof FailureReasonRep */ 'attribute': string; /** * The reason the attribute failed validation * @type {string} * @memberof FailureReasonRep */ 'reason': string; } /** * * @export * @interface FeatureFlag */ export interface FeatureFlag { /** * A human-friendly name for the feature flag * @type {string} * @memberof FeatureFlag */ 'name': string; /** * Kind of feature flag * @type {string} * @memberof FeatureFlag */ 'kind': FeatureFlagKindEnum; /** * Description of the feature flag * @type {string} * @memberof FeatureFlag */ 'description'?: string; /** * A unique key used to reference the flag in your code * @type {string} * @memberof FeatureFlag */ 'key': string; /** * Version of the feature flag * @type {number} * @memberof FeatureFlag */ '_version': number; /** * * @type {number} * @memberof FeatureFlag */ 'creationDate': number; /** * Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK * @type {boolean} * @memberof FeatureFlag * @deprecated */ 'includeInSnippet'?: boolean; /** * * @type {ClientSideAvailability} * @memberof FeatureFlag */ 'clientSideAvailability'?: ClientSideAvailability; /** * An array of possible variations for the flag * @type {Array} * @memberof FeatureFlag */ 'variations': Array; /** * Whether the flag is a temporary flag * @type {boolean} * @memberof FeatureFlag */ 'temporary': boolean; /** * Tags for the feature flag * @type {Array} * @memberof FeatureFlag */ 'tags': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FeatureFlag */ '_links': { [key: string]: Link; }; /** * Associated maintainerId for the feature flag * @type {string} * @memberof FeatureFlag */ 'maintainerId'?: string; /** * * @type {MemberSummary} * @memberof FeatureFlag */ '_maintainer'?: MemberSummary; /** * The key of the associated team that maintains this feature flag * @type {string} * @memberof FeatureFlag */ 'maintainerTeamKey'?: string; /** * * @type {MaintainerTeam} * @memberof FeatureFlag */ '_maintainerTeam'?: MaintainerTeam; /** * Deprecated, use experiments instead * @type {Array} * @memberof FeatureFlag * @deprecated */ 'goalIds'?: Array; /** * * @type {ExperimentInfoRep} * @memberof FeatureFlag */ 'experiments': ExperimentInfoRep; /** * * @type {{ [key: string]: CustomProperty; }} * @memberof FeatureFlag */ 'customProperties': { [key: string]: CustomProperty; }; /** * Boolean indicating if the feature flag is archived * @type {boolean} * @memberof FeatureFlag */ 'archived': boolean; /** * * @type {number} * @memberof FeatureFlag */ 'archivedDate'?: number; /** * Boolean indicating if the feature flag is deprecated * @type {boolean} * @memberof FeatureFlag */ 'deprecated'?: boolean; /** * * @type {number} * @memberof FeatureFlag */ 'deprecatedDate'?: number; /** * * @type {Defaults} * @memberof FeatureFlag */ 'defaults'?: Defaults; /** * * @type {string} * @memberof FeatureFlag */ '_purpose'?: string; /** * * @type {FlagMigrationSettingsRep} * @memberof FeatureFlag */ 'migrationSettings'?: FlagMigrationSettingsRep; /** * Details on the environments for this flag. Only returned if the request is filtered by environment, using the filterEnv query parameter. * @type {{ [key: string]: FeatureFlagConfig; }} * @memberof FeatureFlag */ 'environments'?: { [key: string]: FeatureFlagConfig; }; } export declare const FeatureFlagKindEnum: { readonly Boolean: "boolean"; readonly Multivariate: "multivariate"; }; export type FeatureFlagKindEnum = typeof FeatureFlagKindEnum[keyof typeof FeatureFlagKindEnum]; /** * * @export * @interface FeatureFlagBody */ export interface FeatureFlagBody { /** * A human-friendly name for the feature flag * @type {string} * @memberof FeatureFlagBody */ 'name': string; /** * A unique key used to reference the flag in your code * @type {string} * @memberof FeatureFlagBody */ 'key': string; /** * Description of the feature flag. Defaults to an empty string. * @type {string} * @memberof FeatureFlagBody */ 'description'?: string; /** * Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK. Defaults to false. * @type {boolean} * @memberof FeatureFlagBody * @deprecated */ 'includeInSnippet'?: boolean; /** * * @type {ClientSideAvailabilityPost} * @memberof FeatureFlagBody */ 'clientSideAvailability'?: ClientSideAvailabilityPost; /** * An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of true and false will be used. * @type {Array} * @memberof FeatureFlagBody */ 'variations'?: Array; /** * Whether the flag is a temporary flag. Defaults to true. * @type {boolean} * @memberof FeatureFlagBody */ 'temporary'?: boolean; /** * Tags for the feature flag. Defaults to an empty array. * @type {Array} * @memberof FeatureFlagBody */ 'tags'?: Array; /** * * @type {{ [key: string]: CustomProperty; }} * @memberof FeatureFlagBody */ 'customProperties'?: { [key: string]: CustomProperty; }; /** * * @type {Defaults} * @memberof FeatureFlagBody */ 'defaults'?: Defaults; /** * Purpose of the flag * @type {string} * @memberof FeatureFlagBody */ 'purpose'?: FeatureFlagBodyPurposeEnum; /** * * @type {MigrationSettingsPost} * @memberof FeatureFlagBody */ 'migrationSettings'?: MigrationSettingsPost; /** * The ID of the member who maintains this feature flag * @type {string} * @memberof FeatureFlagBody */ 'maintainerId'?: string; /** * The key of the team that maintains this feature flag * @type {string} * @memberof FeatureFlagBody */ 'maintainerTeamKey'?: string; /** * Initial set of prerequisite flags for all environments * @type {Array} * @memberof FeatureFlagBody */ 'initialPrerequisites'?: Array; } export declare const FeatureFlagBodyPurposeEnum: { readonly Migration: "migration"; readonly Holdout: "holdout"; }; export type FeatureFlagBodyPurposeEnum = typeof FeatureFlagBodyPurposeEnum[keyof typeof FeatureFlagBodyPurposeEnum]; /** * * @export * @interface FeatureFlagConfig */ export interface FeatureFlagConfig { /** * Whether the flag is on * @type {boolean} * @memberof FeatureFlagConfig */ 'on': boolean; /** * Boolean indicating if the feature flag is archived * @type {boolean} * @memberof FeatureFlagConfig */ 'archived': boolean; /** * * @type {string} * @memberof FeatureFlagConfig */ 'salt': string; /** * * @type {string} * @memberof FeatureFlagConfig */ 'sel': string; /** * * @type {number} * @memberof FeatureFlagConfig */ 'lastModified': number; /** * Version of the feature flag * @type {number} * @memberof FeatureFlagConfig */ 'version': number; /** * An array of the individual targets that will receive a specific variation based on their key. Individual targets with a context kind of \'user\' are included here. * @type {Array} * @memberof FeatureFlagConfig */ 'targets'?: Array; /** * An array of the individual targets that will receive a specific variation based on their key. Individual targets with context kinds other than \'user\' are included here. * @type {Array} * @memberof FeatureFlagConfig */ 'contextTargets'?: Array; /** * An array of the rules for how to serve a variation to specific targets based on their attributes * @type {Array} * @memberof FeatureFlagConfig */ 'rules'?: Array; /** * * @type {VariationOrRolloutRep} * @memberof FeatureFlagConfig */ 'fallthrough'?: VariationOrRolloutRep; /** * The ID of the variation to serve when the flag is off * @type {number} * @memberof FeatureFlagConfig */ 'offVariation'?: number; /** * An array of the prerequisite flags and their variations that are required before this flag takes effect * @type {Array} * @memberof FeatureFlagConfig */ 'prerequisites'?: Array; /** * * @type {Link} * @memberof FeatureFlagConfig */ '_site': Link; /** * * @type {Access} * @memberof FeatureFlagConfig */ '_access'?: Access; /** * The environment name * @type {string} * @memberof FeatureFlagConfig */ '_environmentName': string; /** * Whether LaunchDarkly tracks events for the feature flag, for all rules * @type {boolean} * @memberof FeatureFlagConfig */ 'trackEvents': boolean; /** * Whether LaunchDarkly tracks events for the feature flag, for the default rule * @type {boolean} * @memberof FeatureFlagConfig */ 'trackEventsFallthrough': boolean; /** * * @type {number} * @memberof FeatureFlagConfig */ '_debugEventsUntilDate'?: number; /** * * @type {FlagSummary} * @memberof FeatureFlagConfig */ '_summary'?: FlagSummary; /** * * @type {FlagConfigEvaluation} * @memberof FeatureFlagConfig */ 'evaluation'?: FlagConfigEvaluation; /** * * @type {FlagConfigMigrationSettingsRep} * @memberof FeatureFlagConfig */ 'migrationSettings'?: FlagConfigMigrationSettingsRep; } /** * * @export * @interface FeatureFlagScheduledChange */ export interface FeatureFlagScheduledChange { /** * * @type {string} * @memberof FeatureFlagScheduledChange */ '_id': string; /** * * @type {number} * @memberof FeatureFlagScheduledChange */ '_creationDate': number; /** * The ID of the scheduled change maintainer * @type {string} * @memberof FeatureFlagScheduledChange */ '_maintainerId': string; /** * Version of the scheduled change * @type {number} * @memberof FeatureFlagScheduledChange */ '_version': number; /** * * @type {number} * @memberof FeatureFlagScheduledChange */ 'executionDate': number; /** * * @type {Array<{ [key: string]: any; }>} * @memberof FeatureFlagScheduledChange */ 'instructions': Array<{ [key: string]: any; }>; /** * Details on any conflicting scheduled changes * @type {any} * @memberof FeatureFlagScheduledChange */ 'conflicts'?: any; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FeatureFlagScheduledChange */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface FeatureFlagScheduledChanges */ export interface FeatureFlagScheduledChanges { /** * Array of scheduled changes * @type {Array} * @memberof FeatureFlagScheduledChanges */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FeatureFlagScheduledChanges */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface FeatureFlagStatus */ export interface FeatureFlagStatus { /** * Status of the flag * @type {string} * @memberof FeatureFlagStatus */ 'name': FeatureFlagStatusNameEnum; /** * Timestamp of last time flag was requested * @type {string} * @memberof FeatureFlagStatus */ 'lastRequested'?: string; /** * Default value seen from code * @type {any} * @memberof FeatureFlagStatus */ 'default'?: any; } export declare const FeatureFlagStatusNameEnum: { readonly New: "new"; readonly Inactive: "inactive"; readonly Active: "active"; readonly Launched: "launched"; }; export type FeatureFlagStatusNameEnum = typeof FeatureFlagStatusNameEnum[keyof typeof FeatureFlagStatusNameEnum]; /** * * @export * @interface FeatureFlagStatusAcrossEnvironments */ export interface FeatureFlagStatusAcrossEnvironments { /** * Flag status for environment. * @type {{ [key: string]: FeatureFlagStatus; }} * @memberof FeatureFlagStatusAcrossEnvironments */ 'environments': { [key: string]: FeatureFlagStatus; }; /** * feature flag key * @type {string} * @memberof FeatureFlagStatusAcrossEnvironments */ 'key': string; /** * * @type {{ [key: string]: Link; }} * @memberof FeatureFlagStatusAcrossEnvironments */ '_links': { [key: string]: Link; }; } /** * * @export * @interface FeatureFlagStatuses */ export interface FeatureFlagStatuses { /** * * @type {{ [key: string]: Link; }} * @memberof FeatureFlagStatuses */ '_links': { [key: string]: Link; }; /** * * @type {Array} * @memberof FeatureFlagStatuses */ 'items'?: Array; } /** * * @export * @interface FeatureFlags */ export interface FeatureFlags { /** * An array of feature flags * @type {Array} * @memberof FeatureFlags */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FeatureFlags */ '_links': { [key: string]: Link; }; /** * The total number of flags * @type {number} * @memberof FeatureFlags */ 'totalCount'?: number; /** * The number of flags that have differences between environments. Only shown when query parameter compare is true. * @type {number} * @memberof FeatureFlags */ 'totalCountWithDifferences'?: number; } /** * * @export * @interface FileRep */ export interface FileRep { /** * The imported file name, including the extension * @type {string} * @memberof FileRep */ 'filename'?: string; /** * The imported file status * @type {string} * @memberof FileRep */ 'status'?: string; } /** * * @export * @interface FlagConfigApprovalRequestResponse */ export interface FlagConfigApprovalRequestResponse { /** * The ID of this approval request * @type {string} * @memberof FlagConfigApprovalRequestResponse */ '_id': string; /** * Version of the approval request * @type {number} * @memberof FlagConfigApprovalRequestResponse */ '_version': number; /** * * @type {number} * @memberof FlagConfigApprovalRequestResponse */ 'creationDate': number; /** * * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'serviceKind': string; /** * The ID of the member who requested the approval * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'requestorId'?: string; /** * A human-friendly name for the approval request * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'description'?: string; /** * Current status of the review of this approval request * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'reviewStatus': FlagConfigApprovalRequestResponseReviewStatusEnum; /** * An array of individual reviews of this approval request * @type {Array} * @memberof FlagConfigApprovalRequestResponse */ 'allReviews': Array; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof FlagConfigApprovalRequestResponse */ 'notifyMemberIds': Array; /** * * @type {number} * @memberof FlagConfigApprovalRequestResponse */ 'appliedDate'?: number; /** * The member ID of the member who applied the approval request * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'appliedByMemberId'?: string; /** * The service token ID of the service token which applied the approval request * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'appliedByServiceTokenId'?: string; /** * Current status of the approval request * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'status': FlagConfigApprovalRequestResponseStatusEnum; /** * * @type {Array<{ [key: string]: any; }>} * @memberof FlagConfigApprovalRequestResponse */ 'instructions': Array<{ [key: string]: any; }>; /** * Details on any conflicting approval requests * @type {Array} * @memberof FlagConfigApprovalRequestResponse */ 'conflicts': Array; /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof FlagConfigApprovalRequestResponse */ '_links': { [key: string]: any; }; /** * * @type {number} * @memberof FlagConfigApprovalRequestResponse */ 'executionDate'?: number; /** * ID of scheduled change to edit or delete * @type {string} * @memberof FlagConfigApprovalRequestResponse */ 'operatingOnId'?: string; /** * * @type {IntegrationMetadata} * @memberof FlagConfigApprovalRequestResponse */ 'integrationMetadata'?: IntegrationMetadata; /** * * @type {CopiedFromEnv} * @memberof FlagConfigApprovalRequestResponse */ 'source'?: CopiedFromEnv; /** * * @type {CustomWorkflowMeta} * @memberof FlagConfigApprovalRequestResponse */ 'customWorkflowMetadata'?: CustomWorkflowMeta; } export declare const FlagConfigApprovalRequestResponseReviewStatusEnum: { readonly Approved: "approved"; readonly Declined: "declined"; readonly Pending: "pending"; }; export type FlagConfigApprovalRequestResponseReviewStatusEnum = typeof FlagConfigApprovalRequestResponseReviewStatusEnum[keyof typeof FlagConfigApprovalRequestResponseReviewStatusEnum]; export declare const FlagConfigApprovalRequestResponseStatusEnum: { readonly Pending: "pending"; readonly Completed: "completed"; readonly Failed: "failed"; readonly Scheduled: "scheduled"; }; export type FlagConfigApprovalRequestResponseStatusEnum = typeof FlagConfigApprovalRequestResponseStatusEnum[keyof typeof FlagConfigApprovalRequestResponseStatusEnum]; /** * * @export * @interface FlagConfigApprovalRequestsResponse */ export interface FlagConfigApprovalRequestsResponse { /** * An array of approval requests * @type {Array} * @memberof FlagConfigApprovalRequestsResponse */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagConfigApprovalRequestsResponse */ '_links': { [key: string]: Link; }; } /** * * @export * @interface FlagConfigEvaluation */ export interface FlagConfigEvaluation { /** * * @type {Array} * @memberof FlagConfigEvaluation */ 'contextKinds'?: Array; } /** * * @export * @interface FlagConfigMigrationSettingsRep */ export interface FlagConfigMigrationSettingsRep { /** * * @type {number} * @memberof FlagConfigMigrationSettingsRep */ 'checkRatio'?: number; } /** * * @export * @interface FlagCopyConfigEnvironment */ export interface FlagCopyConfigEnvironment { /** * The environment key * @type {string} * @memberof FlagCopyConfigEnvironment */ 'key': string; /** * Optional flag version. If you include this, the operation only succeeds if the current flag version in the environment matches this version. * @type {number} * @memberof FlagCopyConfigEnvironment */ 'currentVersion'?: number; } /** * * @export * @interface FlagCopyConfigPost */ export interface FlagCopyConfigPost { /** * * @type {FlagCopyConfigEnvironment} * @memberof FlagCopyConfigPost */ 'source': FlagCopyConfigEnvironment; /** * * @type {FlagCopyConfigEnvironment} * @memberof FlagCopyConfigPost */ 'target': FlagCopyConfigEnvironment; /** * Optional comment * @type {string} * @memberof FlagCopyConfigPost */ 'comment'?: string; /** * Optional list of the flag changes to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied. * @type {Array} * @memberof FlagCopyConfigPost */ 'includedActions'?: Array; /** * Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied. * @type {Array} * @memberof FlagCopyConfigPost */ 'excludedActions'?: Array; } export declare const FlagCopyConfigPostIncludedActionsEnum: { readonly UpdateOn: "updateOn"; readonly UpdateRules: "updateRules"; readonly UpdateFallthrough: "updateFallthrough"; readonly UpdateOffVariation: "updateOffVariation"; readonly UpdatePrerequisites: "updatePrerequisites"; readonly UpdateTargets: "updateTargets"; readonly UpdateFlagConfigMigrationSettings: "updateFlagConfigMigrationSettings"; }; export type FlagCopyConfigPostIncludedActionsEnum = typeof FlagCopyConfigPostIncludedActionsEnum[keyof typeof FlagCopyConfigPostIncludedActionsEnum]; export declare const FlagCopyConfigPostExcludedActionsEnum: { readonly UpdateOn: "updateOn"; readonly UpdateRules: "updateRules"; readonly UpdateFallthrough: "updateFallthrough"; readonly UpdateOffVariation: "updateOffVariation"; readonly UpdatePrerequisites: "updatePrerequisites"; readonly UpdateTargets: "updateTargets"; readonly UpdateFlagConfigMigrationSettings: "updateFlagConfigMigrationSettings"; }; export type FlagCopyConfigPostExcludedActionsEnum = typeof FlagCopyConfigPostExcludedActionsEnum[keyof typeof FlagCopyConfigPostExcludedActionsEnum]; /** * * @export * @interface FlagDefaultsRep */ export interface FlagDefaultsRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagDefaultsRep */ '_links'?: { [key: string]: Link; }; /** * A unique key for the flag default * @type {string} * @memberof FlagDefaultsRep */ 'key'?: string; /** * A list of default tags for each flag * @type {Array} * @memberof FlagDefaultsRep */ 'tags'?: Array; /** * Whether the flag should be temporary by default * @type {boolean} * @memberof FlagDefaultsRep */ 'temporary'?: boolean; /** * * @type {ClientSideAvailability} * @memberof FlagDefaultsRep */ 'defaultClientSideAvailability'?: ClientSideAvailability; /** * * @type {BooleanDefaults} * @memberof FlagDefaultsRep */ 'booleanDefaults'?: BooleanDefaults; } /** * * @export * @interface FlagEventCollectionRep */ export interface FlagEventCollectionRep { /** * The total number of flag events * @type {number} * @memberof FlagEventCollectionRep */ 'totalCount': number; /** * A list of flag events * @type {Array} * @memberof FlagEventCollectionRep */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagEventCollectionRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface FlagEventExperiment */ export interface FlagEventExperiment { /** * The experiment key * @type {string} * @memberof FlagEventExperiment */ 'key': string; /** * The experiment name * @type {string} * @memberof FlagEventExperiment */ 'name': string; /** * * @type {FlagEventExperimentIteration} * @memberof FlagEventExperiment */ 'iteration': FlagEventExperimentIteration; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagEventExperiment */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface FlagEventExperimentCollection */ export interface FlagEventExperimentCollection { /** * The total number of experiments * @type {number} * @memberof FlagEventExperimentCollection */ 'totalCount': number; /** * A list of experiments * @type {Array} * @memberof FlagEventExperimentCollection */ 'items': Array; } /** * * @export * @interface FlagEventExperimentIteration */ export interface FlagEventExperimentIteration { /** * The experiment iteration ID * @type {string} * @memberof FlagEventExperimentIteration */ 'id': string; /** * * @type {string} * @memberof FlagEventExperimentIteration */ 'status': string; /** * * @type {number} * @memberof FlagEventExperimentIteration */ 'startedAt': number; /** * * @type {number} * @memberof FlagEventExperimentIteration */ 'endedAt'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagEventExperimentIteration */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface FlagEventImpactRep */ export interface FlagEventImpactRep { /** * The size of the flag event impact. Sizes are defined as: none (0%), small (0-20%), medium (20-80%), large (>80%) * @type {string} * @memberof FlagEventImpactRep */ 'size'?: FlagEventImpactRepSizeEnum; /** * The percentage of the flag event impact * @type {number} * @memberof FlagEventImpactRep */ 'percentage'?: number; /** * * @type {string} * @memberof FlagEventImpactRep */ 'reason'?: string; /** * * @type {EvaluationsSummary} * @memberof FlagEventImpactRep */ 'evaluationsSummary'?: EvaluationsSummary; } export declare const FlagEventImpactRepSizeEnum: { readonly None: "none"; readonly Small: "small"; readonly Medium: "medium"; readonly Large: "large"; }; export type FlagEventImpactRepSizeEnum = typeof FlagEventImpactRepSizeEnum[keyof typeof FlagEventImpactRepSizeEnum]; /** * * @export * @interface FlagEventMemberRep */ export interface FlagEventMemberRep { /** * The member ID * @type {string} * @memberof FlagEventMemberRep */ 'id': string; /** * The member email * @type {string} * @memberof FlagEventMemberRep */ 'email': string; /** * The member first name * @type {string} * @memberof FlagEventMemberRep */ 'firstName': string; /** * The member last name * @type {string} * @memberof FlagEventMemberRep */ 'lastName': string; } /** * * @export * @interface FlagEventRep */ export interface FlagEventRep { /** * The flag event ID * @type {string} * @memberof FlagEventRep */ 'id': string; /** * The project ID * @type {string} * @memberof FlagEventRep */ 'projectId': string; /** * The project key * @type {string} * @memberof FlagEventRep */ 'projectKey': string; /** * The environment ID * @type {string} * @memberof FlagEventRep */ 'environmentId'?: string; /** * The environment key * @type {string} * @memberof FlagEventRep */ 'environmentKey'?: string; /** * The flag key * @type {string} * @memberof FlagEventRep */ 'flagKey': string; /** * * @type {string} * @memberof FlagEventRep */ 'eventType': string; /** * * @type {number} * @memberof FlagEventRep */ 'eventTime': number; /** * The event description * @type {string} * @memberof FlagEventRep */ 'description': string; /** * The audit log entry ID * @type {string} * @memberof FlagEventRep */ 'auditLogEntryId'?: string; /** * * @type {FlagEventMemberRep} * @memberof FlagEventRep */ 'member'?: FlagEventMemberRep; /** * The resource actions * @type {Array} * @memberof FlagEventRep */ 'actions'?: Array; /** * * @type {FlagEventImpactRep} * @memberof FlagEventRep */ 'impact': FlagEventImpactRep; /** * * @type {FlagEventExperimentCollection} * @memberof FlagEventRep */ 'experiments'?: FlagEventExperimentCollection; } /** * * @export * @interface FlagFollowersByProjEnvGetRep */ export interface FlagFollowersByProjEnvGetRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagFollowersByProjEnvGetRep */ '_links': { [key: string]: Link; }; /** * An array of flags and their followers * @type {Array} * @memberof FlagFollowersByProjEnvGetRep */ 'items'?: Array; } /** * * @export * @interface FlagFollowersGetRep */ export interface FlagFollowersGetRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagFollowersGetRep */ '_links': { [key: string]: Link; }; /** * An array of members who are following this flag * @type {Array} * @memberof FlagFollowersGetRep */ 'items': Array; } /** * * @export * @interface FlagImportConfigurationPost */ export interface FlagImportConfigurationPost { /** * * @type {{ [key: string]: any; }} * @memberof FlagImportConfigurationPost */ 'config': { [key: string]: any; }; /** * Tags to associate with the configuration * @type {Array} * @memberof FlagImportConfigurationPost */ 'tags'?: Array; /** * Name to identify the configuration * @type {string} * @memberof FlagImportConfigurationPost */ 'name'?: string; } /** * * @export * @interface FlagImportIntegration */ export interface FlagImportIntegration { /** * * @type {FlagImportIntegrationLinks} * @memberof FlagImportIntegration */ '_links': FlagImportIntegrationLinks; /** * The integration ID * @type {string} * @memberof FlagImportIntegration */ '_id': string; /** * The integration key * @type {string} * @memberof FlagImportIntegration */ 'integrationKey': FlagImportIntegrationIntegrationKeyEnum; /** * The project key * @type {string} * @memberof FlagImportIntegration */ 'projectKey': string; /** * * @type {{ [key: string]: any; }} * @memberof FlagImportIntegration */ 'config': { [key: string]: any; }; /** * List of tags for this configuration * @type {Array} * @memberof FlagImportIntegration */ 'tags': Array; /** * Name of the configuration * @type {string} * @memberof FlagImportIntegration */ 'name': string; /** * Version of the current configuration * @type {number} * @memberof FlagImportIntegration */ 'version': number; /** * * @type {Access} * @memberof FlagImportIntegration */ '_access'?: Access; /** * * @type {FlagImportStatus} * @memberof FlagImportIntegration */ '_status': FlagImportStatus; } export declare const FlagImportIntegrationIntegrationKeyEnum: { readonly Split: "split"; readonly Unleash: "unleash"; }; export type FlagImportIntegrationIntegrationKeyEnum = typeof FlagImportIntegrationIntegrationKeyEnum[keyof typeof FlagImportIntegrationIntegrationKeyEnum]; /** * * @export * @interface FlagImportIntegrationCollection */ export interface FlagImportIntegrationCollection { /** * * @type {FlagImportIntegrationCollectionLinks} * @memberof FlagImportIntegrationCollection */ '_links': FlagImportIntegrationCollectionLinks; /** * An array of flag import configurations * @type {Array} * @memberof FlagImportIntegrationCollection */ 'items': Array; } /** * * @export * @interface FlagImportIntegrationCollectionLinks */ export interface FlagImportIntegrationCollectionLinks { /** * * @type {Link} * @memberof FlagImportIntegrationCollectionLinks */ 'self': Link; /** * * @type {Link} * @memberof FlagImportIntegrationCollectionLinks */ 'parent'?: Link; } /** * * @export * @interface FlagImportIntegrationLinks */ export interface FlagImportIntegrationLinks { /** * * @type {Link} * @memberof FlagImportIntegrationLinks */ 'self': Link; /** * * @type {Link} * @memberof FlagImportIntegrationLinks */ 'parent': Link; /** * * @type {Link} * @memberof FlagImportIntegrationLinks */ 'project': Link; } /** * * @export * @interface FlagImportStatus */ export interface FlagImportStatus { /** * The current status of the import integrations related import job * @type {string} * @memberof FlagImportStatus */ 'status'?: FlagImportStatusStatusEnum; /** * * @type {number} * @memberof FlagImportStatus */ 'lastImport'?: number; /** * * @type {number} * @memberof FlagImportStatus */ 'lastError'?: number; /** * * @type {Array} * @memberof FlagImportStatus */ 'errors'?: Array; } export declare const FlagImportStatusStatusEnum: { readonly Complete: "complete"; readonly Importing: "importing"; readonly Pending: "pending"; readonly Failed: "failed"; readonly Partial: "partial"; }; export type FlagImportStatusStatusEnum = typeof FlagImportStatusStatusEnum[keyof typeof FlagImportStatusStatusEnum]; /** * * @export * @interface FlagInput */ export interface FlagInput { /** * The ID of the variation or rollout of the flag to use. Use \"fallthrough\" for the default targeting behavior when the flag is on. * @type {string} * @memberof FlagInput */ 'ruleId': string; /** * The flag version * @type {number} * @memberof FlagInput */ 'flagConfigVersion': number; /** * The ID of the variation to route traffic not part of the experiment analysis to. Defaults to variation ID of baseline treatment, if set. * @type {string} * @memberof FlagInput */ 'notInExperimentVariationId'?: string; } /** * * @export * @interface FlagLinkCollectionRep */ export interface FlagLinkCollectionRep { /** * An array of flag links * @type {Array} * @memberof FlagLinkCollectionRep */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagLinkCollectionRep */ '_links': { [key: string]: Link; }; } /** * * @export * @interface FlagLinkMember */ export interface FlagLinkMember { /** * * @type {{ [key: string]: Link; }} * @memberof FlagLinkMember */ '_links': { [key: string]: Link; }; /** * * @type {string} * @memberof FlagLinkMember */ '_id': string; /** * * @type {string} * @memberof FlagLinkMember */ 'firstName'?: string; /** * * @type {string} * @memberof FlagLinkMember */ 'lastName'?: string; } /** * * @export * @interface FlagLinkPost */ export interface FlagLinkPost { /** * The flag link key * @type {string} * @memberof FlagLinkPost */ 'key'?: string; /** * The integration key for an integration whose manifest.json includes the flagLink capability, if this is a flag link for an existing integration. Do not include for URL flag links. * @type {string} * @memberof FlagLinkPost */ 'integrationKey'?: string; /** * * @type {number} * @memberof FlagLinkPost */ 'timestamp'?: number; /** * The URL for the external resource you are linking the flag to * @type {string} * @memberof FlagLinkPost */ 'deepLink'?: string; /** * The title of the flag link * @type {string} * @memberof FlagLinkPost */ 'title'?: string; /** * The description of the flag link * @type {string} * @memberof FlagLinkPost */ 'description'?: string; /** * The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration\'s manifest.json file under flagLink. * @type {{ [key: string]: string; }} * @memberof FlagLinkPost */ 'metadata'?: { [key: string]: string; }; } /** * * @export * @interface FlagLinkRep */ export interface FlagLinkRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagLinkRep */ '_links': { [key: string]: Link; }; /** * The flag link key * @type {string} * @memberof FlagLinkRep */ '_key'?: string; /** * The integration key for an integration whose manifest.json includes the flagLink capability, if this is a flag link for an existing integration * @type {string} * @memberof FlagLinkRep */ '_integrationKey'?: string; /** * The ID of this flag link * @type {string} * @memberof FlagLinkRep */ '_id': string; /** * The URL for the external resource the flag is linked to * @type {string} * @memberof FlagLinkRep */ '_deepLink': string; /** * * @type {TimestampRep} * @memberof FlagLinkRep */ '_timestamp': TimestampRep; /** * The title of the flag link * @type {string} * @memberof FlagLinkRep */ 'title'?: string; /** * The description of the flag link * @type {string} * @memberof FlagLinkRep */ 'description'?: string; /** * The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration\'s manifest.json file under flagLink. * @type {{ [key: string]: string; }} * @memberof FlagLinkRep */ '_metadata'?: { [key: string]: string; }; /** * * @type {number} * @memberof FlagLinkRep */ '_createdAt': number; /** * * @type {FlagLinkMember} * @memberof FlagLinkRep */ '_member'?: FlagLinkMember; } /** * * @export * @interface FlagListingRep */ export interface FlagListingRep { /** * The flag name * @type {string} * @memberof FlagListingRep */ 'name': string; /** * The flag key * @type {string} * @memberof FlagListingRep */ 'key': string; /** * * @type {{ [key: string]: Link; }} * @memberof FlagListingRep */ '_links'?: { [key: string]: Link; }; /** * * @type {Link} * @memberof FlagListingRep */ '_site'?: Link; } /** * * @export * @interface FlagMigrationSettingsRep */ export interface FlagMigrationSettingsRep { /** * The context kind targeted by this migration flag. Only applicable for six-stage migrations. * @type {string} * @memberof FlagMigrationSettingsRep */ 'contextKind'?: string; /** * The number of stages for this migration flag * @type {number} * @memberof FlagMigrationSettingsRep */ 'stageCount'?: number; } /** * * @export * @interface FlagPrerequisitePost */ export interface FlagPrerequisitePost { /** * Flag key of the prerequisite flag * @type {string} * @memberof FlagPrerequisitePost */ 'key': string; /** * ID of a variation of the prerequisite flag * @type {string} * @memberof FlagPrerequisitePost */ 'variationId': string; } /** * * @export * @interface FlagReferenceCollectionRep */ export interface FlagReferenceCollectionRep { /** * The total number of flag references * @type {number} * @memberof FlagReferenceCollectionRep */ 'totalCount': number; /** * A list of flag references * @type {Array} * @memberof FlagReferenceCollectionRep */ 'items': Array; } /** * * @export * @interface FlagReferenceRep */ export interface FlagReferenceRep { /** * The project key * @type {string} * @memberof FlagReferenceRep */ 'projectKey': string; /** * The flag key * @type {string} * @memberof FlagReferenceRep */ 'flagKey': string; /** * The number of references added * @type {number} * @memberof FlagReferenceRep */ 'referencesAdded': number; /** * The number of references removed * @type {number} * @memberof FlagReferenceRep */ 'referencesRemoved': number; } /** * * @export * @interface FlagRep */ export interface FlagRep { /** * The targeting rule * @type {string} * @memberof FlagRep */ 'targetingRule'?: string; /** * The rule description * @type {string} * @memberof FlagRep */ 'targetingRuleDescription'?: string; /** * An array of clauses used for individual targeting based on attributes * @type {Array} * @memberof FlagRep */ 'targetingRuleClauses'?: Array; /** * The flag version * @type {number} * @memberof FlagRep */ 'flagConfigVersion'?: number; /** * The ID of the variation to route traffic not part of the experiment analysis to * @type {string} * @memberof FlagRep */ 'notInExperimentVariationId'?: string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FlagRep */ '_links': { [key: string]: Link; }; } /** * * @export * @interface FlagScheduledChangesInput */ export interface FlagScheduledChangesInput { /** * Optional comment describing the update to the scheduled changes * @type {string} * @memberof FlagScheduledChangesInput */ 'comment'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof FlagScheduledChangesInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface FlagSempatch */ export interface FlagSempatch { /** * * @type {Array<{ [key: string]: any; }>} * @memberof FlagSempatch */ 'instructions': Array<{ [key: string]: any; }>; /** * * @type {string} * @memberof FlagSempatch */ 'comment'?: string; } /** * * @export * @interface FlagStatusRep */ export interface FlagStatusRep { /** * Status of the flag * @type {string} * @memberof FlagStatusRep */ 'name': FlagStatusRepNameEnum; /** * Timestamp of last time flag was requested * @type {string} * @memberof FlagStatusRep */ 'lastRequested'?: string; /** * Default value seen from code * @type {any} * @memberof FlagStatusRep */ 'default'?: any; /** * * @type {{ [key: string]: Link; }} * @memberof FlagStatusRep */ '_links': { [key: string]: Link; }; } export declare const FlagStatusRepNameEnum: { readonly New: "new"; readonly Inactive: "inactive"; readonly Active: "active"; readonly Launched: "launched"; }; export type FlagStatusRepNameEnum = typeof FlagStatusRepNameEnum[keyof typeof FlagStatusRepNameEnum]; /** * * @export * @interface FlagSummary */ export interface FlagSummary { /** * * @type {{ [key: string]: VariationSummary; }} * @memberof FlagSummary */ 'variations': { [key: string]: VariationSummary; }; /** * The number of prerequisites for this flag * @type {number} * @memberof FlagSummary */ 'prerequisites': number; } /** * * @export * @interface FlagTriggerInput */ export interface FlagTriggerInput { /** * Optional comment describing the update * @type {string} * @memberof FlagTriggerInput */ 'comment'?: string; /** * The instructions to perform when updating. This should be an array with objects that look like {\"kind\": \"trigger_action\"}. * @type {Array<{ [key: string]: any; }>} * @memberof FlagTriggerInput */ 'instructions'?: Array<{ [key: string]: any; }>; } /** * * @export * @interface FollowFlagMember */ export interface FollowFlagMember { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof FollowFlagMember */ '_links': { [key: string]: Link; }; /** * The member\'s ID * @type {string} * @memberof FollowFlagMember */ '_id': string; /** * The member\'s first name * @type {string} * @memberof FollowFlagMember */ 'firstName'?: string; /** * The member\'s last name * @type {string} * @memberof FollowFlagMember */ 'lastName'?: string; /** * The member\'s built-in role. If the member has no custom roles, this role will be in effect. * @type {string} * @memberof FollowFlagMember */ 'role': string; /** * The member\'s email address * @type {string} * @memberof FollowFlagMember */ 'email': string; } /** * * @export * @interface FollowersPerFlag */ export interface FollowersPerFlag { /** * The flag key * @type {string} * @memberof FollowersPerFlag */ 'flagKey'?: string; /** * A list of members who are following this flag * @type {Array} * @memberof FollowersPerFlag */ 'followers'?: Array; } /** * * @export * @interface ForbiddenErrorRep */ export interface ForbiddenErrorRep { /** * Specific error code encountered * @type {string} * @memberof ForbiddenErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof ForbiddenErrorRep */ 'message': string; } /** * * @export * @interface FormVariable */ export interface FormVariable { /** * * @type {string} * @memberof FormVariable */ 'key'?: string; /** * * @type {string} * @memberof FormVariable */ 'name'?: string; /** * * @type {string} * @memberof FormVariable */ 'type'?: string; /** * * @type {string} * @memberof FormVariable */ 'description'?: string; /** * * @type {string} * @memberof FormVariable */ 'placeholder'?: string; /** * * @type {boolean} * @memberof FormVariable */ 'isOptional'?: boolean; /** * * @type {any} * @memberof FormVariable */ 'defaultValue'?: any; /** * * @type {Array} * @memberof FormVariable */ 'allowedValues'?: Array; /** * * @type {DynamicOptions} * @memberof FormVariable */ 'dynamicOptions'?: DynamicOptions; } /** * * @export * @interface GenerateWarehouseDestinationKeyPairPostRep */ export interface GenerateWarehouseDestinationKeyPairPostRep { /** * The public key used by LaunchDarkly * @type {string} * @memberof GenerateWarehouseDestinationKeyPairPostRep */ 'public_key'?: string; /** * The public key to assign in your Snowflake worksheet * @type {string} * @memberof GenerateWarehouseDestinationKeyPairPostRep */ 'public_key_pkcs8'?: string; } /** * * @export * @interface GetAnnouncementsPublic200Response */ export interface GetAnnouncementsPublic200Response { /** * * @type {Array} * @memberof GetAnnouncementsPublic200Response */ 'items': Array; /** * * @type {AnnouncementPaginatedLinks} * @memberof GetAnnouncementsPublic200Response */ '_links': AnnouncementPaginatedLinks; } /** * * @export * @interface HMACSignature */ export interface HMACSignature { /** * * @type {string} * @memberof HMACSignature */ 'headerName'?: string; /** * * @type {string} * @memberof HMACSignature */ 'hmacSecretFormVariableKey'?: string; } /** * * @export * @interface HeaderItems */ export interface HeaderItems { /** * * @type {string} * @memberof HeaderItems */ 'name'?: string; /** * * @type {string} * @memberof HeaderItems */ 'value'?: string; } /** * * @export * @interface HoldoutDetailRep */ export interface HoldoutDetailRep { /** * * @type {string} * @memberof HoldoutDetailRep */ '_id': string; /** * * @type {string} * @memberof HoldoutDetailRep */ 'status': HoldoutDetailRepStatusEnum; /** * * @type {string} * @memberof HoldoutDetailRep */ 'description'?: string; /** * The percentage of traffic allocated to this holdout. * @type {string} * @memberof HoldoutDetailRep */ 'holdoutAmount': string; /** * Indicates if the holdout experiment is running and if any related experiments are running. * @type {boolean} * @memberof HoldoutDetailRep */ 'isDirty'?: boolean; /** * * @type {number} * @memberof HoldoutDetailRep */ 'createdAt': number; /** * * @type {number} * @memberof HoldoutDetailRep */ 'updatedAt': number; /** * * @type {Experiment} * @memberof HoldoutDetailRep */ 'baseExperiment': Experiment; /** * * @type {Array} * @memberof HoldoutDetailRep */ 'relatedExperiments'?: Array; } export declare const HoldoutDetailRepStatusEnum: { readonly Created: "created"; readonly Enabled: "enabled"; readonly Running: "running"; readonly Ended: "ended"; }; export type HoldoutDetailRepStatusEnum = typeof HoldoutDetailRepStatusEnum[keyof typeof HoldoutDetailRepStatusEnum]; /** * * @export * @interface HoldoutPatchInput */ export interface HoldoutPatchInput { /** * Optional comment describing the update * @type {string} * @memberof HoldoutPatchInput */ 'comment'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof HoldoutPatchInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface HoldoutPostRequest */ export interface HoldoutPostRequest { /** * A human-friendly name for the holdout * @type {string} * @memberof HoldoutPostRequest */ 'name'?: string; /** * A key that identifies the holdout * @type {string} * @memberof HoldoutPostRequest */ 'key'?: string; /** * Description of the holdout * @type {string} * @memberof HoldoutPostRequest */ 'description'?: string; /** * The chosen randomization unit for the holdout base experiment * @type {string} * @memberof HoldoutPostRequest */ 'randomizationunit'?: string; /** * The attributes that the holdout iteration\'s results can be sliced by * @type {Array} * @memberof HoldoutPostRequest */ 'attributes'?: Array; /** * Audience allocation for the holdout * @type {string} * @memberof HoldoutPostRequest */ 'holdoutamount'?: string; /** * The key of the primary metric for this holdout * @type {string} * @memberof HoldoutPostRequest */ 'primarymetrickey'?: string; /** * Details on the metrics for this experiment * @type {Array} * @memberof HoldoutPostRequest */ 'metrics'?: Array; /** * The key of the flag that the holdout is dependent on * @type {string} * @memberof HoldoutPostRequest */ 'prerequisiteflagkey'?: string; /** * Maintainer id * @type {string} * @memberof HoldoutPostRequest */ 'maintainerId'?: string; } /** * * @export * @interface HoldoutRep */ export interface HoldoutRep { /** * * @type {string} * @memberof HoldoutRep */ '_id': string; /** * * @type {string} * @memberof HoldoutRep */ 'status': HoldoutRepStatusEnum; /** * * @type {string} * @memberof HoldoutRep */ 'description'?: string; /** * The percentage of traffic allocated to this holdout. * @type {string} * @memberof HoldoutRep */ 'holdoutAmount': string; /** * * @type {number} * @memberof HoldoutRep */ 'createdAt': number; /** * * @type {number} * @memberof HoldoutRep */ 'updatedAt': number; /** * * @type {Experiment} * @memberof HoldoutRep */ 'baseExperiment': Experiment; /** * * @type {Array} * @memberof HoldoutRep */ 'experiments'?: Array; } export declare const HoldoutRepStatusEnum: { readonly Created: "created"; readonly Enabled: "enabled"; readonly Running: "running"; readonly Ended: "ended"; }; export type HoldoutRepStatusEnum = typeof HoldoutRepStatusEnum[keyof typeof HoldoutRepStatusEnum]; /** * * @export * @interface HoldoutsCollectionRep */ export interface HoldoutsCollectionRep { /** * * @type {Array} * @memberof HoldoutsCollectionRep */ 'items'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof HoldoutsCollectionRep */ '_links'?: { [key: string]: Link; }; /** * The total number of holdouts in this project and environment. * @type {number} * @memberof HoldoutsCollectionRep */ 'total_count'?: number; } /** * * @export * @interface HunkRep */ export interface HunkRep { /** * Line number of beginning of code reference hunk * @type {number} * @memberof HunkRep */ 'startingLineNumber': number; /** * Contextual lines of code that include the referenced feature flag * @type {string} * @memberof HunkRep */ 'lines'?: string; /** * The project key * @type {string} * @memberof HunkRep */ 'projKey'?: string; /** * The feature flag key * @type {string} * @memberof HunkRep */ 'flagKey'?: string; /** * An array of flag key aliases * @type {Array} * @memberof HunkRep */ 'aliases'?: Array; } /** * * @export * @interface Import */ export interface Import { /** * The import ID * @type {string} * @memberof Import */ 'id': string; /** * The segment key * @type {string} * @memberof Import */ 'segmentKey': string; /** * * @type {number} * @memberof Import */ 'creationTime': number; /** * The import mode used, either merge or replace * @type {string} * @memberof Import */ 'mode': string; /** * The import status * @type {string} * @memberof Import */ 'status': ImportStatusEnum; /** * The imported files and their status * @type {Array} * @memberof Import */ 'files'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Import */ '_links': { [key: string]: Link; }; } export declare const ImportStatusEnum: { readonly Preparing: "preparing"; readonly PendingApproval: "pending_approval"; readonly Ready: "ready"; readonly InProgress: "in_progress"; readonly Complete: "complete"; readonly Stopped: "stopped"; }; export type ImportStatusEnum = typeof ImportStatusEnum[keyof typeof ImportStatusEnum]; /** * * @export * @interface InitiatorRep */ export interface InitiatorRep { /** * The name of the member who initiated the export * @type {string} * @memberof InitiatorRep */ 'name'?: string; /** * The email address of the member who initiated the export * @type {string} * @memberof InitiatorRep */ 'email'?: string; } /** * * @export * @interface InsightGroup */ export interface InsightGroup { /** * * @type {Environment} * @memberof InsightGroup */ 'environment'?: Environment; /** * * @type {InsightGroupScores} * @memberof InsightGroup */ 'scores'?: InsightGroupScores; /** * * @type {InsightGroupCollectionScoreMetadata} * @memberof InsightGroup */ 'scoreMetadata'?: InsightGroupCollectionScoreMetadata; /** * The insight group key * @type {string} * @memberof InsightGroup */ 'key': string; /** * The insight group name * @type {string} * @memberof InsightGroup */ 'name': string; /** * The project key * @type {string} * @memberof InsightGroup */ 'projectKey': string; /** * The environment key * @type {string} * @memberof InsightGroup */ 'environmentKey': string; /** * The application keys * @type {Array} * @memberof InsightGroup */ 'applicationKeys'?: Array; /** * * @type {number} * @memberof InsightGroup */ 'createdAt': number; } /** * * @export * @interface InsightGroupCollection */ export interface InsightGroupCollection { /** * The total number of insight groups * @type {number} * @memberof InsightGroupCollection */ 'totalCount': number; /** * A list of insight groups * @type {Array} * @memberof InsightGroupCollection */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof InsightGroupCollection */ '_links'?: { [key: string]: Link; }; /** * * @type {InsightGroupCollectionMetadata} * @memberof InsightGroupCollection */ 'metadata'?: InsightGroupCollectionMetadata; /** * * @type {InsightGroupCollectionScoreMetadata} * @memberof InsightGroupCollection */ 'scoreMetadata'?: InsightGroupCollectionScoreMetadata; } /** * * @export * @interface InsightGroupCollectionMetadata */ export interface InsightGroupCollectionMetadata { /** * * @type {InsightGroupsCountByIndicator} * @memberof InsightGroupCollectionMetadata */ 'countByIndicator': InsightGroupsCountByIndicator; } /** * * @export * @interface InsightGroupCollectionScoreMetadata */ export interface InsightGroupCollectionScoreMetadata { /** * * @type {InsightPeriod} * @memberof InsightGroupCollectionScoreMetadata */ 'period': InsightPeriod; /** * * @type {InsightPeriod} * @memberof InsightGroupCollectionScoreMetadata */ 'lastPeriod': InsightPeriod; } /** * * @export * @interface InsightGroupScores */ export interface InsightGroupScores { /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'overall': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'deploymentFrequency': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'deploymentFailureRate': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'leadTime': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'impactSize': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'experimentationCoverage': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'flagHealth': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'velocity': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'risk': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'efficiency': InsightsMetricScore; /** * * @type {InsightsMetricScore} * @memberof InsightGroupScores */ 'creationRatio'?: InsightsMetricScore; } /** * * @export * @interface InsightGroupsCountByIndicator */ export interface InsightGroupsCountByIndicator { /** * The number of insight groups with an excellent indicator * @type {number} * @memberof InsightGroupsCountByIndicator */ 'excellent': number; /** * The number of insight groups with a good indicator * @type {number} * @memberof InsightGroupsCountByIndicator */ 'good': number; /** * The number of insight groups with a fair indicator * @type {number} * @memberof InsightGroupsCountByIndicator */ 'fair': number; /** * The number of insight groups with a needs attention indicator * @type {number} * @memberof InsightGroupsCountByIndicator */ 'needsAttention': number; /** * The number of insight groups with a not calculated indicator * @type {number} * @memberof InsightGroupsCountByIndicator */ 'notCalculated': number; /** * The number of insight groups with an unknown indicator * @type {number} * @memberof InsightGroupsCountByIndicator */ 'unknown': number; /** * The total number of insight groups * @type {number} * @memberof InsightGroupsCountByIndicator */ 'total': number; } /** * * @export * @interface InsightPeriod */ export interface InsightPeriod { /** * * @type {number} * @memberof InsightPeriod */ 'startTime': number; /** * * @type {number} * @memberof InsightPeriod */ 'endTime': number; } /** * * @export * @interface InsightScores */ export interface InsightScores { /** * * @type {InsightPeriod} * @memberof InsightScores */ 'period': InsightPeriod; /** * * @type {InsightPeriod} * @memberof InsightScores */ 'lastPeriod': InsightPeriod; /** * * @type {InsightGroupScores} * @memberof InsightScores */ 'scores': InsightGroupScores; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof InsightScores */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface InsightsChart */ export interface InsightsChart { /** * * @type {InsightsChartMetadata} * @memberof InsightsChart */ 'metadata': InsightsChartMetadata; /** * Series data for the chart * @type {Array} * @memberof InsightsChart */ 'series': Array; } /** * * @export * @interface InsightsChartBounds */ export interface InsightsChartBounds { /** * Name of the bound * @type {string} * @memberof InsightsChartBounds */ 'name': string; /** * Value of the bound * @type {number} * @memberof InsightsChartBounds */ 'value': number; } /** * * @export * @interface InsightsChartMetadata */ export interface InsightsChartMetadata { /** * * @type {{ [key: string]: any; }} * @memberof InsightsChartMetadata */ 'summary': { [key: string]: any; }; /** * Name of the chart * @type {string} * @memberof InsightsChartMetadata */ 'name'?: string; /** * * @type {{ [key: string]: InsightsChartMetric; }} * @memberof InsightsChartMetadata */ 'metrics'?: { [key: string]: InsightsChartMetric; }; /** * * @type {InsightsChartSeriesMetadataAxis} * @memberof InsightsChartMetadata */ 'xAxis': InsightsChartSeriesMetadataAxis; /** * * @type {InsightsChartSeriesMetadataAxis} * @memberof InsightsChartMetadata */ 'yAxis': InsightsChartSeriesMetadataAxis; } /** * * @export * @interface InsightsChartMetric */ export interface InsightsChartMetric { /** * Metric indicator tier * @type {string} * @memberof InsightsChartMetric */ 'indicator': string; /** * Metric value * @type {number} * @memberof InsightsChartMetric */ 'value': number; /** * Metric unit * @type {string} * @memberof InsightsChartMetric */ 'unit': string; /** * Metric modifier * @type {string} * @memberof InsightsChartMetric */ 'modifier': string; /** * Metric indicator tiers * @type {Array} * @memberof InsightsChartMetric */ 'tiers': Array; } /** * * @export * @interface InsightsChartSeries */ export interface InsightsChartSeries { /** * * @type {InsightsChartSeriesMetadata} * @memberof InsightsChartSeries */ 'metadata': InsightsChartSeriesMetadata; /** * Data points for the series * @type {Array} * @memberof InsightsChartSeries */ 'data': Array; } /** * * @export * @interface InsightsChartSeriesDataPoint */ export interface InsightsChartSeriesDataPoint { /** * X-axis value * @type {number} * @memberof InsightsChartSeriesDataPoint */ 'x': number; /** * Y-axis value * @type {number} * @memberof InsightsChartSeriesDataPoint */ 'y': number; /** * Additional values for the data point * @type {{ [key: string]: any; }} * @memberof InsightsChartSeriesDataPoint */ 'values'?: { [key: string]: any; }; } /** * * @export * @interface InsightsChartSeriesMetadata */ export interface InsightsChartSeriesMetadata { /** * Name of the series * @type {string} * @memberof InsightsChartSeriesMetadata */ 'name': string; /** * Aggregate count of the series values * @type {number} * @memberof InsightsChartSeriesMetadata */ 'count'?: number; /** * Bounds for the series data * @type {Array} * @memberof InsightsChartSeriesMetadata */ 'bounds'?: Array; } /** * * @export * @interface InsightsChartSeriesMetadataAxis */ export interface InsightsChartSeriesMetadataAxis { /** * Unit of the axis * @type {string} * @memberof InsightsChartSeriesMetadataAxis */ 'unit': string; } /** * * @export * @interface InsightsMetricIndicatorRange */ export interface InsightsMetricIndicatorRange { /** * The minimum value for the indicator range * @type {number} * @memberof InsightsMetricIndicatorRange */ 'min': number; /** * The maximum value for the indicator range * @type {number} * @memberof InsightsMetricIndicatorRange */ 'max': number; } /** * * @export * @interface InsightsMetricScore */ export interface InsightsMetricScore { /** * The score for the metric * @type {number} * @memberof InsightsMetricScore */ 'score': number; /** * The keys of the metrics that were aggregated to calculate this score * @type {Array} * @memberof InsightsMetricScore */ 'aggregateOf'?: Array; /** * * @type {number} * @memberof InsightsMetricScore */ 'diffVsLastPeriod'?: number; /** * * @type {string} * @memberof InsightsMetricScore */ 'indicator': string; /** * * @type {InsightsMetricIndicatorRange} * @memberof InsightsMetricScore */ 'indicatorRange': InsightsMetricIndicatorRange; /** * * @type {InsightsMetricScore} * @memberof InsightsMetricScore */ 'lastPeriod'?: InsightsMetricScore; } /** * * @export * @interface InsightsMetricTierDefinition */ export interface InsightsMetricTierDefinition { /** * Metric indicator tier * @type {string} * @memberof InsightsMetricTierDefinition */ 'indicator': string; /** * Metric indicator description * @type {string} * @memberof InsightsMetricTierDefinition */ 'description': string; } /** * * @export * @interface InsightsRepository */ export interface InsightsRepository { /** * The repository ID * @type {string} * @memberof InsightsRepository */ '_id': string; /** * The repository version * @type {number} * @memberof InsightsRepository */ 'version': number; /** * The repository key * @type {string} * @memberof InsightsRepository */ 'key': string; /** * The repository type * @type {string} * @memberof InsightsRepository */ 'type': string; /** * The repository URL * @type {string} * @memberof InsightsRepository */ 'url': string; /** * The repository main branch * @type {string} * @memberof InsightsRepository */ 'mainBranch': string; /** * * @type {ProjectSummaryCollection} * @memberof InsightsRepository */ 'projects'?: ProjectSummaryCollection; } /** * * @export * @interface InsightsRepositoryCollection */ export interface InsightsRepositoryCollection { /** * Total number of repositories * @type {number} * @memberof InsightsRepositoryCollection */ 'totalCount': number; /** * List of repositories * @type {Array} * @memberof InsightsRepositoryCollection */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof InsightsRepositoryCollection */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface InsightsRepositoryProject */ export interface InsightsRepositoryProject { /** * The repository key * @type {string} * @memberof InsightsRepositoryProject */ 'repositoryKey': string; /** * The project key * @type {string} * @memberof InsightsRepositoryProject */ 'projectKey': string; } /** * * @export * @interface InsightsRepositoryProjectCollection */ export interface InsightsRepositoryProjectCollection { /** * Total number of repository project associations * @type {number} * @memberof InsightsRepositoryProjectCollection */ 'totalCount': number; /** * List of repository project associations * @type {Array} * @memberof InsightsRepositoryProjectCollection */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof InsightsRepositoryProjectCollection */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface InsightsRepositoryProjectMappings */ export interface InsightsRepositoryProjectMappings { /** * * @type {Array} * @memberof InsightsRepositoryProjectMappings */ 'mappings': Array; } /** * * @export * @interface InstructionUserRequest */ export interface InstructionUserRequest { /** * The type of change to make to the removal date for this user from individual targeting for this flag. * @type {string} * @memberof InstructionUserRequest */ 'kind': InstructionUserRequestKindEnum; /** * The flag key * @type {string} * @memberof InstructionUserRequest */ 'flagKey': string; /** * ID of a variation on the flag * @type {string} * @memberof InstructionUserRequest */ 'variationId': string; /** * The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. Required if kind is addExpireUserTargetDate or updateExpireUserTargetDate. * @type {number} * @memberof InstructionUserRequest */ 'value'?: number; /** * The version of the expiring user target to update. Optional and only used if kind is updateExpireUserTargetDate. If included, update will fail if version doesn\'t match current version of the expiring user target. * @type {number} * @memberof InstructionUserRequest */ 'version'?: number; } export declare const InstructionUserRequestKindEnum: { readonly AddExpireUserTargetDate: "addExpireUserTargetDate"; readonly UpdateExpireUserTargetDate: "updateExpireUserTargetDate"; readonly RemoveExpireUserTargetDate: "removeExpireUserTargetDate"; }; export type InstructionUserRequestKindEnum = typeof InstructionUserRequestKindEnum[keyof typeof InstructionUserRequestKindEnum]; /** * * @export * @interface Integration */ export interface Integration { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Integration */ '_links'?: { [key: string]: Link; }; /** * The ID for this integration audit log subscription * @type {string} * @memberof Integration */ '_id'?: string; /** * The type of integration * @type {string} * @memberof Integration */ 'kind'?: string; /** * A human-friendly name for the integration * @type {string} * @memberof Integration */ 'name'?: string; /** * Details on configuration for an integration of this type. Refer to the formVariables field in the corresponding manifest.json for a full list of fields for each integration. * @type {{ [key: string]: any; }} * @memberof Integration */ 'config'?: { [key: string]: any; }; /** * Represents a Custom role policy, defining a resource kinds filter the integration audit log subscription responds to. * @type {Array} * @memberof Integration */ 'statements'?: Array; /** * Whether the integration is currently active * @type {boolean} * @memberof Integration */ 'on'?: boolean; /** * An array of tags for this integration * @type {Array} * @memberof Integration */ 'tags'?: Array; /** * * @type {Access} * @memberof Integration */ '_access'?: Access; /** * * @type {IntegrationSubscriptionStatusRep} * @memberof Integration */ '_status'?: IntegrationSubscriptionStatusRep; /** * Slack webhook receiver URL. Only used for legacy Slack webhook integrations. * @type {string} * @memberof Integration */ 'url'?: string; /** * Datadog API key. Only used for legacy Datadog webhook integrations. * @type {string} * @memberof Integration */ 'apiKey'?: string; } /** * * @export * @interface IntegrationConfigurationCollectionRep */ export interface IntegrationConfigurationCollectionRep { /** * An array of integration configurations * @type {Array} * @memberof IntegrationConfigurationCollectionRep */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof IntegrationConfigurationCollectionRep */ '_links': { [key: string]: Link; }; } /** * * @export * @interface IntegrationConfigurationPost */ export interface IntegrationConfigurationPost { /** * The name of the integration configuration * @type {string} * @memberof IntegrationConfigurationPost */ 'name': string; /** * Whether the integration configuration is enabled. If omitted, defaults to true * @type {boolean} * @memberof IntegrationConfigurationPost */ 'enabled'?: boolean; /** * Tags for the integration * @type {Array} * @memberof IntegrationConfigurationPost */ 'tags'?: Array; /** * The unique set of fields required to configure the integration. Refer to the formVariables field in the corresponding manifest.json at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure. * @type {{ [key: string]: any; }} * @memberof IntegrationConfigurationPost */ 'configValues': { [key: string]: any; }; /** * * @type {CapabilityConfigPost} * @memberof IntegrationConfigurationPost */ 'capabilityConfig'?: CapabilityConfigPost; } /** * * @export * @interface IntegrationConfigurationsRep */ export interface IntegrationConfigurationsRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof IntegrationConfigurationsRep */ '_links': { [key: string]: Link; }; /** * The unique identifier for this integration configuration * @type {string} * @memberof IntegrationConfigurationsRep */ '_id': string; /** * A human-friendly name for the integration * @type {string} * @memberof IntegrationConfigurationsRep */ 'name': string; /** * * @type {number} * @memberof IntegrationConfigurationsRep */ '_createdAt'?: number; /** * The type of integration * @type {string} * @memberof IntegrationConfigurationsRep */ '_integrationKey'?: string; /** * An array of tags for this integration * @type {Array} * @memberof IntegrationConfigurationsRep */ 'tags'?: Array; /** * Whether the integration is currently active * @type {boolean} * @memberof IntegrationConfigurationsRep */ 'enabled'?: boolean; /** * * @type {Access} * @memberof IntegrationConfigurationsRep */ '_access'?: Access; /** * Details on configuration for an integration of this type. Refer to the formVariables field in the corresponding manifest.json for a full list of fields for each integration. * @type {{ [key: string]: any; }} * @memberof IntegrationConfigurationsRep */ 'configValues'?: { [key: string]: any; }; /** * * @type {CapabilityConfigRep} * @memberof IntegrationConfigurationsRep */ 'capabilityConfig'?: CapabilityConfigRep; } /** * * @export * @interface IntegrationDeliveryConfiguration */ export interface IntegrationDeliveryConfiguration { /** * * @type {IntegrationDeliveryConfigurationLinks} * @memberof IntegrationDeliveryConfiguration */ '_links': IntegrationDeliveryConfigurationLinks; /** * The integration ID * @type {string} * @memberof IntegrationDeliveryConfiguration */ '_id': string; /** * The integration key * @type {string} * @memberof IntegrationDeliveryConfiguration */ 'integrationKey': string; /** * The project key * @type {string} * @memberof IntegrationDeliveryConfiguration */ 'projectKey': string; /** * The environment key * @type {string} * @memberof IntegrationDeliveryConfiguration */ 'environmentKey': string; /** * * @type {{ [key: string]: any; }} * @memberof IntegrationDeliveryConfiguration */ 'config': { [key: string]: any; }; /** * Whether the configuration is turned on * @type {boolean} * @memberof IntegrationDeliveryConfiguration */ 'on': boolean; /** * List of tags for this configuration * @type {Array} * @memberof IntegrationDeliveryConfiguration */ 'tags': Array; /** * Name of the configuration * @type {string} * @memberof IntegrationDeliveryConfiguration */ 'name': string; /** * Version of the current configuration * @type {number} * @memberof IntegrationDeliveryConfiguration */ 'version': number; /** * * @type {Access} * @memberof IntegrationDeliveryConfiguration */ '_access'?: Access; } /** * * @export * @interface IntegrationDeliveryConfigurationCollection */ export interface IntegrationDeliveryConfigurationCollection { /** * * @type {IntegrationDeliveryConfigurationCollectionLinks} * @memberof IntegrationDeliveryConfigurationCollection */ '_links': IntegrationDeliveryConfigurationCollectionLinks; /** * An array of integration delivery configurations * @type {Array} * @memberof IntegrationDeliveryConfigurationCollection */ 'items': Array; } /** * * @export * @interface IntegrationDeliveryConfigurationCollectionLinks */ export interface IntegrationDeliveryConfigurationCollectionLinks { /** * * @type {Link} * @memberof IntegrationDeliveryConfigurationCollectionLinks */ 'self': Link; /** * * @type {Link} * @memberof IntegrationDeliveryConfigurationCollectionLinks */ 'parent'?: Link; } /** * * @export * @interface IntegrationDeliveryConfigurationLinks */ export interface IntegrationDeliveryConfigurationLinks { /** * * @type {Link} * @memberof IntegrationDeliveryConfigurationLinks */ 'self': Link; /** * * @type {Link} * @memberof IntegrationDeliveryConfigurationLinks */ 'parent': Link; /** * * @type {Link} * @memberof IntegrationDeliveryConfigurationLinks */ 'project': Link; /** * * @type {Link} * @memberof IntegrationDeliveryConfigurationLinks */ 'environment': Link; } /** * * @export * @interface IntegrationDeliveryConfigurationPost */ export interface IntegrationDeliveryConfigurationPost { /** * Whether the integration configuration is active. Default value is false. * @type {boolean} * @memberof IntegrationDeliveryConfigurationPost */ 'on'?: boolean; /** * * @type {{ [key: string]: any; }} * @memberof IntegrationDeliveryConfigurationPost */ 'config': { [key: string]: any; }; /** * Tags to associate with the integration * @type {Array} * @memberof IntegrationDeliveryConfigurationPost */ 'tags'?: Array; /** * Name to identify the integration * @type {string} * @memberof IntegrationDeliveryConfigurationPost */ 'name'?: string; } /** * * @export * @interface IntegrationDeliveryConfigurationResponse */ export interface IntegrationDeliveryConfigurationResponse { /** * The status code returned by the validation * @type {number} * @memberof IntegrationDeliveryConfigurationResponse */ 'statusCode'?: number; /** * * @type {string} * @memberof IntegrationDeliveryConfigurationResponse */ 'error'?: string; /** * * @type {number} * @memberof IntegrationDeliveryConfigurationResponse */ 'timestamp'?: number; /** * JSON response to the validation request * @type {string} * @memberof IntegrationDeliveryConfigurationResponse */ 'responseBody'?: string; } /** * * @export * @interface IntegrationMetadata */ export interface IntegrationMetadata { /** * * @type {string} * @memberof IntegrationMetadata */ 'externalId': string; /** * * @type {IntegrationStatus} * @memberof IntegrationMetadata */ 'externalStatus': IntegrationStatus; /** * * @type {string} * @memberof IntegrationMetadata */ 'externalUrl': string; /** * * @type {number} * @memberof IntegrationMetadata */ 'lastChecked': number; } /** * * @export * @interface IntegrationStatus */ export interface IntegrationStatus { /** * * @type {string} * @memberof IntegrationStatus */ 'display': string; /** * * @type {string} * @memberof IntegrationStatus */ 'value': string; } /** * * @export * @interface IntegrationStatusRep */ export interface IntegrationStatusRep { /** * * @type {number} * @memberof IntegrationStatusRep */ 'statusCode'?: number; /** * * @type {string} * @memberof IntegrationStatusRep */ 'responseBody'?: string; /** * * @type {number} * @memberof IntegrationStatusRep */ 'timestamp'?: number; } /** * * @export * @interface IntegrationSubscriptionStatusRep */ export interface IntegrationSubscriptionStatusRep { /** * * @type {number} * @memberof IntegrationSubscriptionStatusRep */ 'successCount'?: number; /** * * @type {number} * @memberof IntegrationSubscriptionStatusRep */ 'lastSuccess'?: number; /** * * @type {number} * @memberof IntegrationSubscriptionStatusRep */ 'lastError'?: number; /** * * @type {number} * @memberof IntegrationSubscriptionStatusRep */ 'errorCount'?: number; /** * * @type {Array} * @memberof IntegrationSubscriptionStatusRep */ 'errors'?: Array; } /** * * @export * @interface Integrations */ export interface Integrations { /** * * @type {{ [key: string]: Link; }} * @memberof Integrations */ '_links'?: { [key: string]: Link; }; /** * * @type {Array} * @memberof Integrations */ 'items'?: Array; /** * * @type {string} * @memberof Integrations */ 'key'?: string; } /** * * @export * @interface InvalidRequestErrorRep */ export interface InvalidRequestErrorRep { /** * Specific error code encountered * @type {string} * @memberof InvalidRequestErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof InvalidRequestErrorRep */ 'message': string; } /** * * @export * @interface IpList */ export interface IpList { /** * A list of the IP addresses LaunchDarkly\'s service uses * @type {Array} * @memberof IpList */ 'addresses': Array; /** * A list of the IP addresses outgoing webhook notifications use * @type {Array} * @memberof IpList */ 'outboundAddresses': Array; } /** * * @export * @interface IterationInput */ export interface IterationInput { /** * The expected outcome of this experiment * @type {string} * @memberof IterationInput */ 'hypothesis': string; /** * Whether to allow the experiment to reassign traffic to different variations when you increase or decrease the traffic in your experiment audience (true) or keep all traffic assigned to its initial variation (false). Defaults to true. * @type {boolean} * @memberof IterationInput */ 'canReshuffleTraffic'?: boolean; /** * * @type {Array} * @memberof IterationInput */ 'metrics': Array; /** * The key of the primary metric for this experiment. Either primarySingleMetricKey or primaryFunnelKey must be present. * @type {string} * @memberof IterationInput */ 'primarySingleMetricKey'?: string; /** * The key of the primary funnel group for this experiment. Either primarySingleMetricKey or primaryFunnelKey must be present. * @type {string} * @memberof IterationInput */ 'primaryFunnelKey'?: string; /** * * @type {Array} * @memberof IterationInput */ 'treatments': Array; /** * * @type {{ [key: string]: FlagInput; }} * @memberof IterationInput */ 'flags': { [key: string]: FlagInput; }; /** * The unit of randomization for this iteration. Defaults to user. * @type {string} * @memberof IterationInput */ 'randomizationUnit'?: string; /** * The attributes that this iteration\'s results can be sliced by * @type {Array} * @memberof IterationInput */ 'attributes'?: Array; } /** * * @export * @interface IterationRep */ export interface IterationRep { /** * The iteration ID * @type {string} * @memberof IterationRep */ '_id'?: string; /** * The expected outcome of this experiment * @type {string} * @memberof IterationRep */ 'hypothesis': string; /** * The status of the iteration: not_started, running, stopped * @type {string} * @memberof IterationRep */ 'status': string; /** * * @type {number} * @memberof IterationRep */ 'createdAt': number; /** * * @type {number} * @memberof IterationRep */ 'startedAt'?: number; /** * * @type {number} * @memberof IterationRep */ 'endedAt'?: number; /** * The ID of the treatment chosen when the experiment stopped * @type {string} * @memberof IterationRep */ 'winningTreatmentId'?: string; /** * The reason you stopped the experiment * @type {string} * @memberof IterationRep */ 'winningReason'?: string; /** * Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false). * @type {boolean} * @memberof IterationRep */ 'canReshuffleTraffic'?: boolean; /** * Details on the flag used in this experiment * @type {{ [key: string]: FlagRep; }} * @memberof IterationRep */ 'flags'?: { [key: string]: FlagRep; }; /** * * @type {DependentMetricOrMetricGroupRep} * @memberof IterationRep */ 'primaryMetric'?: DependentMetricOrMetricGroupRep; /** * * @type {MetricV2Rep} * @memberof IterationRep */ 'primarySingleMetric'?: MetricV2Rep; /** * * @type {DependentMetricGroupRepWithMetrics} * @memberof IterationRep */ 'primaryFunnel'?: DependentMetricGroupRepWithMetrics; /** * The unit of randomization for this iteration * @type {string} * @memberof IterationRep */ 'randomizationUnit'?: string; /** * The available attribute filters for this iteration * @type {Array} * @memberof IterationRep */ 'attributes'?: Array; /** * Details on the variations you are testing in the experiment * @type {Array} * @memberof IterationRep */ 'treatments'?: Array; /** * Deprecated, use metrics instead. Details on the secondary metrics for this experiment. * @type {Array} * @memberof IterationRep * @deprecated */ 'secondaryMetrics'?: Array; /** * Details on the metrics for this experiment * @type {Array} * @memberof IterationRep */ 'metrics'?: Array; /** * * @type {LayerSnapshotRep} * @memberof IterationRep */ 'layerSnapshot'?: LayerSnapshotRep; } /** * * @export * @interface LastSeenMetadata */ export interface LastSeenMetadata { /** * The ID of the token used in the member\'s last session * @type {string} * @memberof LastSeenMetadata */ 'tokenId'?: string; } /** * * @export * @interface LayerCollectionRep */ export interface LayerCollectionRep { /** * The layers in the project * @type {Array} * @memberof LayerCollectionRep */ 'items': Array; /** * The total number of layers in the project * @type {number} * @memberof LayerCollectionRep */ 'totalCount': number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof LayerCollectionRep */ '_links': { [key: string]: Link; }; } /** * * @export * @interface LayerConfigurationRep */ export interface LayerConfigurationRep { /** * The experiment reservations for the layer * @type {Array} * @memberof LayerConfigurationRep */ 'reservations': Array; } /** * * @export * @interface LayerPatchInput */ export interface LayerPatchInput { /** * Optional comment describing the update * @type {string} * @memberof LayerPatchInput */ 'comment'?: string; /** * The environment key used for making environment specific updates. For example, updating the reservation of an experiment * @type {string} * @memberof LayerPatchInput */ 'environmentKey'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof LayerPatchInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface LayerPost */ export interface LayerPost { /** * Unique identifier for the layer * @type {string} * @memberof LayerPost */ 'key': string; /** * Layer name * @type {string} * @memberof LayerPost */ 'name': string; /** * The checkout flow for the application * @type {string} * @memberof LayerPost */ 'description': string; } /** * * @export * @interface LayerRep */ export interface LayerRep { /** * The key of the layer * @type {string} * @memberof LayerRep */ 'key': string; /** * The name of the layer * @type {string} * @memberof LayerRep */ 'name': string; /** * The description of the layer * @type {string} * @memberof LayerRep */ 'description': string; /** * * @type {number} * @memberof LayerRep */ 'createdAt': number; /** * The unit of randomization for the layer * @type {string} * @memberof LayerRep */ 'randomizationUnit'?: string; /** * The layer configurations for each requested environment * @type {{ [key: string]: LayerConfigurationRep; }} * @memberof LayerRep */ 'environments'?: { [key: string]: LayerConfigurationRep; }; } /** * * @export * @interface LayerReservationRep */ export interface LayerReservationRep { /** * The key of the experiment * @type {string} * @memberof LayerReservationRep */ 'experimentKey': string; /** * The key of the flag * @type {string} * @memberof LayerReservationRep */ 'flagKey': string; /** * The percentage of traffic reserved for the experiment * @type {number} * @memberof LayerReservationRep */ 'reservationPercent': number; } /** * * @export * @interface LayerSnapshotRep */ export interface LayerSnapshotRep { /** * Key of the layer the experiment was part of * @type {string} * @memberof LayerSnapshotRep */ 'key': string; /** * Layer name at the time this experiment iteration was stopped * @type {string} * @memberof LayerSnapshotRep */ 'name': string; /** * Percent of layer traffic that was reserved in the layer for this experiment iteration * @type {number} * @memberof LayerSnapshotRep */ 'reservationPercent': number; /** * Percent of layer traffic that was reserved for other experiments in the same environment, when this experiment iteration was stopped * @type {number} * @memberof LayerSnapshotRep */ 'otherReservationPercent': number; } /** * * @export * @interface LeadTimeStagesRep */ export interface LeadTimeStagesRep { /** * The coding duration in milliseconds * @type {number} * @memberof LeadTimeStagesRep */ 'codingDurationMs': number; /** * The review duration in milliseconds * @type {number} * @memberof LeadTimeStagesRep */ 'reviewDurationMs'?: number; /** * The wait duration between merge time and deploy start time in milliseconds * @type {number} * @memberof LeadTimeStagesRep */ 'waitDurationMs'?: number; /** * The deploy duration in milliseconds * @type {number} * @memberof LeadTimeStagesRep */ 'deployDurationMs'?: number; /** * The total lead time in milliseconds * @type {number} * @memberof LeadTimeStagesRep */ 'totalLeadTimeMs'?: number; } /** * * @export * @interface LegacyExperimentRep */ export interface LegacyExperimentRep { /** * * @type {string} * @memberof LegacyExperimentRep */ 'metricKey'?: string; /** * * @type {MetricListingRep} * @memberof LegacyExperimentRep */ '_metric'?: MetricListingRep; /** * * @type {Array} * @memberof LegacyExperimentRep */ 'environments'?: Array; /** * * @type {{ [key: string]: ExperimentEnvironmentSettingRep; }} * @memberof LegacyExperimentRep */ '_environmentSettings'?: { [key: string]: ExperimentEnvironmentSettingRep; }; } /** * * @export * @interface Link */ export interface Link { /** * * @type {string} * @memberof Link */ 'href'?: string; /** * * @type {string} * @memberof Link */ 'type'?: string; } /** * * @export * @interface MaintainerMember */ export interface MaintainerMember { /** * * @type {string} * @memberof MaintainerMember */ '_id': string; /** * * @type {string} * @memberof MaintainerMember */ 'email': string; /** * * @type {string} * @memberof MaintainerMember */ 'firstName'?: string; /** * * @type {string} * @memberof MaintainerMember */ 'lastName'?: string; /** * * @type {string} * @memberof MaintainerMember */ 'role': string; } /** * * @export * @interface MaintainerRep */ export interface MaintainerRep { /** * * @type {MemberSummary} * @memberof MaintainerRep */ 'member'?: MemberSummary; /** * * @type {MemberTeamSummaryRep} * @memberof MaintainerRep */ 'team'?: MemberTeamSummaryRep; } /** * * @export * @interface MaintainerTeam */ export interface MaintainerTeam { /** * The key of the maintainer team * @type {string} * @memberof MaintainerTeam */ 'key': string; /** * A human-friendly name for the maintainer team * @type {string} * @memberof MaintainerTeam */ 'name': string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MaintainerTeam */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface Member */ export interface Member { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Member */ '_links': { [key: string]: Link; }; /** * The member\'s ID * @type {string} * @memberof Member */ '_id': string; /** * The member\'s first name * @type {string} * @memberof Member */ 'firstName'?: string; /** * The member\'s last name * @type {string} * @memberof Member */ 'lastName'?: string; /** * The member\'s built-in role. If the member has no custom roles, this role will be in effect. * @type {string} * @memberof Member */ 'role': string; /** * The member\'s email address * @type {string} * @memberof Member */ 'email': string; /** * Whether the member has a pending invitation * @type {boolean} * @memberof Member */ '_pendingInvite': boolean; /** * Whether the member\'s email address has been verified * @type {boolean} * @memberof Member */ '_verified': boolean; /** * The member\'s email address before it has been verified, for accounts where email verification is required * @type {string} * @memberof Member */ '_pendingEmail'?: string; /** * The set of custom roles (as keys) assigned to the member * @type {Array} * @memberof Member */ 'customRoles': Array; /** * Whether multi-factor authentication is enabled for this member * @type {string} * @memberof Member */ 'mfa': string; /** * Default dashboards that the member has chosen to ignore * @type {Array} * @memberof Member */ 'excludedDashboards'?: Array; /** * * @type {number} * @memberof Member */ '_lastSeen': number; /** * * @type {LastSeenMetadata} * @memberof Member */ '_lastSeenMetadata'?: LastSeenMetadata; /** * * @type {IntegrationMetadata} * @memberof Member */ '_integrationMetadata'?: IntegrationMetadata; /** * Details on the teams this member is assigned to * @type {Array} * @memberof Member */ 'teams'?: Array; /** * A list of permission grants. Permission grants allow a member to have access to a specific action, without having to create or update a custom role. * @type {Array} * @memberof Member */ 'permissionGrants'?: Array; /** * * @type {number} * @memberof Member */ 'creationDate': number; /** * A list of OAuth providers * @type {Array} * @memberof Member */ 'oauthProviders'?: Array; /** * Version of the current configuration * @type {number} * @memberof Member */ 'version'?: number; /** * * @type {{ [key: string]: Array; }} * @memberof Member */ 'roleAttributes'?: { [key: string]: Array; }; } /** * * @export * @interface MemberDataRep */ export interface MemberDataRep { /** * * @type {{ [key: string]: Link; }} * @memberof MemberDataRep */ '_links'?: { [key: string]: Link; }; /** * The member ID * @type {string} * @memberof MemberDataRep */ '_id'?: string; /** * The member email * @type {string} * @memberof MemberDataRep */ 'email'?: string; /** * The member first name * @type {string} * @memberof MemberDataRep */ 'firstName'?: string; /** * The member last name * @type {string} * @memberof MemberDataRep */ 'lastName'?: string; } /** * * @export * @interface MemberImportItem */ export interface MemberImportItem { /** * An error message, including CSV line number, if the status is error * @type {string} * @memberof MemberImportItem */ 'message'?: string; /** * Whether this member can be successfully imported (success) or not (error). Even if the status is success, members are only added to a team on a 201 response. * @type {string} * @memberof MemberImportItem */ 'status': string; /** * The email address for the member requested to be added to this team. May be blank or an error, such as \'invalid email format\', if the email address cannot be found or parsed. * @type {string} * @memberof MemberImportItem */ 'value': string; } /** * * @export * @interface MemberPermissionGrantSummaryRep */ export interface MemberPermissionGrantSummaryRep { /** * The name of the group of related actions to allow. A permission grant may have either an actionSet or a list of actions but not both at the same time. * @type {string} * @memberof MemberPermissionGrantSummaryRep */ 'actionSet'?: string; /** * A list of actions to allow. A permission grant may have either an actionSet or a list of actions but not both at the same time. * @type {Array} * @memberof MemberPermissionGrantSummaryRep */ 'actions'?: Array; /** * The resource for which the actions are allowed * @type {string} * @memberof MemberPermissionGrantSummaryRep */ 'resource': string; } /** * * @export * @interface MemberSummary */ export interface MemberSummary { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MemberSummary */ '_links': { [key: string]: Link; }; /** * The member\'s ID * @type {string} * @memberof MemberSummary */ '_id': string; /** * The member\'s first name * @type {string} * @memberof MemberSummary */ 'firstName'?: string; /** * The member\'s last name * @type {string} * @memberof MemberSummary */ 'lastName'?: string; /** * The member\'s built-in role. If the member has no custom roles, this role will be in effect. * @type {string} * @memberof MemberSummary */ 'role': string; /** * The member\'s email address * @type {string} * @memberof MemberSummary */ 'email': string; } /** * * @export * @interface MemberTeamSummaryRep */ export interface MemberTeamSummaryRep { /** * A list of keys of the custom roles this team has access to * @type {Array} * @memberof MemberTeamSummaryRep */ 'customRoleKeys': Array; /** * The team key * @type {string} * @memberof MemberTeamSummaryRep */ 'key': string; /** * * @type {{ [key: string]: Link; }} * @memberof MemberTeamSummaryRep */ '_links'?: { [key: string]: Link; }; /** * The team name * @type {string} * @memberof MemberTeamSummaryRep */ 'name': string; } /** * * @export * @interface MemberTeamsPostInput */ export interface MemberTeamsPostInput { /** * List of team keys * @type {Array} * @memberof MemberTeamsPostInput */ 'teamKeys': Array; } /** * * @export * @interface Members */ export interface Members { /** * An array of members * @type {Array} * @memberof Members */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Members */ '_links': { [key: string]: Link; }; /** * The number of members returned * @type {number} * @memberof Members */ 'totalCount'?: number; } /** * * @export * @interface MembersPatchInput */ export interface MembersPatchInput { /** * Optional comment describing the update * @type {string} * @memberof MembersPatchInput */ 'comment'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof MembersPatchInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface Message */ export interface Message { /** * * @type {string} * @memberof Message */ 'content': string; /** * * @type {string} * @memberof Message */ 'role': string; } /** * * @export * @interface MethodNotAllowedErrorRep */ export interface MethodNotAllowedErrorRep { /** * Specific error code encountered * @type {string} * @memberof MethodNotAllowedErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof MethodNotAllowedErrorRep */ 'message': string; } /** * * @export * @interface MetricByVariation */ export interface MetricByVariation { /** * * @type {string} * @memberof MetricByVariation */ 'variationKey'?: string; /** * * @type {Metrics} * @memberof MetricByVariation */ 'metrics'?: Metrics; } /** * * @export * @interface MetricCollectionRep */ export interface MetricCollectionRep { /** * An array of metrics * @type {Array} * @memberof MetricCollectionRep */ 'items'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricCollectionRep */ '_links'?: { [key: string]: Link; }; /** * * @type {number} * @memberof MetricCollectionRep */ 'totalCount'?: number; } /** * * @export * @interface MetricEventDefaultRep */ export interface MetricEventDefaultRep { /** * Whether to disable defaulting missing unit events when calculating results. Defaults to false * @type {boolean} * @memberof MetricEventDefaultRep */ 'disabled'?: boolean; /** * The default value applied to missing unit events. Set to 0 when disabled is false. No other values are currently supported. * @type {number} * @memberof MetricEventDefaultRep */ 'value'?: number; } /** * * @export * @interface MetricGroupCollectionRep */ export interface MetricGroupCollectionRep { /** * An array of metric groups * @type {Array} * @memberof MetricGroupCollectionRep */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricGroupCollectionRep */ '_links'?: { [key: string]: Link; }; /** * * @type {number} * @memberof MetricGroupCollectionRep */ 'totalCount'?: number; } /** * * @export * @interface MetricGroupPost */ export interface MetricGroupPost { /** * A unique key to reference the metric group * @type {string} * @memberof MetricGroupPost */ 'key': string; /** * A human-friendly name for the metric group * @type {string} * @memberof MetricGroupPost */ 'name': string; /** * The type of the metric group * @type {string} * @memberof MetricGroupPost */ 'kind': MetricGroupPostKindEnum; /** * Description of the metric group * @type {string} * @memberof MetricGroupPost */ 'description'?: string; /** * The ID of the member who maintains this metric group * @type {string} * @memberof MetricGroupPost */ 'maintainerId': string; /** * Tags for the metric group * @type {Array} * @memberof MetricGroupPost */ 'tags': Array; /** * An ordered list of the metrics in this metric group * @type {Array} * @memberof MetricGroupPost */ 'metrics': Array; } export declare const MetricGroupPostKindEnum: { readonly Funnel: "funnel"; }; export type MetricGroupPostKindEnum = typeof MetricGroupPostKindEnum[keyof typeof MetricGroupPostKindEnum]; /** * * @export * @interface MetricGroupRep */ export interface MetricGroupRep { /** * The ID of this metric group * @type {string} * @memberof MetricGroupRep */ '_id': string; /** * A unique key to reference the metric group * @type {string} * @memberof MetricGroupRep */ 'key': string; /** * A human-friendly name for the metric group * @type {string} * @memberof MetricGroupRep */ 'name': string; /** * The type of the metric group * @type {string} * @memberof MetricGroupRep */ 'kind': MetricGroupRepKindEnum; /** * Description of the metric group * @type {string} * @memberof MetricGroupRep */ 'description'?: string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricGroupRep */ '_links': { [key: string]: Link; }; /** * * @type {Access} * @memberof MetricGroupRep */ '_access'?: Access; /** * Tags for the metric group * @type {Array} * @memberof MetricGroupRep */ 'tags': Array; /** * * @type {number} * @memberof MetricGroupRep */ '_creationDate': number; /** * * @type {number} * @memberof MetricGroupRep */ '_lastModified': number; /** * * @type {MaintainerRep} * @memberof MetricGroupRep */ 'maintainer': MaintainerRep; /** * An ordered list of the metrics in this metric group * @type {Array} * @memberof MetricGroupRep */ 'metrics': Array; /** * The version of this metric group * @type {number} * @memberof MetricGroupRep */ '_version': number; /** * * @type {Array} * @memberof MetricGroupRep */ 'experiments'?: Array; /** * The number of experiments using this metric group * @type {number} * @memberof MetricGroupRep */ 'experimentCount'?: number; } export declare const MetricGroupRepKindEnum: { readonly Funnel: "funnel"; readonly Standard: "standard"; }; export type MetricGroupRepKindEnum = typeof MetricGroupRepKindEnum[keyof typeof MetricGroupRepKindEnum]; /** * * @export * @interface MetricGroupResultsRep */ export interface MetricGroupResultsRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricGroupResultsRep */ '_links': { [key: string]: Link; }; /** * An ordered list of the metrics in this metric group, and each of their results * @type {Array} * @memberof MetricGroupResultsRep */ 'metrics': Array; } /** * * @export * @interface MetricInGroupRep */ export interface MetricInGroupRep { /** * The metric key * @type {string} * @memberof MetricInGroupRep */ 'key': string; /** * The version ID of the metric * @type {string} * @memberof MetricInGroupRep */ '_versionId'?: string; /** * The metric name * @type {string} * @memberof MetricInGroupRep */ 'name': string; /** * The kind of event the metric tracks * @type {string} * @memberof MetricInGroupRep */ 'kind': MetricInGroupRepKindEnum; /** * For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). * @type {boolean} * @memberof MetricInGroupRep */ 'isNumeric'?: boolean; /** * The type of unit aggregation to use for the metric * @type {string} * @memberof MetricInGroupRep */ 'unitAggregationType'?: MetricInGroupRepUnitAggregationTypeEnum; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricInGroupRep */ '_links': { [key: string]: Link; }; /** * Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a funnel. * @type {string} * @memberof MetricInGroupRep */ 'nameInGroup'?: string; /** * The randomization units for the metric * @type {Array} * @memberof MetricInGroupRep */ 'randomizationUnits'?: Array; } export declare const MetricInGroupRepKindEnum: { readonly Pageview: "pageview"; readonly Click: "click"; readonly Custom: "custom"; }; export type MetricInGroupRepKindEnum = typeof MetricInGroupRepKindEnum[keyof typeof MetricInGroupRepKindEnum]; export declare const MetricInGroupRepUnitAggregationTypeEnum: { readonly Sum: "sum"; readonly Average: "average"; }; export type MetricInGroupRepUnitAggregationTypeEnum = typeof MetricInGroupRepUnitAggregationTypeEnum[keyof typeof MetricInGroupRepUnitAggregationTypeEnum]; /** * * @export * @interface MetricInGroupResultsRep */ export interface MetricInGroupResultsRep { /** * * @type {MetricInGroupRep} * @memberof MetricInGroupResultsRep */ 'metric': MetricInGroupRep; /** * * @type {ExperimentBayesianResultsRep} * @memberof MetricInGroupResultsRep */ 'results': ExperimentBayesianResultsRep; } /** * * @export * @interface MetricInMetricGroupInput */ export interface MetricInMetricGroupInput { /** * The metric key * @type {string} * @memberof MetricInMetricGroupInput */ 'key': string; /** * Name of the metric when used within the associated metric group. Can be different from the original name of the metric * @type {string} * @memberof MetricInMetricGroupInput */ 'nameInGroup': string; } /** * * @export * @interface MetricInput */ export interface MetricInput { /** * The metric key * @type {string} * @memberof MetricInput */ 'key': string; /** * Whether this is a metric group (true) or a metric (false). Defaults to false * @type {boolean} * @memberof MetricInput */ 'isGroup'?: boolean; /** * Deprecated, use primarySingleMetricKey and primaryFunnelKey. Whether this is a primary metric (true) or a secondary metric (false) * @type {boolean} * @memberof MetricInput * @deprecated */ 'primary'?: boolean; } /** * * @export * @interface MetricListingRep */ export interface MetricListingRep { /** * The number of experiments using this metric * @type {number} * @memberof MetricListingRep */ 'experimentCount'?: number; /** * The number of metric groups using this metric * @type {number} * @memberof MetricListingRep */ 'metricGroupCount'?: number; /** * The ID of this metric * @type {string} * @memberof MetricListingRep */ '_id': string; /** * The version ID of the metric * @type {string} * @memberof MetricListingRep */ '_versionId': string; /** * A unique key to reference the metric * @type {string} * @memberof MetricListingRep */ 'key': string; /** * A human-friendly name for the metric * @type {string} * @memberof MetricListingRep */ 'name': string; /** * The kind of event the metric tracks * @type {string} * @memberof MetricListingRep */ 'kind': MetricListingRepKindEnum; /** * The number of feature flags currently attached to this metric * @type {number} * @memberof MetricListingRep */ '_attachedFlagCount'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricListingRep */ '_links': { [key: string]: Link; }; /** * * @type {Link} * @memberof MetricListingRep */ '_site'?: Link; /** * * @type {Access} * @memberof MetricListingRep */ '_access'?: Access; /** * Tags for the metric * @type {Array} * @memberof MetricListingRep */ 'tags': Array; /** * * @type {number} * @memberof MetricListingRep */ '_creationDate': number; /** * * @type {Modification} * @memberof MetricListingRep */ 'lastModified'?: Modification; /** * The ID of the member who maintains this metric * @type {string} * @memberof MetricListingRep */ 'maintainerId'?: string; /** * * @type {MemberSummary} * @memberof MetricListingRep */ '_maintainer'?: MemberSummary; /** * Description of the metric * @type {string} * @memberof MetricListingRep */ 'description'?: string; /** * The category of the metric * @type {string} * @memberof MetricListingRep */ 'category'?: string; /** * For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). * @type {boolean} * @memberof MetricListingRep */ 'isNumeric'?: boolean; /** * For custom metrics, the success criteria * @type {string} * @memberof MetricListingRep */ 'successCriteria'?: MetricListingRepSuccessCriteriaEnum; /** * For numeric custom metrics, the unit of measure * @type {string} * @memberof MetricListingRep */ 'unit'?: string; /** * For custom metrics, the event key to use in your code * @type {string} * @memberof MetricListingRep */ 'eventKey'?: string; /** * An array of randomization units allowed for this metric * @type {Array} * @memberof MetricListingRep */ 'randomizationUnits'?: Array; /** * The method by which multiple unit event values are aggregated * @type {string} * @memberof MetricListingRep */ 'unitAggregationType'?: MetricListingRepUnitAggregationTypeEnum; /** * The method for analyzing metric events * @type {string} * @memberof MetricListingRep */ 'analysisType'?: MetricListingRepAnalysisTypeEnum; /** * The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile. * @type {number} * @memberof MetricListingRep */ 'percentileValue'?: number; /** * * @type {MetricEventDefaultRep} * @memberof MetricListingRep */ 'eventDefault'?: MetricEventDefaultRep; } export declare const MetricListingRepKindEnum: { readonly Pageview: "pageview"; readonly Click: "click"; readonly Custom: "custom"; }; export type MetricListingRepKindEnum = typeof MetricListingRepKindEnum[keyof typeof MetricListingRepKindEnum]; export declare const MetricListingRepSuccessCriteriaEnum: { readonly HigherThanBaseline: "HigherThanBaseline"; readonly LowerThanBaseline: "LowerThanBaseline"; }; export type MetricListingRepSuccessCriteriaEnum = typeof MetricListingRepSuccessCriteriaEnum[keyof typeof MetricListingRepSuccessCriteriaEnum]; export declare const MetricListingRepUnitAggregationTypeEnum: { readonly Average: "average"; readonly Sum: "sum"; }; export type MetricListingRepUnitAggregationTypeEnum = typeof MetricListingRepUnitAggregationTypeEnum[keyof typeof MetricListingRepUnitAggregationTypeEnum]; export declare const MetricListingRepAnalysisTypeEnum: { readonly Mean: "mean"; readonly Percentile: "percentile"; }; export type MetricListingRepAnalysisTypeEnum = typeof MetricListingRepAnalysisTypeEnum[keyof typeof MetricListingRepAnalysisTypeEnum]; /** * * @export * @interface MetricPost */ export interface MetricPost { /** * A unique key to reference the metric * @type {string} * @memberof MetricPost */ 'key': string; /** * A human-friendly name for the metric * @type {string} * @memberof MetricPost */ 'name'?: string; /** * Description of the metric * @type {string} * @memberof MetricPost */ 'description'?: string; /** * The kind of event your metric will track * @type {string} * @memberof MetricPost */ 'kind': MetricPostKindEnum; /** * One or more CSS selectors. Required for click metrics only. * @type {string} * @memberof MetricPost */ 'selector'?: string; /** * One or more target URLs. Required for click and pageview metrics only. * @type {Array} * @memberof MetricPost */ 'urls'?: Array; /** * Whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). Required for custom metrics only. * @type {boolean} * @memberof MetricPost */ 'isNumeric'?: boolean; /** * The unit of measure. Applicable for numeric custom metrics only. * @type {string} * @memberof MetricPost */ 'unit'?: string; /** * The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only. * @type {string} * @memberof MetricPost */ 'eventKey'?: string; /** * Success criteria. Required for custom numeric metrics, optional for custom conversion metrics. * @type {string} * @memberof MetricPost */ 'successCriteria'?: MetricPostSuccessCriteriaEnum; /** * Tags for the metric * @type {Array} * @memberof MetricPost */ 'tags'?: Array; /** * An array of randomization units allowed for this metric * @type {Array} * @memberof MetricPost */ 'randomizationUnits'?: Array; /** * The ID of the member who maintains this metric * @type {string} * @memberof MetricPost */ 'maintainerId'?: string; /** * The method by which multiple unit event values are aggregated * @type {string} * @memberof MetricPost */ 'unitAggregationType'?: MetricPostUnitAggregationTypeEnum; /** * The method for analyzing metric events * @type {string} * @memberof MetricPost */ 'analysisType'?: string; /** * The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile. * @type {number} * @memberof MetricPost */ 'percentileValue'?: number; /** * * @type {MetricEventDefaultRep} * @memberof MetricPost */ 'eventDefault'?: MetricEventDefaultRep; } export declare const MetricPostKindEnum: { readonly Pageview: "pageview"; readonly Click: "click"; readonly Custom: "custom"; }; export type MetricPostKindEnum = typeof MetricPostKindEnum[keyof typeof MetricPostKindEnum]; export declare const MetricPostSuccessCriteriaEnum: { readonly HigherThanBaseline: "HigherThanBaseline"; readonly LowerThanBaseline: "LowerThanBaseline"; }; export type MetricPostSuccessCriteriaEnum = typeof MetricPostSuccessCriteriaEnum[keyof typeof MetricPostSuccessCriteriaEnum]; export declare const MetricPostUnitAggregationTypeEnum: { readonly Average: "average"; readonly Sum: "sum"; }; export type MetricPostUnitAggregationTypeEnum = typeof MetricPostUnitAggregationTypeEnum[keyof typeof MetricPostUnitAggregationTypeEnum]; /** * * @export * @interface MetricRep */ export interface MetricRep { /** * The number of experiments using this metric * @type {number} * @memberof MetricRep */ 'experimentCount'?: number; /** * The number of metric groups using this metric * @type {number} * @memberof MetricRep */ 'metricGroupCount'?: number; /** * The ID of this metric * @type {string} * @memberof MetricRep */ '_id': string; /** * The version ID of the metric * @type {string} * @memberof MetricRep */ '_versionId': string; /** * A unique key to reference the metric * @type {string} * @memberof MetricRep */ 'key': string; /** * A human-friendly name for the metric * @type {string} * @memberof MetricRep */ 'name': string; /** * The kind of event the metric tracks * @type {string} * @memberof MetricRep */ 'kind': MetricRepKindEnum; /** * The number of feature flags currently attached to this metric * @type {number} * @memberof MetricRep */ '_attachedFlagCount'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricRep */ '_links': { [key: string]: Link; }; /** * * @type {Link} * @memberof MetricRep */ '_site'?: Link; /** * * @type {Access} * @memberof MetricRep */ '_access'?: Access; /** * Tags for the metric * @type {Array} * @memberof MetricRep */ 'tags': Array; /** * * @type {number} * @memberof MetricRep */ '_creationDate': number; /** * * @type {Modification} * @memberof MetricRep */ 'lastModified'?: Modification; /** * The ID of the member who maintains this metric * @type {string} * @memberof MetricRep */ 'maintainerId'?: string; /** * * @type {MemberSummary} * @memberof MetricRep */ '_maintainer'?: MemberSummary; /** * Description of the metric * @type {string} * @memberof MetricRep */ 'description'?: string; /** * The category of the metric * @type {string} * @memberof MetricRep */ 'category'?: string; /** * For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). * @type {boolean} * @memberof MetricRep */ 'isNumeric'?: boolean; /** * For custom metrics, the success criteria * @type {string} * @memberof MetricRep */ 'successCriteria'?: MetricRepSuccessCriteriaEnum; /** * For numeric custom metrics, the unit of measure * @type {string} * @memberof MetricRep */ 'unit'?: string; /** * For custom metrics, the event key to use in your code * @type {string} * @memberof MetricRep */ 'eventKey'?: string; /** * An array of randomization units allowed for this metric * @type {Array} * @memberof MetricRep */ 'randomizationUnits'?: Array; /** * The method by which multiple unit event values are aggregated * @type {string} * @memberof MetricRep */ 'unitAggregationType'?: MetricRepUnitAggregationTypeEnum; /** * The method for analyzing metric events * @type {string} * @memberof MetricRep */ 'analysisType'?: MetricRepAnalysisTypeEnum; /** * The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile. * @type {number} * @memberof MetricRep */ 'percentileValue'?: number; /** * * @type {MetricEventDefaultRep} * @memberof MetricRep */ 'eventDefault'?: MetricEventDefaultRep; /** * * @type {Array} * @memberof MetricRep */ 'experiments'?: Array; /** * Metric groups that use this metric * @type {Array} * @memberof MetricRep */ 'metricGroups'?: Array; /** * Whether the metric is active * @type {boolean} * @memberof MetricRep */ 'isActive'?: boolean; /** * Details on the flags attached to this metric * @type {Array} * @memberof MetricRep */ '_attachedFeatures'?: Array; /** * Version of the metric * @type {number} * @memberof MetricRep */ '_version'?: number; /** * For click metrics, the CSS selectors * @type {string} * @memberof MetricRep */ 'selector'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof MetricRep */ 'urls'?: Array<{ [key: string]: any; }>; } export declare const MetricRepKindEnum: { readonly Pageview: "pageview"; readonly Click: "click"; readonly Custom: "custom"; }; export type MetricRepKindEnum = typeof MetricRepKindEnum[keyof typeof MetricRepKindEnum]; export declare const MetricRepSuccessCriteriaEnum: { readonly HigherThanBaseline: "HigherThanBaseline"; readonly LowerThanBaseline: "LowerThanBaseline"; }; export type MetricRepSuccessCriteriaEnum = typeof MetricRepSuccessCriteriaEnum[keyof typeof MetricRepSuccessCriteriaEnum]; export declare const MetricRepUnitAggregationTypeEnum: { readonly Average: "average"; readonly Sum: "sum"; }; export type MetricRepUnitAggregationTypeEnum = typeof MetricRepUnitAggregationTypeEnum[keyof typeof MetricRepUnitAggregationTypeEnum]; export declare const MetricRepAnalysisTypeEnum: { readonly Mean: "mean"; readonly Percentile: "percentile"; }; export type MetricRepAnalysisTypeEnum = typeof MetricRepAnalysisTypeEnum[keyof typeof MetricRepAnalysisTypeEnum]; /** * * @export * @interface MetricSeen */ export interface MetricSeen { /** * Whether the metric has received an event for this iteration * @type {boolean} * @memberof MetricSeen */ 'ever'?: boolean; /** * Timestamp of when the metric most recently received an event for this iteration * @type {number} * @memberof MetricSeen */ 'timestamp'?: number; } /** * * @export * @interface MetricV2Rep */ export interface MetricV2Rep { /** * The metric key * @type {string} * @memberof MetricV2Rep */ 'key': string; /** * The version ID of the metric * @type {string} * @memberof MetricV2Rep */ '_versionId'?: string; /** * The metric name * @type {string} * @memberof MetricV2Rep */ 'name': string; /** * The kind of event the metric tracks * @type {string} * @memberof MetricV2Rep */ 'kind': MetricV2RepKindEnum; /** * For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). * @type {boolean} * @memberof MetricV2Rep */ 'isNumeric'?: boolean; /** * The type of unit aggregation to use for the metric * @type {string} * @memberof MetricV2Rep */ 'unitAggregationType'?: MetricV2RepUnitAggregationTypeEnum; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MetricV2Rep */ '_links': { [key: string]: Link; }; } export declare const MetricV2RepKindEnum: { readonly Pageview: "pageview"; readonly Click: "click"; readonly Custom: "custom"; }; export type MetricV2RepKindEnum = typeof MetricV2RepKindEnum[keyof typeof MetricV2RepKindEnum]; export declare const MetricV2RepUnitAggregationTypeEnum: { readonly Sum: "sum"; readonly Average: "average"; }; export type MetricV2RepUnitAggregationTypeEnum = typeof MetricV2RepUnitAggregationTypeEnum[keyof typeof MetricV2RepUnitAggregationTypeEnum]; /** * * @export * @interface Metrics */ export interface Metrics { /** * * @type {number} * @memberof Metrics */ 'inputTokens'?: number; /** * * @type {number} * @memberof Metrics */ 'outputTokens'?: number; /** * * @type {number} * @memberof Metrics */ 'totalTokens'?: number; /** * Number of attempted generations * @type {number} * @memberof Metrics * @deprecated */ 'generationCount'?: number; /** * Number of successful generations * @type {number} * @memberof Metrics */ 'generationSuccessCount'?: number; /** * Number of generations with errors * @type {number} * @memberof Metrics */ 'generationErrorCount'?: number; /** * * @type {number} * @memberof Metrics */ 'thumbsUp'?: number; /** * * @type {number} * @memberof Metrics */ 'thumbsDown'?: number; /** * * @type {number} * @memberof Metrics */ 'durationMs'?: number; /** * * @type {number} * @memberof Metrics */ 'timeToFirstTokenMs'?: number; /** * A value between 0 and 1 representing satisfaction rating * @type {number} * @memberof Metrics */ 'satisfactionRating'?: number; /** * Cost of input tokens in USD * @type {number} * @memberof Metrics */ 'inputCost'?: number; /** * Cost of output tokens in USD * @type {number} * @memberof Metrics */ 'outputCost'?: number; } /** * * @export * @interface MigrationSafetyIssueRep */ export interface MigrationSafetyIssueRep { /** * The ID of the rule which caused this issue * @type {string} * @memberof MigrationSafetyIssueRep */ 'causingRuleId'?: string; /** * A list of the IDs of the rules which are affected by this issue. fallthrough is a sentinel value for the default rule. * @type {Array} * @memberof MigrationSafetyIssueRep */ 'affectedRuleIds'?: Array; /** * A description of the issue that causingRuleId has caused for affectedRuleIds. * @type {string} * @memberof MigrationSafetyIssueRep */ 'issue'?: string; /** * Whether the changes caused by causingRuleId bring inconsistency to the old system * @type {boolean} * @memberof MigrationSafetyIssueRep */ 'oldSystemAffected'?: boolean; } /** * * @export * @interface MigrationSettingsPost */ export interface MigrationSettingsPost { /** * Context kind for a migration with 6 stages, where data is being moved * @type {string} * @memberof MigrationSettingsPost */ 'contextKind'?: string; /** * * @type {number} * @memberof MigrationSettingsPost */ 'stageCount': number; } /** * * @export * @interface ModelConfig */ export interface ModelConfig { /** * * @type {AiConfigsAccess} * @memberof ModelConfig */ '_access'?: AiConfigsAccess; /** * Human readable name of the model * @type {string} * @memberof ModelConfig */ 'name': string; /** * Unique key for the model * @type {string} * @memberof ModelConfig */ 'key': string; /** * Identifier for the model, for use with third party providers * @type {string} * @memberof ModelConfig */ 'id': string; /** * Icon for the model * @type {string} * @memberof ModelConfig */ 'icon'?: string; /** * Provider for the model * @type {string} * @memberof ModelConfig */ 'provider'?: string; /** * Whether the model is global * @type {boolean} * @memberof ModelConfig */ 'global': boolean; /** * * @type {object} * @memberof ModelConfig */ 'params'?: object; /** * * @type {object} * @memberof ModelConfig */ 'customParams'?: object; /** * * @type {Array} * @memberof ModelConfig */ 'tags': Array; /** * * @type {number} * @memberof ModelConfig */ 'version': number; /** * Cost per input token in USD * @type {number} * @memberof ModelConfig */ 'costPerInputToken'?: number; /** * Cost per output token in USD * @type {number} * @memberof ModelConfig */ 'costPerOutputToken'?: number; } /** * * @export * @interface ModelConfigPost */ export interface ModelConfigPost { /** * Human readable name of the model * @type {string} * @memberof ModelConfigPost */ 'name': string; /** * Unique key for the model * @type {string} * @memberof ModelConfigPost */ 'key': string; /** * Identifier for the model, for use with third party providers * @type {string} * @memberof ModelConfigPost */ 'id': string; /** * Icon for the model * @type {string} * @memberof ModelConfigPost */ 'icon'?: string; /** * Provider for the model * @type {string} * @memberof ModelConfigPost */ 'provider'?: string; /** * * @type {object} * @memberof ModelConfigPost */ 'params'?: object; /** * * @type {object} * @memberof ModelConfigPost */ 'customParams'?: object; /** * * @type {Array} * @memberof ModelConfigPost */ 'tags'?: Array; /** * Cost per input token in USD * @type {number} * @memberof ModelConfigPost */ 'costPerInputToken'?: number; /** * Cost per output token in USD * @type {number} * @memberof ModelConfigPost */ 'costPerOutputToken'?: number; } /** * * @export * @interface ModelError */ export interface ModelError { /** * * @type {string} * @memberof ModelError */ 'message': string; /** * * @type {string} * @memberof ModelError */ 'code': string; } /** * * @export * @interface Modification */ export interface Modification { /** * * @type {string} * @memberof Modification */ 'date'?: string; } /** * * @export * @interface MultiEnvironmentDependentFlag */ export interface MultiEnvironmentDependentFlag { /** * The flag name * @type {string} * @memberof MultiEnvironmentDependentFlag */ 'name'?: string; /** * The flag key * @type {string} * @memberof MultiEnvironmentDependentFlag */ 'key': string; /** * A list of environments in which the dependent flag appears * @type {Array} * @memberof MultiEnvironmentDependentFlag */ 'environments': Array; } /** * * @export * @interface MultiEnvironmentDependentFlags */ export interface MultiEnvironmentDependentFlags { /** * An array of dependent flags with their environment information * @type {Array} * @memberof MultiEnvironmentDependentFlags */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof MultiEnvironmentDependentFlags */ '_links': { [key: string]: Link; }; /** * * @type {Link} * @memberof MultiEnvironmentDependentFlags */ '_site': Link; } /** * * @export * @interface NamingConvention */ export interface NamingConvention { /** * The casing convention to enforce for new flag keys in this project * @type {string} * @memberof NamingConvention */ 'case'?: NamingConventionCaseEnum; /** * The prefix to enforce for new flag keys in this project * @type {string} * @memberof NamingConvention */ 'prefix'?: string; } export declare const NamingConventionCaseEnum: { readonly None: "none"; readonly CamelCase: "camelCase"; readonly UpperCamelCase: "upperCamelCase"; readonly SnakeCase: "snakeCase"; readonly KebabCase: "kebabCase"; }; export type NamingConventionCaseEnum = typeof NamingConventionCaseEnum[keyof typeof NamingConventionCaseEnum]; /** * * @export * @interface NewMemberForm */ export interface NewMemberForm { /** * The member\'s email * @type {string} * @memberof NewMemberForm */ 'email': string; /** * The member\'s password * @type {string} * @memberof NewMemberForm */ 'password'?: string; /** * The member\'s first name * @type {string} * @memberof NewMemberForm */ 'firstName'?: string; /** * The member\'s last name * @type {string} * @memberof NewMemberForm */ 'lastName'?: string; /** * The member\'s built-in role * @type {string} * @memberof NewMemberForm */ 'role'?: NewMemberFormRoleEnum; /** * An array of the member\'s custom roles * @type {Array} * @memberof NewMemberForm */ 'customRoles'?: Array; /** * An array of the member\'s teams * @type {Array} * @memberof NewMemberForm */ 'teamKeys'?: Array; /** * * @type {{ [key: string]: Array; }} * @memberof NewMemberForm */ 'roleAttributes'?: { [key: string]: Array; }; } export declare const NewMemberFormRoleEnum: { readonly Reader: "reader"; readonly Writer: "writer"; readonly Admin: "admin"; readonly NoAccess: "no_access"; }; export type NewMemberFormRoleEnum = typeof NewMemberFormRoleEnum[keyof typeof NewMemberFormRoleEnum]; /** * * @export * @interface NotFoundErrorRep */ export interface NotFoundErrorRep { /** * Specific error code encountered * @type {string} * @memberof NotFoundErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof NotFoundErrorRep */ 'message': string; } /** * * @export * @interface OauthClientPost */ export interface OauthClientPost { /** * The name of your new LaunchDarkly OAuth 2.0 client. * @type {string} * @memberof OauthClientPost */ 'name'?: string; /** * The redirect URI for your new OAuth 2.0 application. This should be an absolute URL conforming with the standard HTTPS protocol. * @type {string} * @memberof OauthClientPost */ 'redirectUri'?: string; /** * Description of your OAuth 2.0 client. * @type {string} * @memberof OauthClientPost */ 'description'?: string; } /** * * @export * @interface OptionsArray */ export interface OptionsArray { /** * * @type {string} * @memberof OptionsArray */ 'label'?: string; /** * * @type {string} * @memberof OptionsArray */ 'value'?: string; } /** * * @export * @interface PaginatedLinks */ export interface PaginatedLinks { /** * * @type {AiConfigsLink} * @memberof PaginatedLinks */ 'first'?: AiConfigsLink; /** * * @type {AiConfigsLink} * @memberof PaginatedLinks */ 'last'?: AiConfigsLink; /** * * @type {AiConfigsLink} * @memberof PaginatedLinks */ 'next'?: AiConfigsLink; /** * * @type {AiConfigsLink} * @memberof PaginatedLinks */ 'prev'?: AiConfigsLink; /** * * @type {AiConfigsLink} * @memberof PaginatedLinks */ 'self': AiConfigsLink; } /** * * @export * @interface ParameterDefault */ export interface ParameterDefault { /** * The default value for the given parameter * @type {any} * @memberof ParameterDefault */ 'value'?: any; /** * Variation value for boolean flags. Not applicable for non-boolean flags. * @type {boolean} * @memberof ParameterDefault */ 'booleanVariationValue'?: boolean; /** * * @type {RuleClause} * @memberof ParameterDefault */ 'ruleClause'?: RuleClause; } /** * * @export * @interface ParameterRep */ export interface ParameterRep { /** * * @type {string} * @memberof ParameterRep */ 'variationId'?: string; /** * * @type {string} * @memberof ParameterRep */ 'flagKey'?: string; } /** * The location and content type of related resources * @export * @interface ParentAndSelfLinks */ export interface ParentAndSelfLinks { /** * * @type {CoreLink} * @memberof ParentAndSelfLinks */ 'self': CoreLink; /** * * @type {CoreLink} * @memberof ParentAndSelfLinks */ 'parent': CoreLink; } /** * * @export * @interface ParentLink */ export interface ParentLink { /** * * @type {CoreLink} * @memberof ParentLink */ 'parent': CoreLink; } /** * * @export * @interface ParentResourceRep */ export interface ParentResourceRep { /** * * @type {{ [key: string]: Link; }} * @memberof ParentResourceRep */ '_links'?: { [key: string]: Link; }; /** * The name of the parent resource * @type {string} * @memberof ParentResourceRep */ 'name'?: string; /** * The parent\'s resource specifier * @type {string} * @memberof ParentResourceRep */ 'resource'?: string; } /** * * @export * @interface PatchFailedErrorRep */ export interface PatchFailedErrorRep { /** * Specific error code encountered * @type {string} * @memberof PatchFailedErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof PatchFailedErrorRep */ 'message': string; } /** * * @export * @interface PatchFlagsRequest */ export interface PatchFlagsRequest { /** * Optional comment describing the change * @type {string} * @memberof PatchFlagsRequest */ 'comment'?: string; /** * The instructions to perform when updating * @type {Array<{ [key: string]: any; }>} * @memberof PatchFlagsRequest */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface PatchOperation */ export interface PatchOperation { /** * The type of operation to perform * @type {string} * @memberof PatchOperation */ 'op': string; /** * A JSON Pointer string specifying the part of the document to operate on * @type {string} * @memberof PatchOperation */ 'path': string; /** * A JSON value used in \"add\", \"replace\", and \"test\" operations * @type {any} * @memberof PatchOperation */ 'value'?: any; } /** * * @export * @interface PatchSegmentExpiringTargetInputRep */ export interface PatchSegmentExpiringTargetInputRep { /** * Optional description of changes * @type {string} * @memberof PatchSegmentExpiringTargetInputRep */ 'comment'?: string; /** * Semantic patch instructions for the desired changes to the resource * @type {Array} * @memberof PatchSegmentExpiringTargetInputRep */ 'instructions': Array; } /** * * @export * @interface PatchSegmentExpiringTargetInstruction */ export interface PatchSegmentExpiringTargetInstruction { /** * The type of change to make to the context\'s removal date from this segment * @type {string} * @memberof PatchSegmentExpiringTargetInstruction */ 'kind': PatchSegmentExpiringTargetInstructionKindEnum; /** * A unique key used to represent the context * @type {string} * @memberof PatchSegmentExpiringTargetInstruction */ 'contextKey': string; /** * The kind of context * @type {string} * @memberof PatchSegmentExpiringTargetInstruction */ 'contextKind': string; /** * The segment\'s target type * @type {string} * @memberof PatchSegmentExpiringTargetInstruction */ 'targetType': PatchSegmentExpiringTargetInstructionTargetTypeEnum; /** * The time, in Unix milliseconds, when the context should be removed from this segment. Required if kind is addExpiringTarget or updateExpiringTarget. * @type {number} * @memberof PatchSegmentExpiringTargetInstruction */ 'value'?: number; /** * The version of the expiring target to update. Optional and only used if kind is updateExpiringTarget. If included, update will fail if version doesn\'t match current version of the expiring target. * @type {number} * @memberof PatchSegmentExpiringTargetInstruction */ 'version'?: number; } export declare const PatchSegmentExpiringTargetInstructionKindEnum: { readonly AddExpiringTarget: "addExpiringTarget"; readonly UpdateExpiringTarget: "updateExpiringTarget"; readonly RemoveExpiringTarget: "removeExpiringTarget"; }; export type PatchSegmentExpiringTargetInstructionKindEnum = typeof PatchSegmentExpiringTargetInstructionKindEnum[keyof typeof PatchSegmentExpiringTargetInstructionKindEnum]; export declare const PatchSegmentExpiringTargetInstructionTargetTypeEnum: { readonly Included: "included"; readonly Excluded: "excluded"; }; export type PatchSegmentExpiringTargetInstructionTargetTypeEnum = typeof PatchSegmentExpiringTargetInstructionTargetTypeEnum[keyof typeof PatchSegmentExpiringTargetInstructionTargetTypeEnum]; /** * * @export * @interface PatchSegmentInstruction */ export interface PatchSegmentInstruction { /** * The type of change to make to the user\'s removal date from this segment * @type {string} * @memberof PatchSegmentInstruction */ 'kind': PatchSegmentInstructionKindEnum; /** * A unique key used to represent the user * @type {string} * @memberof PatchSegmentInstruction */ 'userKey': string; /** * The segment\'s target type * @type {string} * @memberof PatchSegmentInstruction */ 'targetType': PatchSegmentInstructionTargetTypeEnum; /** * The time, in Unix milliseconds, when the user should be removed from this segment. Required if kind is addExpireUserTargetDate or updateExpireUserTargetDate. * @type {number} * @memberof PatchSegmentInstruction */ 'value'?: number; /** * The version of the segment to update. Required if kind is updateExpireUserTargetDate. * @type {number} * @memberof PatchSegmentInstruction */ 'version'?: number; } export declare const PatchSegmentInstructionKindEnum: { readonly AddExpireUserTargetDate: "addExpireUserTargetDate"; readonly UpdateExpireUserTargetDate: "updateExpireUserTargetDate"; readonly RemoveExpireUserTargetDate: "removeExpireUserTargetDate"; }; export type PatchSegmentInstructionKindEnum = typeof PatchSegmentInstructionKindEnum[keyof typeof PatchSegmentInstructionKindEnum]; export declare const PatchSegmentInstructionTargetTypeEnum: { readonly Included: "included"; readonly Excluded: "excluded"; }; export type PatchSegmentInstructionTargetTypeEnum = typeof PatchSegmentInstructionTargetTypeEnum[keyof typeof PatchSegmentInstructionTargetTypeEnum]; /** * * @export * @interface PatchSegmentRequest */ export interface PatchSegmentRequest { /** * Optional description of changes * @type {string} * @memberof PatchSegmentRequest */ 'comment'?: string; /** * Semantic patch instructions for the desired changes to the resource * @type {Array} * @memberof PatchSegmentRequest */ 'instructions': Array; } /** * * @export * @interface PatchUsersRequest */ export interface PatchUsersRequest { /** * Optional comment describing the change * @type {string} * @memberof PatchUsersRequest */ 'comment'?: string; /** * The instructions to perform when updating * @type {Array} * @memberof PatchUsersRequest */ 'instructions': Array; } /** * * @export * @interface PatchWithComment */ export interface PatchWithComment { /** * * @type {Array} * @memberof PatchWithComment */ 'patch': Array; /** * Optional comment * @type {string} * @memberof PatchWithComment */ 'comment'?: string; } /** * * @export * @interface PermissionGrantInput */ export interface PermissionGrantInput { /** * A group of related actions to allow. Specify either actionSet or actions. Use maintainTeam to add team maintainers. * @type {string} * @memberof PermissionGrantInput */ 'actionSet'?: PermissionGrantInputActionSetEnum; /** * A list of actions to allow. Specify either actionSet or actions. To learn more, read [Role actions](https://launchdarkly.com/docs/ld-docs/home/account/role-actions). * @type {Array} * @memberof PermissionGrantInput */ 'actions'?: Array; /** * A list of member IDs who receive the permission grant. * @type {Array} * @memberof PermissionGrantInput */ 'memberIDs'?: Array; } export declare const PermissionGrantInputActionSetEnum: { readonly MaintainTeam: "maintainTeam"; }; export type PermissionGrantInputActionSetEnum = typeof PermissionGrantInputActionSetEnum[keyof typeof PermissionGrantInputActionSetEnum]; /** * * @export * @interface Phase */ export interface Phase { /** * The phase ID * @type {string} * @memberof Phase */ 'id': string; /** * * @type {Array} * @memberof Phase */ 'audiences': Array; /** * The release phase name * @type {string} * @memberof Phase */ 'name': string; /** * * @type {object} * @memberof Phase */ 'configuration'?: object; } /** * * @export * @interface PhaseInfo */ export interface PhaseInfo { /** * The phase ID * @type {string} * @memberof PhaseInfo */ '_id': string; /** * The release phase name * @type {string} * @memberof PhaseInfo */ 'name': string; /** * The number of active releases in this phase * @type {number} * @memberof PhaseInfo */ 'releaseCount': number; } /** * * @export * @interface PostApprovalRequestApplyRequest */ export interface PostApprovalRequestApplyRequest { /** * Optional comment about the approval request * @type {string} * @memberof PostApprovalRequestApplyRequest */ 'comment'?: string; } /** * * @export * @interface PostApprovalRequestReviewRequest */ export interface PostApprovalRequestReviewRequest { /** * The type of review for this approval request * @type {string} * @memberof PostApprovalRequestReviewRequest */ 'kind'?: PostApprovalRequestReviewRequestKindEnum; /** * Optional comment about the approval request * @type {string} * @memberof PostApprovalRequestReviewRequest */ 'comment'?: string; } export declare const PostApprovalRequestReviewRequestKindEnum: { readonly Approve: "approve"; readonly Comment: "comment"; readonly Decline: "decline"; }; export type PostApprovalRequestReviewRequestKindEnum = typeof PostApprovalRequestReviewRequestKindEnum[keyof typeof PostApprovalRequestReviewRequestKindEnum]; /** * * @export * @interface PostDeploymentEventInput */ export interface PostDeploymentEventInput { /** * The project key * @type {string} * @memberof PostDeploymentEventInput */ 'projectKey': string; /** * The environment key * @type {string} * @memberof PostDeploymentEventInput */ 'environmentKey': string; /** * The application key. This defines the granularity at which you want to view your insights metrics. Typically it is the name of one of the GitHub repositories that you use in this project.

LaunchDarkly automatically creates a new application each time you send a unique application key. * @type {string} * @memberof PostDeploymentEventInput */ 'applicationKey': string; /** * The application name. This defines how the application is displayed * @type {string} * @memberof PostDeploymentEventInput */ 'applicationName'?: string; /** * The kind of application. Default: server * @type {string} * @memberof PostDeploymentEventInput */ 'applicationKind'?: PostDeploymentEventInputApplicationKindEnum; /** * The application version. You can set the application version to any string that includes only letters, numbers, periods (.), hyphens (-), or underscores (_).

We recommend setting the application version to at least the first seven characters of the SHA or to the tag of the GitHub commit for this deployment. * @type {string} * @memberof PostDeploymentEventInput */ 'version': string; /** * The version name. This defines how the version is displayed * @type {string} * @memberof PostDeploymentEventInput */ 'versionName'?: string; /** * The event type * @type {string} * @memberof PostDeploymentEventInput */ 'eventType': PostDeploymentEventInputEventTypeEnum; /** * * @type {number} * @memberof PostDeploymentEventInput */ 'eventTime'?: number; /** * A JSON object containing metadata about the event * @type {{ [key: string]: any; }} * @memberof PostDeploymentEventInput */ 'eventMetadata'?: { [key: string]: any; }; /** * A JSON object containing metadata about the deployment * @type {{ [key: string]: any; }} * @memberof PostDeploymentEventInput */ 'deploymentMetadata'?: { [key: string]: any; }; } export declare const PostDeploymentEventInputApplicationKindEnum: { readonly Server: "server"; readonly Browser: "browser"; readonly Mobile: "mobile"; }; export type PostDeploymentEventInputApplicationKindEnum = typeof PostDeploymentEventInputApplicationKindEnum[keyof typeof PostDeploymentEventInputApplicationKindEnum]; export declare const PostDeploymentEventInputEventTypeEnum: { readonly Started: "started"; readonly Failed: "failed"; readonly Finished: "finished"; readonly Custom: "custom"; }; export type PostDeploymentEventInputEventTypeEnum = typeof PostDeploymentEventInputEventTypeEnum[keyof typeof PostDeploymentEventInputEventTypeEnum]; /** * * @export * @interface PostFlagScheduledChangesInput */ export interface PostFlagScheduledChangesInput { /** * Optional comment describing the scheduled changes * @type {string} * @memberof PostFlagScheduledChangesInput */ 'comment'?: string; /** * * @type {number} * @memberof PostFlagScheduledChangesInput */ 'executionDate': number; /** * * @type {Array<{ [key: string]: any; }>} * @memberof PostFlagScheduledChangesInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface PostInsightGroupParams */ export interface PostInsightGroupParams { /** * The name of the insight group * @type {string} * @memberof PostInsightGroupParams */ 'name': string; /** * The key of the insight group * @type {string} * @memberof PostInsightGroupParams */ 'key': string; /** * The projectKey to be associated with the insight group * @type {string} * @memberof PostInsightGroupParams */ 'projectKey': string; /** * The environmentKey to be associated with the insight group * @type {string} * @memberof PostInsightGroupParams */ 'environmentKey': string; /** * The application keys to associate with the insight group. If not provided, the insight group will include data from all applications. * @type {Array} * @memberof PostInsightGroupParams */ 'applicationKeys'?: Array; } /** * * @export * @interface Prerequisite */ export interface Prerequisite { /** * * @type {string} * @memberof Prerequisite */ 'key': string; /** * * @type {number} * @memberof Prerequisite */ 'variation': number; } /** * * @export * @interface Project */ export interface Project { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Project */ '_links': { [key: string]: Link; }; /** * The ID of this project * @type {string} * @memberof Project */ '_id': string; /** * The key of this project * @type {string} * @memberof Project */ 'key': string; /** * Whether or not flags created in this project are made available to the client-side JavaScript SDK by default * @type {boolean} * @memberof Project */ 'includeInSnippetByDefault': boolean; /** * * @type {ClientSideAvailability} * @memberof Project */ 'defaultClientSideAvailability'?: ClientSideAvailability; /** * A human-friendly name for the project * @type {string} * @memberof Project */ 'name': string; /** * * @type {Access} * @memberof Project */ '_access'?: Access; /** * A list of tags for the project * @type {Array} * @memberof Project */ 'tags': Array; /** * The key of the default release pipeline for this project * @type {string} * @memberof Project */ 'defaultReleasePipelineKey'?: string; /** * * @type {Environments} * @memberof Project */ 'environments'?: Environments; } /** * * @export * @interface ProjectPost */ export interface ProjectPost { /** * A human-friendly name for the project. * @type {string} * @memberof ProjectPost */ 'name': string; /** * A unique key used to reference the project in your code. * @type {string} * @memberof ProjectPost */ 'key': string; /** * Whether or not flags created in this project are made available to the client-side JavaScript SDK by default. * @type {boolean} * @memberof ProjectPost */ 'includeInSnippetByDefault'?: boolean; /** * * @type {DefaultClientSideAvailabilityPost} * @memberof ProjectPost */ 'defaultClientSideAvailability'?: DefaultClientSideAvailabilityPost; /** * Tags for the project * @type {Array} * @memberof ProjectPost */ 'tags'?: Array; /** * Creates the provided environments for this project. If omitted default environments will be created instead. * @type {Array} * @memberof ProjectPost */ 'environments'?: Array; /** * * @type {NamingConvention} * @memberof ProjectPost */ 'namingConvention'?: NamingConvention; } /** * * @export * @interface ProjectRep */ export interface ProjectRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ProjectRep */ '_links': { [key: string]: Link; }; /** * The ID of this project * @type {string} * @memberof ProjectRep */ '_id': string; /** * The key of this project * @type {string} * @memberof ProjectRep */ 'key': string; /** * Whether or not flags created in this project are made available to the client-side JavaScript SDK by default * @type {boolean} * @memberof ProjectRep */ 'includeInSnippetByDefault': boolean; /** * * @type {ClientSideAvailability} * @memberof ProjectRep */ 'defaultClientSideAvailability'?: ClientSideAvailability; /** * A human-friendly name for the project * @type {string} * @memberof ProjectRep */ 'name': string; /** * * @type {Access} * @memberof ProjectRep */ '_access'?: Access; /** * A list of tags for the project * @type {Array} * @memberof ProjectRep */ 'tags': Array; /** * The key of the default release pipeline for this project * @type {string} * @memberof ProjectRep */ 'defaultReleasePipelineKey'?: string; /** * A list of environments for the project * @type {Array} * @memberof ProjectRep */ 'environments': Array; } /** * * @export * @interface ProjectSummary */ export interface ProjectSummary { /** * The ID of this project * @type {string} * @memberof ProjectSummary */ '_id': string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ProjectSummary */ '_links': { [key: string]: Link; }; /** * The project key * @type {string} * @memberof ProjectSummary */ 'key': string; /** * The project name * @type {string} * @memberof ProjectSummary */ 'name': string; } /** * * @export * @interface ProjectSummaryCollection */ export interface ProjectSummaryCollection { /** * * @type {number} * @memberof ProjectSummaryCollection */ 'totalCount': number; /** * * @type {Array} * @memberof ProjectSummaryCollection */ 'items': Array; /** * * @type {{ [key: string]: Link; }} * @memberof ProjectSummaryCollection */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface Projects */ export interface Projects { /** * A link to this resource. * @type {{ [key: string]: Link; }} * @memberof Projects */ '_links': { [key: string]: Link; }; /** * List of projects. * @type {Array} * @memberof Projects */ 'items': Array; /** * * @type {number} * @memberof Projects */ 'totalCount'?: number; } /** * * @export * @interface PullRequestCollectionRep */ export interface PullRequestCollectionRep { /** * The total number of pull requests * @type {number} * @memberof PullRequestCollectionRep */ 'totalCount': number; /** * A list of pull requests * @type {Array} * @memberof PullRequestCollectionRep */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof PullRequestCollectionRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface PullRequestLeadTimeRep */ export interface PullRequestLeadTimeRep { /** * The coding duration in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'codingDurationMs': number; /** * The review duration in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'reviewDurationMs'?: number; /** * The max wait duration between merge time and deploy start time in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'maxWaitDurationMs'?: number; /** * The average wait duration between merge time and deploy start time in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'avgWaitDurationMs'?: number; /** * The max deploy duration in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'maxDeployDurationMs'?: number; /** * The average deploy duration in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'avgDeployDurationMs'?: number; /** * The max total lead time in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'maxTotalLeadTimeMs'?: number; /** * The average total lead time in milliseconds * @type {number} * @memberof PullRequestLeadTimeRep */ 'avgTotalLeadTimeMs'?: number; } /** * * @export * @interface PullRequestRep */ export interface PullRequestRep { /** * The pull request internal ID * @type {string} * @memberof PullRequestRep */ 'id': string; /** * The pull request number * @type {string} * @memberof PullRequestRep */ 'externalId': string; /** * The pull request title * @type {string} * @memberof PullRequestRep */ 'title': string; /** * The pull request status * @type {string} * @memberof PullRequestRep */ 'status': string; /** * The pull request author * @type {string} * @memberof PullRequestRep */ 'author': string; /** * * @type {number} * @memberof PullRequestRep */ 'createTime': number; /** * * @type {number} * @memberof PullRequestRep */ 'mergeTime'?: number; /** * The pull request merge commit key * @type {string} * @memberof PullRequestRep */ 'mergeCommitKey'?: string; /** * The pull request base commit key * @type {string} * @memberof PullRequestRep */ 'baseCommitKey': string; /** * The pull request head commit key * @type {string} * @memberof PullRequestRep */ 'headCommitKey': string; /** * The number of files changed * @type {number} * @memberof PullRequestRep */ 'filesChanged': number; /** * The number of lines added * @type {number} * @memberof PullRequestRep */ 'linesAdded': number; /** * The number of lines deleted * @type {number} * @memberof PullRequestRep */ 'linesDeleted': number; /** * The pull request URL * @type {string} * @memberof PullRequestRep */ 'url': string; /** * * @type {DeploymentCollectionRep} * @memberof PullRequestRep */ 'deployments'?: DeploymentCollectionRep; /** * * @type {FlagReferenceCollectionRep} * @memberof PullRequestRep */ 'flagReferences'?: FlagReferenceCollectionRep; /** * * @type {PullRequestLeadTimeRep} * @memberof PullRequestRep */ 'leadTime'?: PullRequestLeadTimeRep; } /** * * @export * @interface PutBranch */ export interface PutBranch { /** * The branch name * @type {string} * @memberof PutBranch */ 'name': string; /** * An ID representing the branch HEAD. For example, a commit SHA. * @type {string} * @memberof PutBranch */ 'head': string; /** * An optional ID used to prevent older data from overwriting newer data. If no sequence ID is included, the newly submitted data will always be saved. * @type {number} * @memberof PutBranch */ 'updateSequenceId'?: number; /** * * @type {number} * @memberof PutBranch */ 'syncTime': number; /** * An array of flag references found on the branch * @type {Array} * @memberof PutBranch */ 'references'?: Array; /** * * @type {number} * @memberof PutBranch */ 'commitTime'?: number; } /** * * @export * @interface RandomizationSettingsPut */ export interface RandomizationSettingsPut { /** * An array of randomization units allowed for this project. * @type {Array} * @memberof RandomizationSettingsPut */ 'randomizationUnits': Array; } /** * * @export * @interface RandomizationSettingsRep */ export interface RandomizationSettingsRep { /** * The project ID * @type {string} * @memberof RandomizationSettingsRep */ '_projectId'?: string; /** * The project key * @type {string} * @memberof RandomizationSettingsRep */ '_projectKey'?: string; /** * An array of the randomization units in this project * @type {Array} * @memberof RandomizationSettingsRep */ 'randomizationUnits'?: Array; /** * * @type {number} * @memberof RandomizationSettingsRep */ '_creationDate'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof RandomizationSettingsRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface RandomizationUnitInput */ export interface RandomizationUnitInput { /** * The unit of randomization. Must match the key of an existing context kind in this project. * @type {string} * @memberof RandomizationUnitInput */ 'randomizationUnit': string; /** * If true, any experiment iterations created within this project will default to using this randomization unit. A project can only have one default randomization unit. * @type {boolean} * @memberof RandomizationUnitInput */ 'default'?: boolean; /** * One of LaunchDarkly\'s fixed set of standard randomization units. * @type {string} * @memberof RandomizationUnitInput */ 'standardRandomizationUnit': RandomizationUnitInputStandardRandomizationUnitEnum; } export declare const RandomizationUnitInputStandardRandomizationUnitEnum: { readonly Guest: "guest"; readonly GuestTime: "guestTime"; readonly Organization: "organization"; readonly Request: "request"; readonly User: "user"; readonly UserTime: "userTime"; }; export type RandomizationUnitInputStandardRandomizationUnitEnum = typeof RandomizationUnitInputStandardRandomizationUnitEnum[keyof typeof RandomizationUnitInputStandardRandomizationUnitEnum]; /** * * @export * @interface RandomizationUnitRep */ export interface RandomizationUnitRep { /** * The unit of randomization. Defaults to user. * @type {string} * @memberof RandomizationUnitRep */ 'randomizationUnit'?: string; /** * One of LaunchDarkly\'s fixed set of standard randomization units. * @type {string} * @memberof RandomizationUnitRep */ 'standardRandomizationUnit'?: string; /** * Whether this randomization unit is the default for experiments * @type {boolean} * @memberof RandomizationUnitRep */ 'default'?: boolean; /** * * @type {boolean} * @memberof RandomizationUnitRep */ '_hidden'?: boolean; /** * The display name for the randomization unit, displayed in the LaunchDarkly user interface. * @type {string} * @memberof RandomizationUnitRep */ '_displayName'?: string; } /** * * @export * @interface RateLimitedErrorRep */ export interface RateLimitedErrorRep { /** * Specific error code encountered * @type {string} * @memberof RateLimitedErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof RateLimitedErrorRep */ 'message': string; } /** * * @export * @interface RecentTriggerBody */ export interface RecentTriggerBody { /** * * @type {number} * @memberof RecentTriggerBody */ 'timestamp'?: number; /** * The marshalled JSON request body for the incoming trigger webhook. If this is empty or contains invalid JSON, the timestamp is recorded but this field will be empty. * @type {{ [key: string]: any; }} * @memberof RecentTriggerBody */ 'jsonBody'?: { [key: string]: any; }; } /** * * @export * @interface ReferenceRep */ export interface ReferenceRep { /** * File path of the reference * @type {string} * @memberof ReferenceRep */ 'path': string; /** * Programming language used in the file * @type {string} * @memberof ReferenceRep */ 'hint'?: string; /** * * @type {Array} * @memberof ReferenceRep */ 'hunks': Array; } /** * * @export * @interface RelatedExperimentRep */ export interface RelatedExperimentRep { /** * * @type {string} * @memberof RelatedExperimentRep */ 'key'?: string; /** * * @type {string} * @memberof RelatedExperimentRep */ 'name'?: string; /** * * @type {string} * @memberof RelatedExperimentRep */ 'environment'?: string; } /** * * @export * @interface RelativeDifferenceRep */ export interface RelativeDifferenceRep { /** * An upper bound of the relative difference between the treatment and the fromTreatmentId * @type {number} * @memberof RelativeDifferenceRep */ 'upper'?: number; /** * A lower bound of the relative difference between the treatment and the fromTreatmentId * @type {number} * @memberof RelativeDifferenceRep */ 'lower'?: number; /** * The treatment ID of the treatment against which the relative difference is calculated * @type {string} * @memberof RelativeDifferenceRep */ 'fromTreatmentId'?: string; /** * Variance of the relative difference * @type {number} * @memberof RelativeDifferenceRep */ 'variance'?: number; /** * The reduction in variance resulting from CUPED * @type {number} * @memberof RelativeDifferenceRep */ 'varianceReduction'?: number; } /** * * @export * @interface RelayAutoConfigCollectionRep */ export interface RelayAutoConfigCollectionRep { /** * An array of Relay Proxy configurations * @type {Array} * @memberof RelayAutoConfigCollectionRep */ 'items': Array; } /** * * @export * @interface RelayAutoConfigPost */ export interface RelayAutoConfigPost { /** * A human-friendly name for the Relay Proxy configuration * @type {string} * @memberof RelayAutoConfigPost */ 'name': string; /** * A description of what environments and projects the Relay Proxy should include or exclude. To learn more, read [Write an inline policy](https://launchdarkly.com/docs/sdk/relay-proxy/automatic-configuration#write-an-inline-policy). * @type {Array} * @memberof RelayAutoConfigPost */ 'policy': Array; } /** * * @export * @interface RelayAutoConfigRep */ export interface RelayAutoConfigRep { /** * * @type {string} * @memberof RelayAutoConfigRep */ '_id': string; /** * * @type {MemberSummary} * @memberof RelayAutoConfigRep */ '_creator'?: MemberSummary; /** * * @type {Access} * @memberof RelayAutoConfigRep */ '_access'?: Access; /** * A human-friendly name for the Relay Proxy configuration * @type {string} * @memberof RelayAutoConfigRep */ 'name': string; /** * A description of what environments and projects the Relay Proxy should include or exclude * @type {Array} * @memberof RelayAutoConfigRep */ 'policy': Array; /** * The Relay Proxy configuration key * @type {string} * @memberof RelayAutoConfigRep */ 'fullKey': string; /** * The last few characters of the Relay Proxy configuration key, displayed in the LaunchDarkly UI * @type {string} * @memberof RelayAutoConfigRep */ 'displayKey': string; /** * * @type {number} * @memberof RelayAutoConfigRep */ 'creationDate': number; /** * * @type {number} * @memberof RelayAutoConfigRep */ 'lastModified': number; } /** * * @export * @interface Release */ export interface Release { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Release */ '_links'?: { [key: string]: Link; }; /** * The release pipeline name * @type {string} * @memberof Release */ 'name': string; /** * The release pipeline key * @type {string} * @memberof Release */ 'releasePipelineKey': string; /** * The release pipeline description * @type {string} * @memberof Release */ 'releasePipelineDescription': string; /** * An ordered list of the release pipeline phases * @type {Array} * @memberof Release */ 'phases': Array; /** * The release version * @type {number} * @memberof Release */ '_version': number; /** * The chosen release variation ID to use across all phases of a release * @type {string} * @memberof Release */ '_releaseVariationId'?: string; /** * * @type {number} * @memberof Release */ '_canceledAt'?: number; } /** * * @export * @interface ReleaseAudience */ export interface ReleaseAudience { /** * The audience ID * @type {string} * @memberof ReleaseAudience */ '_id': string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ReleaseAudience */ '_links'?: { [key: string]: Link; }; /** * * @type {EnvironmentSummary} * @memberof ReleaseAudience */ 'environment'?: EnvironmentSummary; /** * The release phase name * @type {string} * @memberof ReleaseAudience */ 'name': string; /** * * @type {AudienceConfiguration} * @memberof ReleaseAudience */ 'configuration'?: AudienceConfiguration; /** * A list of segment keys * @type {Array} * @memberof ReleaseAudience */ 'segmentKeys'?: Array; /** * * @type {string} * @memberof ReleaseAudience */ 'status'?: string; /** * The rules IDs added or updated by this audience * @type {Array} * @memberof ReleaseAudience */ '_ruleIds'?: Array; } /** * * @export * @interface ReleaseGuardianConfiguration */ export interface ReleaseGuardianConfiguration { /** * The monitoring window in milliseconds * @type {number} * @memberof ReleaseGuardianConfiguration */ 'monitoringWindowMilliseconds': number; /** * The rollout weight percentage * @type {number} * @memberof ReleaseGuardianConfiguration */ 'rolloutWeight': number; /** * Whether or not to roll back on regression * @type {boolean} * @memberof ReleaseGuardianConfiguration */ 'rollbackOnRegression': boolean; /** * The randomization unit for the measured rollout * @type {string} * @memberof ReleaseGuardianConfiguration */ 'randomizationUnit'?: string; } /** * * @export * @interface ReleaseGuardianConfigurationInput */ export interface ReleaseGuardianConfigurationInput { /** * The monitoring window in milliseconds * @type {number} * @memberof ReleaseGuardianConfigurationInput */ 'monitoringWindowMilliseconds'?: number; /** * The rollout weight * @type {number} * @memberof ReleaseGuardianConfigurationInput */ 'rolloutWeight'?: number; /** * Whether or not to rollback on regression * @type {boolean} * @memberof ReleaseGuardianConfigurationInput */ 'rollbackOnRegression'?: boolean; /** * The randomization unit for the measured rollout * @type {string} * @memberof ReleaseGuardianConfigurationInput */ 'randomizationUnit'?: string; } /** * * @export * @interface ReleasePhase */ export interface ReleasePhase { /** * The phase ID * @type {string} * @memberof ReleasePhase */ '_id': string; /** * The release phase name * @type {string} * @memberof ReleasePhase */ '_name': string; /** * Whether this phase is complete * @type {boolean} * @memberof ReleasePhase */ 'complete': boolean; /** * * @type {number} * @memberof ReleasePhase */ '_creationDate': number; /** * * @type {number} * @memberof ReleasePhase */ '_completionDate'?: number; /** * * @type {CompletedBy} * @memberof ReleasePhase */ '_completedBy'?: CompletedBy; /** * A logical grouping of one or more environments that share attributes for rolling out changes * @type {Array} * @memberof ReleasePhase */ '_audiences': Array; /** * * @type {string} * @memberof ReleasePhase */ 'status'?: string; /** * Whether or not this phase has started * @type {boolean} * @memberof ReleasePhase */ 'started'?: boolean; /** * * @type {number} * @memberof ReleasePhase */ '_startedDate'?: number; /** * * @type {object} * @memberof ReleasePhase */ 'configuration'?: object; } /** * * @export * @interface ReleasePipeline */ export interface ReleasePipeline { /** * Timestamp of when the release pipeline was created * @type {string} * @memberof ReleasePipeline */ 'createdAt': string; /** * The release pipeline description * @type {string} * @memberof ReleasePipeline */ 'description'?: string; /** * The release pipeline key * @type {string} * @memberof ReleasePipeline */ 'key': string; /** * The release pipeline name * @type {string} * @memberof ReleasePipeline */ 'name': string; /** * An ordered list of the release pipeline phases. Each phase is a logical grouping of one or more environments that share attributes for rolling out changes. * @type {Array} * @memberof ReleasePipeline */ 'phases': Array; /** * A list of the release pipeline\'s tags * @type {Array} * @memberof ReleasePipeline */ 'tags'?: Array; /** * The release pipeline version * @type {number} * @memberof ReleasePipeline */ '_version'?: number; /** * * @type {Access} * @memberof ReleasePipeline */ '_access'?: Access; /** * Whether this release pipeline is the default pipeline for the project * @type {boolean} * @memberof ReleasePipeline */ 'isProjectDefault'?: boolean; /** * Whether this release pipeline is a legacy pipeline * @type {boolean} * @memberof ReleasePipeline */ '_isLegacy'?: boolean; } /** * * @export * @interface ReleasePipelineCollection */ export interface ReleasePipelineCollection { /** * An array of release pipelines * @type {Array} * @memberof ReleasePipelineCollection */ 'items': Array; /** * Total number of release pipelines * @type {number} * @memberof ReleasePipelineCollection */ 'totalCount': number; } /** * * @export * @interface ReleaseProgression */ export interface ReleaseProgression { /** * * @type {number} * @memberof ReleaseProgression */ '_createdAt': number; /** * * @type {number} * @memberof ReleaseProgression */ '_completedAt'?: number; /** * The flag key * @type {string} * @memberof ReleaseProgression */ 'flagKey': string; /** * The ID of the currently active release phase * @type {string} * @memberof ReleaseProgression */ 'activePhaseId'?: string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ReleaseProgression */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ReleaseProgressionCollection */ export interface ReleaseProgressionCollection { /** * The number of active releases * @type {number} * @memberof ReleaseProgressionCollection */ 'activeCount': number; /** * The number of completed releases * @type {number} * @memberof ReleaseProgressionCollection */ 'completedCount': number; /** * A list of details for each release, across all flags, for this release pipeline * @type {Array} * @memberof ReleaseProgressionCollection */ 'items': Array; /** * A list of details for each phase, across all releases, for this release pipeline * @type {Array} * @memberof ReleaseProgressionCollection */ 'phases': Array; /** * The total number of releases for this release pipeline * @type {number} * @memberof ReleaseProgressionCollection */ 'totalCount': number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof ReleaseProgressionCollection */ '_links': { [key: string]: Link; }; } /** * * @export * @interface ReleaserAudienceConfigInput */ export interface ReleaserAudienceConfigInput { /** * UUID of the audience. * @type {string} * @memberof ReleaserAudienceConfigInput */ 'audienceId'?: string; /** * * @type {ReleaseGuardianConfigurationInput} * @memberof ReleaserAudienceConfigInput */ 'releaseGuardianConfiguration'?: ReleaseGuardianConfigurationInput; /** * An array of member IDs. These members are notified to review the approval request. * @type {Array} * @memberof ReleaserAudienceConfigInput */ 'notifyMemberIds'?: Array; /** * An array of team keys. The members of these teams are notified to review the approval request. * @type {Array} * @memberof ReleaserAudienceConfigInput */ 'notifyTeamKeys'?: Array; } /** * * @export * @interface RepositoryCollectionRep */ export interface RepositoryCollectionRep { /** * * @type {{ [key: string]: Link; }} * @memberof RepositoryCollectionRep */ '_links': { [key: string]: Link; }; /** * An array of repositories * @type {Array} * @memberof RepositoryCollectionRep */ 'items': Array; } /** * * @export * @interface RepositoryPost */ export interface RepositoryPost { /** * The repository name * @type {string} * @memberof RepositoryPost */ 'name': string; /** * A URL to access the repository * @type {string} * @memberof RepositoryPost */ 'sourceLink'?: string; /** * A template for constructing a valid URL to view the commit * @type {string} * @memberof RepositoryPost */ 'commitUrlTemplate'?: string; /** * A template for constructing a valid URL to view the hunk * @type {string} * @memberof RepositoryPost */ 'hunkUrlTemplate'?: string; /** * The type of repository. If not specified, the default value is custom. * @type {string} * @memberof RepositoryPost */ 'type'?: RepositoryPostTypeEnum; /** * The repository\'s default branch. If not specified, the default value is main. * @type {string} * @memberof RepositoryPost */ 'defaultBranch'?: string; } export declare const RepositoryPostTypeEnum: { readonly Bitbucket: "bitbucket"; readonly Custom: "custom"; readonly Github: "github"; readonly Gitlab: "gitlab"; }; export type RepositoryPostTypeEnum = typeof RepositoryPostTypeEnum[keyof typeof RepositoryPostTypeEnum]; /** * * @export * @interface RepositoryRep */ export interface RepositoryRep { /** * The repository name * @type {string} * @memberof RepositoryRep */ 'name': string; /** * A URL to access the repository * @type {string} * @memberof RepositoryRep */ 'sourceLink'?: string; /** * A template for constructing a valid URL to view the commit * @type {string} * @memberof RepositoryRep */ 'commitUrlTemplate'?: string; /** * A template for constructing a valid URL to view the hunk * @type {string} * @memberof RepositoryRep */ 'hunkUrlTemplate'?: string; /** * The type of repository * @type {string} * @memberof RepositoryRep */ 'type': RepositoryRepTypeEnum; /** * The repository\'s default branch * @type {string} * @memberof RepositoryRep */ 'defaultBranch': string; /** * Whether or not a repository is enabled for code reference scanning * @type {boolean} * @memberof RepositoryRep */ 'enabled': boolean; /** * The version of the repository\'s saved information * @type {number} * @memberof RepositoryRep */ 'version': number; /** * An array of the repository\'s branches that have been scanned for code references * @type {Array} * @memberof RepositoryRep */ 'branches'?: Array; /** * * @type {{ [key: string]: any; }} * @memberof RepositoryRep */ '_links': { [key: string]: any; }; /** * * @type {Access} * @memberof RepositoryRep */ '_access'?: Access; } export declare const RepositoryRepTypeEnum: { readonly Bitbucket: "bitbucket"; readonly Custom: "custom"; readonly Github: "github"; readonly Gitlab: "gitlab"; }; export type RepositoryRepTypeEnum = typeof RepositoryRepTypeEnum[keyof typeof RepositoryRepTypeEnum]; /** * * @export * @interface ResourceAccess */ export interface ResourceAccess { /** * * @type {string} * @memberof ResourceAccess */ 'action'?: string; /** * * @type {string} * @memberof ResourceAccess */ 'resource'?: string; } /** * * @export * @interface ResourceIDResponse */ export interface ResourceIDResponse { /** * * @type {string} * @memberof ResourceIDResponse */ 'kind'?: string; /** * * @type {string} * @memberof ResourceIDResponse */ 'projectKey'?: string; /** * * @type {string} * @memberof ResourceIDResponse */ 'environmentKey'?: string; /** * * @type {string} * @memberof ResourceIDResponse */ 'flagKey'?: string; /** * * @type {string} * @memberof ResourceIDResponse */ 'key'?: string; } /** * * @export * @interface ResourceId */ export interface ResourceId { /** * The environment key * @type {string} * @memberof ResourceId */ 'environmentKey'?: string; /** * Deprecated, use key instead * @type {string} * @memberof ResourceId * @deprecated */ 'flagKey'?: string; /** * The key of the flag or segment * @type {string} * @memberof ResourceId */ 'key'?: string; /** * * @type {string} * @memberof ResourceId */ 'kind'?: string; /** * The project key * @type {string} * @memberof ResourceId */ 'projectKey'?: string; } /** * * @export * @interface ReviewOutput */ export interface ReviewOutput { /** * * @type {string} * @memberof ReviewOutput */ '_id': string; /** * * @type {string} * @memberof ReviewOutput */ 'kind': string; /** * * @type {number} * @memberof ReviewOutput */ 'creationDate'?: number; /** * * @type {string} * @memberof ReviewOutput */ 'comment'?: string; /** * * @type {string} * @memberof ReviewOutput */ 'memberId'?: string; /** * * @type {string} * @memberof ReviewOutput */ 'serviceTokenId'?: string; } /** * * @export * @interface ReviewResponse */ export interface ReviewResponse { /** * The approval request ID * @type {string} * @memberof ReviewResponse */ '_id': string; /** * The type of review action to take * @type {string} * @memberof ReviewResponse */ 'kind': ReviewResponseKindEnum; /** * * @type {number} * @memberof ReviewResponse */ 'creationDate'?: number; /** * A comment describing the approval response * @type {string} * @memberof ReviewResponse */ 'comment'?: string; /** * ID of account member that reviewed request * @type {string} * @memberof ReviewResponse */ 'memberId'?: string; /** * ID of account service token that reviewed request * @type {string} * @memberof ReviewResponse */ 'serviceTokenId'?: string; } export declare const ReviewResponseKindEnum: { readonly Approve: "approve"; readonly Decline: "decline"; readonly Comment: "comment"; }; export type ReviewResponseKindEnum = typeof ReviewResponseKindEnum[keyof typeof ReviewResponseKindEnum]; /** * * @export * @interface Rollout */ export interface Rollout { /** * * @type {Array} * @memberof Rollout */ 'variations': Array; /** * * @type {ExperimentAllocationRep} * @memberof Rollout */ 'experimentAllocation'?: ExperimentAllocationRep; /** * * @type {number} * @memberof Rollout */ 'seed'?: number; /** * * @type {string} * @memberof Rollout */ 'bucketBy'?: string; /** * * @type {string} * @memberof Rollout */ 'contextKind'?: string; } /** * * @export * @interface RootResponse */ export interface RootResponse { /** * * @type {{ [key: string]: Link; }} * @memberof RootResponse */ 'links': { [key: string]: Link; }; } /** * * @export * @interface Rule */ export interface Rule { /** * The flag rule ID * @type {string} * @memberof Rule */ '_id'?: string; /** * The index of the variation, from the array of variations for this flag * @type {number} * @memberof Rule */ 'variation'?: number; /** * * @type {Rollout} * @memberof Rule */ 'rollout'?: Rollout; /** * An array of clauses used for individual targeting based on attributes * @type {Array} * @memberof Rule */ 'clauses': Array; /** * Whether LaunchDarkly tracks events for this rule * @type {boolean} * @memberof Rule */ 'trackEvents': boolean; /** * The rule description * @type {string} * @memberof Rule */ 'description'?: string; /** * * @type {string} * @memberof Rule */ 'ref'?: string; } /** * * @export * @interface RuleClause */ export interface RuleClause { /** * The attribute the rule applies to, for example, last name or email address * @type {string} * @memberof RuleClause */ 'attribute'?: string; /** * The operator to apply to the given attribute * @type {string} * @memberof RuleClause */ 'op'?: RuleClauseOpEnum; /** * Whether the operator should be negated * @type {boolean} * @memberof RuleClause */ 'negate'?: boolean; } export declare const RuleClauseOpEnum: { readonly In: "in"; readonly EndsWith: "endsWith"; readonly StartsWith: "startsWith"; readonly Matches: "matches"; readonly Contains: "contains"; readonly LessThan: "lessThan"; readonly LessThanOrEqual: "lessThanOrEqual"; readonly GreaterThan: "greaterThan"; readonly GreaterThanOrEqual: "greaterThanOrEqual"; readonly Before: "before"; readonly After: "after"; readonly SegmentMatch: "segmentMatch"; readonly SemVerEqual: "semVerEqual"; readonly SemVerLessThan: "semVerLessThan"; readonly SemVerGreaterThan: "semVerGreaterThan"; }; export type RuleClauseOpEnum = typeof RuleClauseOpEnum[keyof typeof RuleClauseOpEnum]; /** * * @export * @interface SdkListRep */ export interface SdkListRep { /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof SdkListRep */ '_links': { [key: string]: any; }; /** * The list of SDK names * @type {Array} * @memberof SdkListRep */ 'sdks': Array; } /** * * @export * @interface SdkVersionListRep */ export interface SdkVersionListRep { /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof SdkVersionListRep */ '_links': { [key: string]: any; }; /** * The list of SDK names and versions * @type {Array} * @memberof SdkVersionListRep */ 'sdkVersions': Array; } /** * * @export * @interface SdkVersionRep */ export interface SdkVersionRep { /** * The SDK name, or \"Unknown\" * @type {string} * @memberof SdkVersionRep */ 'sdk': string; /** * The version number, or \"Unknown\" * @type {string} * @memberof SdkVersionRep */ 'version': string; } /** * * @export * @interface SegmentBody */ export interface SegmentBody { /** * A human-friendly name for the segment * @type {string} * @memberof SegmentBody */ 'name': string; /** * A unique key used to reference the segment * @type {string} * @memberof SegmentBody */ 'key': string; /** * A description of the segment\'s purpose * @type {string} * @memberof SegmentBody */ 'description'?: string; /** * Tags for the segment * @type {Array} * @memberof SegmentBody */ 'tags'?: Array; /** * Whether to create a standard segment (false) or a big segment (true). Standard segments include rule-based and smaller list-based segments. Big segments include larger list-based segments and synced segments. Only use a big segment if you need to add more than 15,000 individual targets. * @type {boolean} * @memberof SegmentBody */ 'unbounded'?: boolean; /** * For big segments, the targeted context kind. * @type {string} * @memberof SegmentBody */ 'unboundedContextKind'?: string; } /** * * @export * @interface SegmentMetadata */ export interface SegmentMetadata { /** * * @type {string} * @memberof SegmentMetadata */ 'envId'?: string; /** * * @type {string} * @memberof SegmentMetadata */ 'segmentId'?: string; /** * * @type {number} * @memberof SegmentMetadata */ 'version'?: number; /** * * @type {number} * @memberof SegmentMetadata */ 'includedCount'?: number; /** * * @type {number} * @memberof SegmentMetadata */ 'excludedCount'?: number; /** * * @type {number} * @memberof SegmentMetadata */ 'lastModified'?: number; /** * * @type {boolean} * @memberof SegmentMetadata */ 'deleted'?: boolean; } /** * * @export * @interface SegmentTarget */ export interface SegmentTarget { /** * * @type {Array} * @memberof SegmentTarget */ 'values'?: Array; /** * * @type {string} * @memberof SegmentTarget */ 'contextKind'?: string; } /** * * @export * @interface SegmentUserList */ export interface SegmentUserList { /** * * @type {Array} * @memberof SegmentUserList */ 'add'?: Array; /** * * @type {Array} * @memberof SegmentUserList */ 'remove'?: Array; } /** * * @export * @interface SegmentUserState */ export interface SegmentUserState { /** * * @type {SegmentUserList} * @memberof SegmentUserState */ 'included'?: SegmentUserList; /** * * @type {SegmentUserList} * @memberof SegmentUserState */ 'excluded'?: SegmentUserList; } /** * * @export * @interface Series */ export interface Series { /** * The timestamp * @type {number} * @memberof Series */ 'time': number; /** * The value for the given timestamp * @type {number} * @memberof Series */ 'value': number; } /** * * @export * @interface SeriesIntervalsRep */ export interface SeriesIntervalsRep { /** * An array of timestamps and values for a given meter * @type {Array} * @memberof SeriesIntervalsRep */ 'series': Array; /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof SeriesIntervalsRep */ '_links': { [key: string]: any; }; } /** * * @export * @interface SeriesListRep */ export interface SeriesListRep { /** * The location and content type of related resources * @type {{ [key: string]: any; }} * @memberof SeriesListRep */ '_links': { [key: string]: any; }; /** * Metadata about each series * @type {Array<{ [key: string]: any; }>} * @memberof SeriesListRep */ 'metadata': Array<{ [key: string]: any; }>; /** * An array of data points with timestamps. Each element of the array is an object with a \'time\' field, whose value is the timestamp, and one or more key fields. If there are multiple key fields, they are labeled \'0\', \'1\', and so on, and are explained in the metadata. * @type {Array<{ [key: string]: number; }>} * @memberof SeriesListRep */ 'series': Array<{ [key: string]: number; }>; } /** * * @export * @interface SimpleHoldoutRep */ export interface SimpleHoldoutRep { /** * * @type {string} * @memberof SimpleHoldoutRep */ '_id'?: string; /** * * @type {string} * @memberof SimpleHoldoutRep */ 'key'?: string; /** * * @type {string} * @memberof SimpleHoldoutRep */ 'name'?: string; /** * * @type {string} * @memberof SimpleHoldoutRep */ 'status'?: string; /** * * @type {number} * @memberof SimpleHoldoutRep */ 'createdAt'?: number; /** * * @type {number} * @memberof SimpleHoldoutRep */ 'updatedAt'?: number; /** * * @type {Array} * @memberof SimpleHoldoutRep */ 'experiments'?: Array; } /** * * @export * @interface SlicedResultsRep */ export interface SlicedResultsRep { /** * An attribute that results are sliced by * @type {string} * @memberof SlicedResultsRep */ 'attribute'?: string; /** * Attribute Value for \'attribute\' * @type {string} * @memberof SlicedResultsRep */ 'attributeValue'?: string; /** * A list of the results for each treatment * @type {Array} * @memberof SlicedResultsRep */ 'treatmentResults'?: Array; } /** * * @export * @interface SourceEnv */ export interface SourceEnv { /** * The key of the source environment to clone from * @type {string} * @memberof SourceEnv */ 'key'?: string; /** * (Optional) The version number of the source environment to clone from. Used for optimistic locking * @type {number} * @memberof SourceEnv */ 'version'?: number; } /** * * @export * @interface SourceFlag */ export interface SourceFlag { /** * The environment key for the source environment * @type {string} * @memberof SourceFlag */ 'key': string; /** * The version of the source flag from which to copy * @type {number} * @memberof SourceFlag */ 'version'?: number; } /** * * @export * @interface StageInput */ export interface StageInput { /** * The stage name * @type {string} * @memberof StageInput */ 'name'?: string; /** * Whether to execute the conditions in sequence for the given stage * @type {boolean} * @memberof StageInput */ 'executeConditionsInSequence'?: boolean; /** * An array of conditions for the stage * @type {Array} * @memberof StageInput */ 'conditions'?: Array; /** * * @type {ActionInput} * @memberof StageInput */ 'action'?: ActionInput; } /** * * @export * @interface StageOutput */ export interface StageOutput { /** * The ID of this stage * @type {string} * @memberof StageOutput */ '_id': string; /** * The stage name * @type {string} * @memberof StageOutput */ 'name'?: string; /** * An array of conditions for the stage * @type {Array} * @memberof StageOutput */ 'conditions': Array; /** * * @type {ActionOutput} * @memberof StageOutput */ 'action': ActionOutput; /** * * @type {ExecutionOutput} * @memberof StageOutput */ '_execution': ExecutionOutput; } /** * * @export * @interface Statement */ export interface Statement { /** * Resource specifier strings * @type {Array} * @memberof Statement */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field. * @type {Array} * @memberof Statement */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof Statement */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field. * @type {Array} * @memberof Statement */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof Statement */ 'effect': StatementEffectEnum; } export declare const StatementEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type StatementEffectEnum = typeof StatementEffectEnum[keyof typeof StatementEffectEnum]; /** * * @export * @interface StatementPost */ export interface StatementPost { /** * Resource specifier strings * @type {Array} * @memberof StatementPost */ 'resources'?: Array; /** * Targeted resources are the resources NOT in this list. The resources field must be empty to use this field. * @type {Array} * @memberof StatementPost */ 'notResources'?: Array; /** * Actions to perform on a resource * @type {Array} * @memberof StatementPost */ 'actions'?: Array; /** * Targeted actions are the actions NOT in this list. The actions field must be empty to use this field. * @type {Array} * @memberof StatementPost */ 'notActions'?: Array; /** * Whether this statement should allow or deny actions on the resources. * @type {string} * @memberof StatementPost */ 'effect': StatementPostEffectEnum; } export declare const StatementPostEffectEnum: { readonly Allow: "allow"; readonly Deny: "deny"; }; export type StatementPostEffectEnum = typeof StatementPostEffectEnum[keyof typeof StatementPostEffectEnum]; /** * * @export * @interface StatisticCollectionRep */ export interface StatisticCollectionRep { /** * A map of flag keys to a list of code reference statistics for each code repository in which the flag key appears * @type {{ [key: string]: Array; }} * @memberof StatisticCollectionRep */ 'flags': { [key: string]: Array; }; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof StatisticCollectionRep */ '_links': { [key: string]: Link; }; } /** * * @export * @interface StatisticRep */ export interface StatisticRep { /** * The repository name * @type {string} * @memberof StatisticRep */ 'name': string; /** * The type of repository * @type {string} * @memberof StatisticRep */ 'type': StatisticRepTypeEnum; /** * A URL to access the repository * @type {string} * @memberof StatisticRep */ 'sourceLink': string; /** * The repository\'s default branch * @type {string} * @memberof StatisticRep */ 'defaultBranch': string; /** * Whether or not a repository is enabled for code reference scanning * @type {boolean} * @memberof StatisticRep */ 'enabled': boolean; /** * The version of the repository\'s saved information * @type {number} * @memberof StatisticRep */ 'version': number; /** * The number of code reference hunks in which the flag appears in this repository * @type {number} * @memberof StatisticRep */ 'hunkCount': number; /** * The number of files in which the flag appears in this repository * @type {number} * @memberof StatisticRep */ 'fileCount': number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof StatisticRep */ '_links': { [key: string]: Link; }; /** * * @type {number} * @memberof StatisticRep */ 'latestCommitTime'?: number; } export declare const StatisticRepTypeEnum: { readonly Bitbucket: "bitbucket"; readonly Custom: "custom"; readonly Github: "github"; readonly Gitlab: "gitlab"; }; export type StatisticRepTypeEnum = typeof StatisticRepTypeEnum[keyof typeof StatisticRepTypeEnum]; /** * * @export * @interface StatisticsRoot */ export interface StatisticsRoot { /** * The location and content type of all projects that have code references * @type {Array} * @memberof StatisticsRoot */ 'projects'?: Array; /** * * @type {Link} * @memberof StatisticsRoot */ 'self'?: Link; } /** * * @export * @interface StatusConflictErrorRep */ export interface StatusConflictErrorRep { /** * Specific error code encountered * @type {string} * @memberof StatusConflictErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof StatusConflictErrorRep */ 'message': string; } /** * * @export * @interface StatusResponse */ export interface StatusResponse { /** * * @type {string} * @memberof StatusResponse */ 'integrationId'?: string; /** * * @type {string} * @memberof StatusResponse */ 'message'?: string; /** * * @type {number} * @memberof StatusResponse */ 'statusCode'?: number; /** * * @type {number} * @memberof StatusResponse */ 'timestamp'?: number; } /** * * @export * @interface StatusServiceUnavailable */ export interface StatusServiceUnavailable { /** * Specific error code encountered * @type {string} * @memberof StatusServiceUnavailable */ 'code': string; /** * Description of the error * @type {string} * @memberof StatusServiceUnavailable */ 'message': string; } /** * * @export * @interface StoreIntegrationError */ export interface StoreIntegrationError { /** * * @type {number} * @memberof StoreIntegrationError */ 'statusCode'?: number; /** * * @type {string} * @memberof StoreIntegrationError */ 'message'?: string; /** * * @type {number} * @memberof StoreIntegrationError */ 'timestamp'?: number; } /** * * @export * @interface SubjectDataRep */ export interface SubjectDataRep { /** * * @type {{ [key: string]: Link; }} * @memberof SubjectDataRep */ '_links'?: { [key: string]: Link; }; /** * The subject\'s name * @type {string} * @memberof SubjectDataRep */ 'name'?: string; /** * The subject\'s avatar * @type {string} * @memberof SubjectDataRep */ 'avatarUrl'?: string; } /** * * @export * @interface SubscriptionPost */ export interface SubscriptionPost { /** * A human-friendly name for your audit log subscription. * @type {string} * @memberof SubscriptionPost */ 'name': string; /** * * @type {Array} * @memberof SubscriptionPost */ 'statements'?: Array; /** * Whether or not you want your subscription to actively send events. * @type {boolean} * @memberof SubscriptionPost */ 'on'?: boolean; /** * An array of tags for this subscription. * @type {Array} * @memberof SubscriptionPost */ 'tags'?: Array; /** * The unique set of fields required to configure an audit log subscription integration of this type. Refer to the formVariables field in the corresponding manifest.json at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure. * @type {{ [key: string]: any; }} * @memberof SubscriptionPost */ 'config': { [key: string]: any; }; /** * Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations. * @type {string} * @memberof SubscriptionPost */ 'url'?: string; /** * Datadog API key. Only necessary for legacy Datadog webhook integrations. * @type {string} * @memberof SubscriptionPost */ 'apiKey'?: string; } /** * * @export * @interface TagsCollection */ export interface TagsCollection { /** * List of tags * @type {Array} * @memberof TagsCollection */ 'items': Array; /** * * @type {{ [key: string]: TagsLink; }} * @memberof TagsCollection */ '_links': { [key: string]: TagsLink; }; /** * The total number of tags * @type {number} * @memberof TagsCollection */ 'totalCount'?: number; } /** * * @export * @interface TagsLink */ export interface TagsLink { /** * * @type {string} * @memberof TagsLink */ 'href'?: string; /** * * @type {string} * @memberof TagsLink */ 'type'?: string; } /** * * @export * @interface Target */ export interface Target { /** * A list of the keys for targets that will receive this variation because of individual targeting * @type {Array} * @memberof Target */ 'values': Array; /** * The index, from the array of variations for this flag, of the variation to serve this list of targets * @type {number} * @memberof Target */ 'variation': number; /** * The context kind of the individual target * @type {string} * @memberof Target */ 'contextKind'?: string; } /** * * @export * @interface TargetResourceRep */ export interface TargetResourceRep { /** * * @type {{ [key: string]: Link; }} * @memberof TargetResourceRep */ '_links'?: { [key: string]: Link; }; /** * The name of the resource * @type {string} * @memberof TargetResourceRep */ 'name'?: string; /** * The resource specifier * @type {Array} * @memberof TargetResourceRep */ 'resources'?: Array; } /** * * @export * @interface Team */ export interface Team { /** * A description of the team * @type {string} * @memberof Team */ 'description'?: string; /** * The team key * @type {string} * @memberof Team */ 'key'?: string; /** * A human-friendly name for the team * @type {string} * @memberof Team */ 'name'?: string; /** * * @type {Access} * @memberof Team */ '_access'?: Access; /** * * @type {number} * @memberof Team */ '_creationDate'?: number; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Team */ '_links'?: { [key: string]: Link; }; /** * * @type {number} * @memberof Team */ '_lastModified'?: number; /** * The team version * @type {number} * @memberof Team */ '_version'?: number; /** * Whether the team has been synced with an external identity provider (IdP). Team sync is available to customers on an Enterprise plan. * @type {boolean} * @memberof Team */ '_idpSynced'?: boolean; /** * * @type {{ [key: string]: Array; }} * @memberof Team */ 'roleAttributes'?: { [key: string]: Array; }; /** * * @type {TeamCustomRoles} * @memberof Team */ 'roles'?: TeamCustomRoles; /** * * @type {TeamMembers} * @memberof Team */ 'members'?: TeamMembers; /** * * @type {TeamProjects} * @memberof Team */ 'projects'?: TeamProjects; /** * * @type {TeamMaintainers} * @memberof Team */ 'maintainers'?: TeamMaintainers; } /** * * @export * @interface TeamCustomRole */ export interface TeamCustomRole { /** * The key of the custom role * @type {string} * @memberof TeamCustomRole */ 'key'?: string; /** * The name of the custom role * @type {string} * @memberof TeamCustomRole */ 'name'?: string; /** * * @type {TeamProjects} * @memberof TeamCustomRole */ 'projects'?: TeamProjects; /** * * @type {number} * @memberof TeamCustomRole */ 'appliedOn'?: number; } /** * * @export * @interface TeamCustomRoles */ export interface TeamCustomRoles { /** * The number of custom roles assigned to this team * @type {number} * @memberof TeamCustomRoles */ 'totalCount'?: number; /** * An array of the custom roles that have been assigned to this team * @type {Array} * @memberof TeamCustomRoles */ 'items'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof TeamCustomRoles */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface TeamImportsRep */ export interface TeamImportsRep { /** * An array of details about the members requested to be added to this team * @type {Array} * @memberof TeamImportsRep */ 'items'?: Array; } /** * * @export * @interface TeamMaintainers */ export interface TeamMaintainers { /** * The number of maintainers of the team * @type {number} * @memberof TeamMaintainers */ 'totalCount'?: number; /** * Details on the members that have been assigned as maintainers of the team * @type {Array} * @memberof TeamMaintainers */ 'items'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof TeamMaintainers */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface TeamMembers */ export interface TeamMembers { /** * The total count of members that belong to the team * @type {number} * @memberof TeamMembers */ 'totalCount'?: number; } /** * * @export * @interface TeamPatchInput */ export interface TeamPatchInput { /** * Optional comment describing the update * @type {string} * @memberof TeamPatchInput */ 'comment'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof TeamPatchInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface TeamPostInput */ export interface TeamPostInput { /** * List of custom role keys the team will access * @type {Array} * @memberof TeamPostInput */ 'customRoleKeys'?: Array; /** * A description of the team * @type {string} * @memberof TeamPostInput */ 'description'?: string; /** * The team key * @type {string} * @memberof TeamPostInput */ 'key': string; /** * A list of member IDs who belong to the team * @type {Array} * @memberof TeamPostInput */ 'memberIDs'?: Array; /** * A human-friendly name for the team * @type {string} * @memberof TeamPostInput */ 'name': string; /** * A list of permission grants. Permission grants allow access to a specific action, without having to create or update a custom role. * @type {Array} * @memberof TeamPostInput */ 'permissionGrants'?: Array; /** * * @type {{ [key: string]: Array; }} * @memberof TeamPostInput */ 'roleAttributes'?: { [key: string]: Array; }; } /** * * @export * @interface TeamProjects */ export interface TeamProjects { /** * * @type {number} * @memberof TeamProjects */ 'totalCount'?: number; /** * Details on each project where team members have write privileges on at least one resource type (e.g. flags) * @type {Array} * @memberof TeamProjects */ 'items'?: Array; } /** * * @export * @interface Teams */ export interface Teams { /** * An array of teams * @type {Array} * @memberof Teams */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Teams */ '_links'?: { [key: string]: Link; }; /** * The number of teams * @type {number} * @memberof Teams */ 'totalCount'?: number; } /** * * @export * @interface TeamsPatchInput */ export interface TeamsPatchInput { /** * Optional comment describing the update * @type {string} * @memberof TeamsPatchInput */ 'comment'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof TeamsPatchInput */ 'instructions': Array<{ [key: string]: any; }>; } /** * * @export * @interface TimestampRep */ export interface TimestampRep { /** * * @type {number} * @memberof TimestampRep */ 'milliseconds'?: number; /** * * @type {number} * @memberof TimestampRep */ 'seconds'?: number; /** * * @type {string} * @memberof TimestampRep */ 'rfc3339'?: string; /** * * @type {string} * @memberof TimestampRep */ 'simple'?: string; } /** * * @export * @interface Token */ export interface Token { /** * * @type {string} * @memberof Token */ '_id': string; /** * * @type {string} * @memberof Token */ 'ownerId': string; /** * * @type {string} * @memberof Token */ 'memberId': string; /** * * @type {MemberSummary} * @memberof Token */ '_member'?: MemberSummary; /** * A human-friendly name for the access token * @type {string} * @memberof Token */ 'name'?: string; /** * A description for the access token * @type {string} * @memberof Token */ 'description'?: string; /** * * @type {number} * @memberof Token */ 'creationDate': number; /** * * @type {number} * @memberof Token */ 'lastModified': number; /** * A list of custom role IDs to use as access limits for the access token * @type {Array} * @memberof Token */ 'customRoleIds'?: Array; /** * An array of policy statements, with three attributes: effect, resources, actions. May be used in place of a built-in or custom role. * @type {Array} * @memberof Token */ 'inlineRole'?: Array; /** * Built-in role for the token * @type {string} * @memberof Token */ 'role'?: string; /** * The token value. When creating or resetting, contains the entire token value. Otherwise, contains the last four characters. * @type {string} * @memberof Token */ 'token'?: string; /** * Whether this is a service token or a personal token * @type {boolean} * @memberof Token */ 'serviceToken'?: boolean; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Token */ '_links': { [key: string]: Link; }; /** * The default API version for this token * @type {number} * @memberof Token */ 'defaultApiVersion'?: number; /** * * @type {number} * @memberof Token */ 'lastUsed'?: number; } /** * * @export * @interface TokenSummary */ export interface TokenSummary { /** * * @type {{ [key: string]: Link; }} * @memberof TokenSummary */ '_links'?: { [key: string]: Link; }; /** * * @type {string} * @memberof TokenSummary */ '_id'?: string; /** * The name of the token * @type {string} * @memberof TokenSummary */ 'name'?: string; /** * The last few characters of the token * @type {string} * @memberof TokenSummary */ 'ending'?: string; /** * Whether this is a service token * @type {boolean} * @memberof TokenSummary */ 'serviceToken'?: boolean; } /** * * @export * @interface Tokens */ export interface Tokens { /** * An array of access tokens * @type {Array} * @memberof Tokens */ 'items'?: Array; /** * * @type {{ [key: string]: Link; }} * @memberof Tokens */ '_links'?: { [key: string]: Link; }; /** * The number of access tokens returned * @type {number} * @memberof Tokens */ 'totalCount'?: number; } /** * * @export * @interface TreatmentInput */ export interface TreatmentInput { /** * The treatment name * @type {string} * @memberof TreatmentInput */ 'name': string; /** * Whether this treatment is the baseline to compare other treatments against * @type {boolean} * @memberof TreatmentInput */ 'baseline': boolean; /** * The percentage of traffic allocated to this treatment during the iteration * @type {string} * @memberof TreatmentInput */ 'allocationPercent': string; /** * Details on the flag and variation to use for this treatment * @type {Array} * @memberof TreatmentInput */ 'parameters': Array; } /** * * @export * @interface TreatmentParameterInput */ export interface TreatmentParameterInput { /** * The flag key * @type {string} * @memberof TreatmentParameterInput */ 'flagKey': string; /** * The ID of the flag variation * @type {string} * @memberof TreatmentParameterInput */ 'variationId': string; } /** * * @export * @interface TreatmentRep */ export interface TreatmentRep { /** * The treatment ID. This is the variation ID from the flag. * @type {string} * @memberof TreatmentRep */ '_id'?: string; /** * The treatment name. This is the variation name from the flag. * @type {string} * @memberof TreatmentRep */ 'name': string; /** * The percentage of traffic allocated to this treatment during the iteration * @type {string} * @memberof TreatmentRep */ 'allocationPercent': string; /** * Whether this treatment is the baseline to compare other treatments against * @type {boolean} * @memberof TreatmentRep */ 'baseline'?: boolean; /** * Details on the flag and variation used for this treatment * @type {Array} * @memberof TreatmentRep */ 'parameters'?: Array; } /** * * @export * @interface TreatmentResultRep */ export interface TreatmentResultRep { /** * The ID of the treatment * @type {string} * @memberof TreatmentResultRep */ 'treatmentId'?: string; /** * The name of the treatment * @type {string} * @memberof TreatmentResultRep */ 'treatmentName'?: string; /** * The average value of the variation in this sample. It doesn’t capture the uncertainty in the measurement, so it should not be the only measurement you use to make decisions. * @type {number} * @memberof TreatmentResultRep */ 'mean'?: number; /** * The mean of the data, with no priors effecting the result. * @type {number} * @memberof TreatmentResultRep */ 'dataMean'?: number; /** * The standard deviation of the data, with no priors effecting the result. * @type {number} * @memberof TreatmentResultRep */ 'dataStdDev'?: number; /** * * @type {CredibleIntervalRep} * @memberof TreatmentResultRep */ 'credibleInterval'?: CredibleIntervalRep; /** * The likelihood that this variation has the biggest effect on the primary metric. The variation with the highest probability is likely the best of the variations you\'re testing * @type {number} * @memberof TreatmentResultRep */ 'pBest'?: number; /** * Estimates of the relative difference between this treatment\'s mean and the mean of each other treatment * @type {Array} * @memberof TreatmentResultRep */ 'relativeDifferences'?: Array; /** * The number of units exposed to this treatment that have event values, including those that are configured to default to 0 * @type {number} * @memberof TreatmentResultRep */ 'units'?: number; /** * The number of units exposed to this treatment. * @type {number} * @memberof TreatmentResultRep */ 'traffic'?: number; /** * The sum of the event values for the units exposed to this treatment. * @type {number} * @memberof TreatmentResultRep */ 'eventValuesSum'?: number; /** * * @type {Distribution} * @memberof TreatmentResultRep */ 'distribution'?: Distribution; /** * The outcome-covariate correlation * @type {number} * @memberof TreatmentResultRep */ 'correlation'?: number; /** * The ratio of the outcome SD to covariate SD * @type {number} * @memberof TreatmentResultRep */ 'standardDeviationRatio'?: number; /** * The imbalance between the covariate mean for the arm and the covariate mean for the experiment * @type {number} * @memberof TreatmentResultRep */ 'covariateImbalance'?: number; /** * The reduction in variance resulting from CUPED * @type {number} * @memberof TreatmentResultRep */ 'varianceReduction'?: number; /** * The model used to calculate the results. Parameters specific to this model will be defined under the field under the same name * @type {string} * @memberof TreatmentResultRep */ 'model'?: TreatmentResultRepModelEnum; /** * * @type {BayesianNormalStatsRep} * @memberof TreatmentResultRep */ 'bayesianNormal'?: BayesianNormalStatsRep; /** * * @type {BayesianBetaBinomialStatsRep} * @memberof TreatmentResultRep */ 'bayesianBeta'?: BayesianBetaBinomialStatsRep; } export declare const TreatmentResultRepModelEnum: { readonly BayesianNormal: "bayesianNormal"; readonly BayesianBeta: "bayesianBeta"; }; export type TreatmentResultRepModelEnum = typeof TreatmentResultRepModelEnum[keyof typeof TreatmentResultRepModelEnum]; /** * * @export * @interface TriggerPost */ export interface TriggerPost { /** * Optional comment describing the trigger * @type {string} * @memberof TriggerPost */ 'comment'?: string; /** * The action to perform when triggering. This should be an array with a single object that looks like {\"kind\": \"flag_action\"}. Supported flag actions are turnFlagOn and turnFlagOff. * @type {Array<{ [key: string]: any; }>} * @memberof TriggerPost */ 'instructions'?: Array<{ [key: string]: any; }>; /** * The unique identifier of the integration for your trigger. Use generic-trigger for integrations not explicitly supported. * @type {string} * @memberof TriggerPost */ 'integrationKey': string; } /** * * @export * @interface TriggerWorkflowCollectionRep */ export interface TriggerWorkflowCollectionRep { /** * An array of flag triggers * @type {Array} * @memberof TriggerWorkflowCollectionRep */ 'items'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof TriggerWorkflowCollectionRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface TriggerWorkflowRep */ export interface TriggerWorkflowRep { /** * * @type {string} * @memberof TriggerWorkflowRep */ '_id'?: string; /** * The flag trigger version * @type {number} * @memberof TriggerWorkflowRep */ '_version'?: number; /** * * @type {number} * @memberof TriggerWorkflowRep */ '_creationDate'?: number; /** * The ID of the flag trigger maintainer * @type {string} * @memberof TriggerWorkflowRep */ '_maintainerId'?: string; /** * * @type {MemberSummary} * @memberof TriggerWorkflowRep */ '_maintainer'?: MemberSummary; /** * Whether the flag trigger is currently enabled * @type {boolean} * @memberof TriggerWorkflowRep */ 'enabled'?: boolean; /** * The unique identifier of the integration for your trigger * @type {string} * @memberof TriggerWorkflowRep */ '_integrationKey'?: string; /** * * @type {Array<{ [key: string]: any; }>} * @memberof TriggerWorkflowRep */ 'instructions'?: Array<{ [key: string]: any; }>; /** * * @type {number} * @memberof TriggerWorkflowRep */ '_lastTriggeredAt'?: number; /** * Details on recent flag trigger requests. * @type {Array} * @memberof TriggerWorkflowRep */ '_recentTriggerBodies'?: Array; /** * Number of times the trigger has been executed * @type {number} * @memberof TriggerWorkflowRep */ '_triggerCount'?: number; /** * The unguessable URL for this flag trigger * @type {string} * @memberof TriggerWorkflowRep */ 'triggerURL'?: string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof TriggerWorkflowRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface UnauthorizedErrorRep */ export interface UnauthorizedErrorRep { /** * Specific error code encountered * @type {string} * @memberof UnauthorizedErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof UnauthorizedErrorRep */ 'message': string; } /** * * @export * @interface UpdatePhaseStatusInput */ export interface UpdatePhaseStatusInput { /** * * @type {string} * @memberof UpdatePhaseStatusInput */ 'status'?: string; /** * Extra configuration for audiences required upon phase initialization. * @type {Array} * @memberof UpdatePhaseStatusInput */ 'audiences'?: Array; } /** * * @export * @interface UpdateReleasePipelineInput */ export interface UpdateReleasePipelineInput { /** * The release pipeline description * @type {string} * @memberof UpdateReleasePipelineInput */ 'description'?: string; /** * The name of the release pipeline * @type {string} * @memberof UpdateReleasePipelineInput */ 'name': string; /** * A logical grouping of one or more environments that share attributes for rolling out changes * @type {Array} * @memberof UpdateReleasePipelineInput */ 'phases': Array; /** * A list of tags for this release pipeline * @type {Array} * @memberof UpdateReleasePipelineInput */ 'tags'?: Array; } /** * * @export * @interface UpsertContextKindPayload */ export interface UpsertContextKindPayload { /** * The context kind name * @type {string} * @memberof UpsertContextKindPayload */ 'name': string; /** * The context kind description * @type {string} * @memberof UpsertContextKindPayload */ 'description'?: string; /** * Alias for archived. * @type {boolean} * @memberof UpsertContextKindPayload */ 'hideInTargeting'?: boolean; /** * Whether the context kind is archived. Archived context kinds are unavailable for targeting. * @type {boolean} * @memberof UpsertContextKindPayload */ 'archived'?: boolean; /** * The context kind version. If not specified when the context kind is created, defaults to 1. * @type {number} * @memberof UpsertContextKindPayload */ 'version'?: number; } /** * * @export * @interface UpsertFlagDefaultsPayload */ export interface UpsertFlagDefaultsPayload { /** * A list of default tags for each flag * @type {Array} * @memberof UpsertFlagDefaultsPayload */ 'tags': Array; /** * Whether the flag should be temporary by default * @type {boolean} * @memberof UpsertFlagDefaultsPayload */ 'temporary': boolean; /** * * @type {BooleanFlagDefaults} * @memberof UpsertFlagDefaultsPayload */ 'booleanDefaults': BooleanFlagDefaults; /** * * @type {DefaultClientSideAvailability} * @memberof UpsertFlagDefaultsPayload */ 'defaultClientSideAvailability': DefaultClientSideAvailability; } /** * * @export * @interface UpsertPayloadRep */ export interface UpsertPayloadRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof UpsertPayloadRep */ '_links'?: { [key: string]: Link; }; /** * A list of default tags for each flag * @type {Array} * @memberof UpsertPayloadRep */ 'tags': Array; /** * Whether the flag should be temporary by default * @type {boolean} * @memberof UpsertPayloadRep */ 'temporary': boolean; /** * * @type {BooleanFlagDefaults} * @memberof UpsertPayloadRep */ 'booleanDefaults': BooleanFlagDefaults; /** * * @type {DefaultClientSideAvailability} * @memberof UpsertPayloadRep */ 'defaultClientSideAvailability': DefaultClientSideAvailability; } /** * * @export * @interface UpsertResponseRep */ export interface UpsertResponseRep { /** * The status of the create or update operation * @type {string} * @memberof UpsertResponseRep */ 'status'?: string; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof UpsertResponseRep */ '_links'?: { [key: string]: Link; }; } /** * * @export * @interface UrlPost */ export interface UrlPost { /** * * @type {string} * @memberof UrlPost */ 'kind'?: UrlPostKindEnum; /** * * @type {string} * @memberof UrlPost */ 'url'?: string; /** * * @type {string} * @memberof UrlPost */ 'substring'?: string; /** * * @type {string} * @memberof UrlPost */ 'pattern'?: string; } export declare const UrlPostKindEnum: { readonly Exact: "exact"; readonly Canonical: "canonical"; readonly Substring: "substring"; readonly Regex: "regex"; }; export type UrlPostKindEnum = typeof UrlPostKindEnum[keyof typeof UrlPostKindEnum]; /** * * @export * @interface User */ export interface User { /** * The user key. This is the only mandatory user attribute. * @type {string} * @memberof User */ 'key'?: string; /** * If provided, used with the user key to generate a variation in percentage rollouts * @type {string} * @memberof User */ 'secondary'?: string; /** * The user\'s IP address * @type {string} * @memberof User */ 'ip'?: string; /** * The user\'s country * @type {string} * @memberof User */ 'country'?: string; /** * The user\'s email * @type {string} * @memberof User */ 'email'?: string; /** * The user\'s first name * @type {string} * @memberof User */ 'firstName'?: string; /** * The user\'s last name * @type {string} * @memberof User */ 'lastName'?: string; /** * An absolute URL to an avatar image. * @type {string} * @memberof User */ 'avatar'?: string; /** * The user\'s full name * @type {string} * @memberof User */ 'name'?: string; /** * Whether the user is anonymous. If true, this user does not appear on the Contexts list in the LaunchDarkly user interface. * @type {boolean} * @memberof User */ 'anonymous'?: boolean; /** * Any other custom attributes for this user. Custom attributes contain any other user data that you would like to use to conditionally target your users. * @type {{ [key: string]: any; }} * @memberof User */ 'custom'?: { [key: string]: any; }; /** * A list of attribute names that are marked as private. You can use these attributes in targeting rules and segments. If you are using a server-side SDK, the SDK will not send the private attribute back to LaunchDarkly. If you are using a client-side SDK, the SDK will send the private attribute back to LaunchDarkly for evaluation. However, the SDK won\'t send the attribute to LaunchDarkly in events data, LaunchDarkly won\'t store the private attribute, and the private attribute will not appear on the Contexts list. * @type {Array} * @memberof User */ 'privateAttrs'?: Array; } /** * * @export * @interface UserAttributeNamesRep */ export interface UserAttributeNamesRep { /** * private attributes * @type {Array} * @memberof UserAttributeNamesRep */ 'private'?: Array; /** * custom attributes * @type {Array} * @memberof UserAttributeNamesRep */ 'custom'?: Array; /** * standard attributes * @type {Array} * @memberof UserAttributeNamesRep */ 'standard'?: Array; } /** * * @export * @interface UserFlagSetting */ export interface UserFlagSetting { /** * The location and content type of related resources. * @type {{ [key: string]: Link; }} * @memberof UserFlagSetting */ '_links': { [key: string]: Link; }; /** * The value of the flag variation that the user receives. If there is no defined default rule, this is null. * @type {any} * @memberof UserFlagSetting */ '_value': any; /** * Whether the user is explicitly targeted to receive a particular variation. The setting is false if you have turned off a feature flag for a user. It is null if you haven\'t assigned that user to a specific variation. * @type {any} * @memberof UserFlagSetting */ 'setting': any; /** * * @type {EvaluationReason} * @memberof UserFlagSetting */ 'reason'?: EvaluationReason; } /** * * @export * @interface UserFlagSettings */ export interface UserFlagSettings { /** * An array of flag settings for the user * @type {{ [key: string]: UserFlagSetting; }} * @memberof UserFlagSettings */ 'items': { [key: string]: UserFlagSetting; }; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof UserFlagSettings */ '_links': { [key: string]: Link; }; } /** * * @export * @interface UserRecord */ export interface UserRecord { /** * Timestamp of the last time this user was seen * @type {string} * @memberof UserRecord */ 'lastPing'?: string; /** * * @type {string} * @memberof UserRecord */ 'environmentId'?: string; /** * * @type {string} * @memberof UserRecord */ 'ownerId'?: string; /** * * @type {User} * @memberof UserRecord */ 'user'?: User; /** * If this record is returned as part of a list, the value used to sort the list. This is only included when the sort query parameter is specified. It is a time, in Unix milliseconds, if the sort is by lastSeen. It is a user key if the sort is by userKey. * @type {any} * @memberof UserRecord */ 'sortValue'?: any; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof UserRecord */ '_links'?: { [key: string]: Link; }; /** * * @type {Access} * @memberof UserRecord */ '_access'?: Access; } /** * * @export * @interface UserSegment */ export interface UserSegment { /** * A human-friendly name for the segment. * @type {string} * @memberof UserSegment */ 'name': string; /** * A description of the segment\'s purpose. Defaults to null and is omitted in the response if not provided. * @type {string} * @memberof UserSegment */ 'description'?: string; /** * Tags for the segment. Defaults to an empty array. * @type {Array} * @memberof UserSegment */ 'tags': Array; /** * * @type {number} * @memberof UserSegment */ 'creationDate': number; /** * * @type {number} * @memberof UserSegment */ 'lastModifiedDate': number; /** * A unique key used to reference the segment * @type {string} * @memberof UserSegment */ 'key': string; /** * An array of keys for included targets. Included individual targets are always segment members, regardless of segment rules. For list-based segments over 15,000 entries, also called big segments, this array is either empty or omitted. * @type {Array} * @memberof UserSegment */ 'included'?: Array; /** * An array of keys for excluded targets. Segment rules bypass individual excluded targets, so they will never be included based on rules. Excluded targets may still be included explicitly. This value is omitted for list-based segments over 15,000 entries, also called big segments. * @type {Array} * @memberof UserSegment */ 'excluded'?: Array; /** * * @type {Array} * @memberof UserSegment */ 'includedContexts'?: Array; /** * * @type {Array} * @memberof UserSegment */ 'excludedContexts'?: Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof UserSegment */ '_links': { [key: string]: Link; }; /** * An array of the targeting rules for this segment. * @type {Array} * @memberof UserSegment */ 'rules': Array; /** * Version of the segment * @type {number} * @memberof UserSegment */ 'version': number; /** * Whether the segment has been deleted * @type {boolean} * @memberof UserSegment */ 'deleted': boolean; /** * * @type {Access} * @memberof UserSegment */ '_access'?: Access; /** * A list of flags targeting this segment. Only included when getting a single segment, using the getSegment endpoint. * @type {Array} * @memberof UserSegment */ '_flags'?: Array; /** * Whether this is a standard segment (false) or a big segment (true). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. If omitted, the segment is a standard segment. * @type {boolean} * @memberof UserSegment */ 'unbounded'?: boolean; /** * For big segments, the targeted context kind. * @type {string} * @memberof UserSegment */ 'unboundedContextKind'?: string; /** * For big segments, how many times this segment has been created. * @type {number} * @memberof UserSegment */ 'generation': number; /** * * @type {SegmentMetadata} * @memberof UserSegment */ '_unboundedMetadata'?: SegmentMetadata; /** * The external data store backing this segment. Only applies to synced segments. * @type {string} * @memberof UserSegment */ '_external'?: string; /** * The URL for the external data store backing this segment. Only applies to synced segments. * @type {string} * @memberof UserSegment */ '_externalLink'?: string; /** * Whether an import is currently in progress for the specified segment. Only applies to big segments. * @type {boolean} * @memberof UserSegment */ '_importInProgress'?: boolean; } /** * * @export * @interface UserSegmentRule */ export interface UserSegmentRule { /** * * @type {string} * @memberof UserSegmentRule */ '_id'?: string; /** * * @type {Array} * @memberof UserSegmentRule */ 'clauses': Array; /** * * @type {number} * @memberof UserSegmentRule */ 'weight'?: number; /** * * @type {string} * @memberof UserSegmentRule */ 'rolloutContextKind'?: string; /** * * @type {string} * @memberof UserSegmentRule */ 'bucketBy'?: string; /** * * @type {string} * @memberof UserSegmentRule */ 'description'?: string; } /** * * @export * @interface UserSegments */ export interface UserSegments { /** * An array of segments * @type {Array} * @memberof UserSegments */ 'items': Array; /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof UserSegments */ '_links': { [key: string]: Link; }; /** * The total number of segments * @type {number} * @memberof UserSegments */ 'totalCount'?: number; } /** * * @export * @interface Users */ export interface Users { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Users */ '_links'?: { [key: string]: Link; }; /** * The total number of users in the environment * @type {number} * @memberof Users */ 'totalCount': number; /** * Details on the users * @type {Array} * @memberof Users */ 'items': Array; } /** * * @export * @interface UsersRep */ export interface UsersRep { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof UsersRep */ '_links'?: { [key: string]: Link; }; /** * The total number of users in the environment * @type {number} * @memberof UsersRep */ 'totalCount': number; /** * Details on the users * @type {Array} * @memberof UsersRep */ 'items': Array; } /** * * @export * @interface ValidationFailedErrorRep */ export interface ValidationFailedErrorRep { /** * Specific error code encountered * @type {string} * @memberof ValidationFailedErrorRep */ 'code': string; /** * Description of the error * @type {string} * @memberof ValidationFailedErrorRep */ 'message': string; /** * List of validation errors * @type {Array} * @memberof ValidationFailedErrorRep */ 'errors': Array; } /** * * @export * @interface ValuePut */ export interface ValuePut { /** * The variation value to set for the context. Must match the flag\'s variation type. * @type {any} * @memberof ValuePut */ 'setting'?: any; /** * Optional comment describing the change * @type {string} * @memberof ValuePut */ 'comment'?: string; } /** * * @export * @interface Variation */ export interface Variation { /** * The ID of the variation. Leave empty when you are creating a flag. * @type {string} * @memberof Variation */ '_id'?: string; /** * The value of the variation. For boolean flags, this must be true or false. For multivariate flags, this may be a string, number, or JSON object. * @type {any} * @memberof Variation */ 'value': any; /** * Description of the variation. Defaults to an empty string, but is omitted from the response if not set. * @type {string} * @memberof Variation */ 'description'?: string; /** * A human-friendly name for the variation. Defaults to an empty string, but is omitted from the response if not set. * @type {string} * @memberof Variation */ 'name'?: string; } /** * * @export * @interface VariationEvalSummary */ export interface VariationEvalSummary { /** * The variation value * @type {any} * @memberof VariationEvalSummary */ 'value'?: any; /** * The number of evaluations in the ten minutes before the flag event * @type {number} * @memberof VariationEvalSummary */ 'before'?: number; /** * The number of evaluations in the ten minutes after the flag event * @type {number} * @memberof VariationEvalSummary */ 'after'?: number; } /** * * @export * @interface VariationOrRolloutRep */ export interface VariationOrRolloutRep { /** * The index of the variation, from the array of variations for this flag * @type {number} * @memberof VariationOrRolloutRep */ 'variation'?: number; /** * * @type {Rollout} * @memberof VariationOrRolloutRep */ 'rollout'?: Rollout; } /** * * @export * @interface VariationSummary */ export interface VariationSummary { /** * * @type {number} * @memberof VariationSummary */ 'rules': number; /** * * @type {number} * @memberof VariationSummary */ 'nullRules': number; /** * * @type {number} * @memberof VariationSummary */ 'targets': number; /** * * @type {number} * @memberof VariationSummary */ 'contextTargets': number; /** * * @type {boolean} * @memberof VariationSummary */ 'isFallthrough'?: boolean; /** * * @type {boolean} * @memberof VariationSummary */ 'isOff'?: boolean; /** * * @type {number} * @memberof VariationSummary */ 'rollout'?: number; /** * * @type {string} * @memberof VariationSummary */ 'bucketBy'?: string; } /** * * @export * @interface VersionsRep */ export interface VersionsRep { /** * A list of all valid API versions. To learn more about our versioning, read [Versioning](https://launchdarkly.com/docs/api#versioning). * @type {Array} * @memberof VersionsRep */ 'validVersions': Array; /** * * @type {number} * @memberof VersionsRep */ 'latestVersion': number; /** * * @type {number} * @memberof VersionsRep */ 'currentVersion': number; /** * Whether the version of the API currently is use is a beta version. This is always true if you add the LD-API-Version: beta header to your request. * @type {boolean} * @memberof VersionsRep */ 'beta'?: boolean; } /** * * @export * @interface Webhook */ export interface Webhook { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Webhook */ '_links': { [key: string]: Link; }; /** * The ID of this webhook * @type {string} * @memberof Webhook */ '_id': string; /** * A human-readable name for this webhook * @type {string} * @memberof Webhook */ 'name'?: string; /** * The URL to which LaunchDarkly sends an HTTP POST payload for this webhook * @type {string} * @memberof Webhook */ 'url': string; /** * The secret for this webhook * @type {string} * @memberof Webhook */ 'secret'?: string; /** * Represents a Custom role policy, defining a resource kinds filter the webhook responds to. * @type {Array} * @memberof Webhook */ 'statements'?: Array; /** * Whether or not this webhook is enabled * @type {boolean} * @memberof Webhook */ 'on': boolean; /** * List of tags for this webhook * @type {Array} * @memberof Webhook */ 'tags': Array; /** * * @type {Access} * @memberof Webhook */ '_access'?: Access; } /** * * @export * @interface WebhookPost */ export interface WebhookPost { /** * A human-readable name for your webhook * @type {string} * @memberof WebhookPost */ 'name'?: string; /** * The URL of the remote webhook * @type {string} * @memberof WebhookPost */ 'url': string; /** * If sign is true, and the secret attribute is omitted, LaunchDarkly automatically generates a secret for you. * @type {string} * @memberof WebhookPost */ 'secret'?: string; /** * * @type {Array} * @memberof WebhookPost */ 'statements'?: Array; /** * If sign is false, the webhook does not include a signature header, and the secret can be omitted. * @type {boolean} * @memberof WebhookPost */ 'sign': boolean; /** * Whether or not this webhook is enabled. * @type {boolean} * @memberof WebhookPost */ 'on': boolean; /** * List of tags for this webhook * @type {Array} * @memberof WebhookPost */ 'tags'?: Array; } /** * * @export * @interface Webhooks */ export interface Webhooks { /** * The location and content type of related resources * @type {{ [key: string]: Link; }} * @memberof Webhooks */ '_links': { [key: string]: Link; }; /** * An array of webhooks * @type {Array} * @memberof Webhooks */ 'items': Array; } /** * * @export * @interface WeightedVariation */ export interface WeightedVariation { /** * * @type {number} * @memberof WeightedVariation */ 'variation': number; /** * * @type {number} * @memberof WeightedVariation */ 'weight': number; /** * * @type {boolean} * @memberof WeightedVariation */ '_untracked'?: boolean; } /** * * @export * @interface WorkflowTemplateMetadata */ export interface WorkflowTemplateMetadata { /** * * @type {Array} * @memberof WorkflowTemplateMetadata */ 'parameters'?: Array; } /** * * @export * @interface WorkflowTemplateOutput */ export interface WorkflowTemplateOutput { /** * * @type {string} * @memberof WorkflowTemplateOutput */ '_id': string; /** * * @type {string} * @memberof WorkflowTemplateOutput */ '_key': string; /** * * @type {string} * @memberof WorkflowTemplateOutput */ 'name'?: string; /** * * @type {number} * @memberof WorkflowTemplateOutput */ '_creationDate': number; /** * * @type {string} * @memberof WorkflowTemplateOutput */ '_ownerId': string; /** * * @type {string} * @memberof WorkflowTemplateOutput */ '_maintainerId': string; /** * * @type {{ [key: string]: Link; }} * @memberof WorkflowTemplateOutput */ '_links': { [key: string]: Link; }; /** * * @type {string} * @memberof WorkflowTemplateOutput */ 'description'?: string; /** * * @type {Array} * @memberof WorkflowTemplateOutput */ 'stages'?: Array; } /** * * @export * @interface WorkflowTemplateParameter */ export interface WorkflowTemplateParameter { /** * * @type {string} * @memberof WorkflowTemplateParameter */ '_id'?: string; /** * The path of the property to parameterize, relative to its parent condition or instruction * @type {string} * @memberof WorkflowTemplateParameter */ 'path'?: string; /** * * @type {ParameterDefault} * @memberof WorkflowTemplateParameter */ 'default'?: ParameterDefault; /** * Whether the default value is valid for the target flag and environment * @type {boolean} * @memberof WorkflowTemplateParameter */ 'valid'?: boolean; } /** * * @export * @interface WorkflowTemplatesListingOutputRep */ export interface WorkflowTemplatesListingOutputRep { /** * * @type {Array} * @memberof WorkflowTemplatesListingOutputRep */ 'items': Array; } /** * AIConfigsBetaApi - axios parameter creator * @export */ export declare const AIConfigsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete an existing AI Config. * @summary Delete AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAIConfig: (lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: AxiosRequestConfig) => Promise; /** * Delete a specific variation of an AI Config by config key and variation key. * @summary Delete AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAIConfigVariation: (lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: AxiosRequestConfig) => Promise; /** * Delete an AI model config. * @summary Delete an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteModelConfig: (lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: AxiosRequestConfig) => Promise; /** * Retrieve a specific AI Config by its key. * @summary Get AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfig: (lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: AxiosRequestConfig) => Promise; /** * Retrieve usage metrics for an AI Config by config key. * @summary Get AI Config metrics * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigMetrics: (lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: AxiosRequestConfig) => Promise; /** * Retrieve usage metrics for an AI Config by config key, with results split by variation. * @summary Get AI Config metrics by variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigMetricsByVariation: (lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: AxiosRequestConfig) => Promise; /** * Get an AI Config variation by key. The response includes all variation versions for the given variation key. * @summary Get AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigVariation: (lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all AI Configs in the given project. * @summary List AI Configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} [sort] A sort to apply to the list of AI Configs. * @param {number} [limit] The number of AI Configs to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A filter to apply to the list of AI Configs. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigs: (lDAPIVersion: 'beta', projectKey: string, sort?: string, limit?: number, offset?: number, filter?: string, options?: AxiosRequestConfig) => Promise; /** * Get an AI model config by key. * @summary Get AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModelConfig: (lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: AxiosRequestConfig) => Promise; /** * Get all AI model configs for a project. * @summary List AI model configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ listModelConfigs: (lDAPIVersion: 'beta', projectKey: string, options?: AxiosRequestConfig) => Promise; /** * Edit an existing AI Config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"description\": \"Example updated description\", \"tags\": [\"new-tag\"] } ``` * @summary Update AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigPatch} [aIConfigPatch] AI Config object to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAIConfig: (lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigPatch?: AIConfigPatch, options?: AxiosRequestConfig) => Promise; /** * Edit an existing variation of an AI Config. This creates a new version of the variation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"messages\": [ { \"role\": \"system\", \"content\": \"The new message\" } ] } ``` * @summary Update AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {AIConfigVariationPatch} [aIConfigVariationPatch] AI Config variation object to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAIConfigVariation: (lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, aIConfigVariationPatch?: AIConfigVariationPatch, options?: AxiosRequestConfig) => Promise; /** * Create a new AI Config within the given project. * @summary Create new AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {AIConfigPost} aIConfigPost AI Config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAIConfig: (lDAPIVersion: 'beta', projectKey: string, aIConfigPost: AIConfigPost, options?: AxiosRequestConfig) => Promise; /** * Create a new variation for a given AI Config. The model in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ``` * @summary Create AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAIConfigVariation: (lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigVariationPost: AIConfigVariationPost, options?: AxiosRequestConfig) => Promise; /** * Create an AI model config. You can use this in any variation for any AI Config in your project. * @summary Create an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {ModelConfigPost} modelConfigPost AI model config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postModelConfig: (lDAPIVersion: 'beta', projectKey: string, modelConfigPost: ModelConfigPost, options?: AxiosRequestConfig) => Promise; }; /** * AIConfigsBetaApi - functional programming interface * @export */ export declare const AIConfigsBetaApiFp: (configuration?: Configuration) => { /** * Delete an existing AI Config. * @summary Delete AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a specific variation of an AI Config by config key and variation key. * @summary Delete AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an AI model config. * @summary Delete an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a specific AI Config by its key. * @summary Get AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve usage metrics for an AI Config by config key. * @summary Get AI Config metrics * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigMetrics(lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve usage metrics for an AI Config by config key, with results split by variation. * @summary Get AI Config metrics by variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigMetricsByVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get an AI Config variation by key. The response includes all variation versions for the given variation key. * @summary Get AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all AI Configs in the given project. * @summary List AI Configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} [sort] A sort to apply to the list of AI Configs. * @param {number} [limit] The number of AI Configs to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A filter to apply to the list of AI Configs. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigs(lDAPIVersion: 'beta', projectKey: string, sort?: string, limit?: number, offset?: number, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get an AI model config by key. * @summary Get AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all AI model configs for a project. * @summary List AI model configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ listModelConfigs(lDAPIVersion: 'beta', projectKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Edit an existing AI Config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"description\": \"Example updated description\", \"tags\": [\"new-tag\"] } ``` * @summary Update AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigPatch} [aIConfigPatch] AI Config object to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigPatch?: AIConfigPatch, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Edit an existing variation of an AI Config. This creates a new version of the variation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"messages\": [ { \"role\": \"system\", \"content\": \"The new message\" } ] } ``` * @summary Update AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {AIConfigVariationPatch} [aIConfigVariationPatch] AI Config variation object to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, aIConfigVariationPatch?: AIConfigVariationPatch, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new AI Config within the given project. * @summary Create new AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {AIConfigPost} aIConfigPost AI Config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAIConfig(lDAPIVersion: 'beta', projectKey: string, aIConfigPost: AIConfigPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new variation for a given AI Config. The model in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ``` * @summary Create AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigVariationPost: AIConfigVariationPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an AI model config. You can use this in any variation for any AI Config in your project. * @summary Create an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {ModelConfigPost} modelConfigPost AI model config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigPost: ModelConfigPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AIConfigsBetaApi - factory interface * @export */ export declare const AIConfigsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete an existing AI Config. * @summary Delete AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: any): AxiosPromise; /** * Delete a specific variation of an AI Config by config key and variation key. * @summary Delete AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: any): AxiosPromise; /** * Delete an AI model config. * @summary Delete an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: any): AxiosPromise; /** * Retrieve a specific AI Config by its key. * @summary Get AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: any): AxiosPromise; /** * Retrieve usage metrics for an AI Config by config key. * @summary Get AI Config metrics * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigMetrics(lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: any): AxiosPromise; /** * Retrieve usage metrics for an AI Config by config key, with results split by variation. * @summary Get AI Config metrics by variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigMetricsByVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: any): AxiosPromise>; /** * Get an AI Config variation by key. The response includes all variation versions for the given variation key. * @summary Get AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: any): AxiosPromise; /** * Get a list of all AI Configs in the given project. * @summary List AI Configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} [sort] A sort to apply to the list of AI Configs. * @param {number} [limit] The number of AI Configs to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A filter to apply to the list of AI Configs. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAIConfigs(lDAPIVersion: 'beta', projectKey: string, sort?: string, limit?: number, offset?: number, filter?: string, options?: any): AxiosPromise; /** * Get an AI model config by key. * @summary Get AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ getModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: any): AxiosPromise; /** * Get all AI model configs for a project. * @summary List AI model configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ listModelConfigs(lDAPIVersion: 'beta', projectKey: string, options?: any): AxiosPromise>; /** * Edit an existing AI Config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"description\": \"Example updated description\", \"tags\": [\"new-tag\"] } ``` * @summary Update AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigPatch} [aIConfigPatch] AI Config object to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigPatch?: AIConfigPatch, options?: any): AxiosPromise; /** * Edit an existing variation of an AI Config. This creates a new version of the variation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"messages\": [ { \"role\": \"system\", \"content\": \"The new message\" } ] } ``` * @summary Update AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {AIConfigVariationPatch} [aIConfigVariationPatch] AI Config variation object to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, aIConfigVariationPatch?: AIConfigVariationPatch, options?: any): AxiosPromise; /** * Create a new AI Config within the given project. * @summary Create new AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {AIConfigPost} aIConfigPost AI Config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAIConfig(lDAPIVersion: 'beta', projectKey: string, aIConfigPost: AIConfigPost, options?: any): AxiosPromise; /** * Create a new variation for a given AI Config. The model in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ``` * @summary Create AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigVariationPost: AIConfigVariationPost, options?: any): AxiosPromise; /** * Create an AI model config. You can use this in any variation for any AI Config in your project. * @summary Create an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {ModelConfigPost} modelConfigPost AI model config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ postModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigPost: ModelConfigPost, options?: any): AxiosPromise; }; /** * AIConfigsBetaApi - object-oriented interface * @export * @class AIConfigsBetaApi * @extends {BaseAPI} */ export declare class AIConfigsBetaApi extends BaseAPI { /** * Delete an existing AI Config. * @summary Delete AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ deleteAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: AxiosRequestConfig): Promise>; /** * Delete a specific variation of an AI Config by config key and variation key. * @summary Delete AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ deleteAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: AxiosRequestConfig): Promise>; /** * Delete an AI model config. * @summary Delete an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ deleteModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: AxiosRequestConfig): Promise>; /** * Retrieve a specific AI Config by its key. * @summary Get AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ getAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, options?: AxiosRequestConfig): Promise>; /** * Retrieve usage metrics for an AI Config by config key. * @summary Get AI Config metrics * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ getAIConfigMetrics(lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: AxiosRequestConfig): Promise>; /** * Retrieve usage metrics for an AI Config by config key, with results split by variation. * @summary Get AI Config metrics by variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {number} from The starting time, as milliseconds since epoch (inclusive). * @param {number} to The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`. * @param {string} env An environment key. Only metrics from this environment will be included. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ getAIConfigMetricsByVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, from: number, to: number, env: string, options?: AxiosRequestConfig): Promise>; /** * Get an AI Config variation by key. The response includes all variation versions for the given variation key. * @summary Get AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ getAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all AI Configs in the given project. * @summary List AI Configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} [sort] A sort to apply to the list of AI Configs. * @param {number} [limit] The number of AI Configs to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A filter to apply to the list of AI Configs. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ getAIConfigs(lDAPIVersion: 'beta', projectKey: string, sort?: string, limit?: number, offset?: number, filter?: string, options?: AxiosRequestConfig): Promise>; /** * Get an AI model config by key. * @summary Get AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} modelConfigKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ getModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigKey: string, options?: AxiosRequestConfig): Promise>; /** * Get all AI model configs for a project. * @summary List AI model configs * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ listModelConfigs(lDAPIVersion: 'beta', projectKey: string, options?: AxiosRequestConfig): Promise>; /** * Edit an existing AI Config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"description\": \"Example updated description\", \"tags\": [\"new-tag\"] } ``` * @summary Update AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigPatch} [aIConfigPatch] AI Config object to update * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ patchAIConfig(lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigPatch?: AIConfigPatch, options?: AxiosRequestConfig): Promise>; /** * Edit an existing variation of an AI Config. This creates a new version of the variation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here\'s an example: ``` { \"messages\": [ { \"role\": \"system\", \"content\": \"The new message\" } ] } ``` * @summary Update AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {string} variationKey * @param {AIConfigVariationPatch} [aIConfigVariationPatch] AI Config variation object to update * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ patchAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, variationKey: string, aIConfigVariationPatch?: AIConfigVariationPatch, options?: AxiosRequestConfig): Promise>; /** * Create a new AI Config within the given project. * @summary Create new AI Config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {AIConfigPost} aIConfigPost AI Config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ postAIConfig(lDAPIVersion: 'beta', projectKey: string, aIConfigPost: AIConfigPost, options?: AxiosRequestConfig): Promise>; /** * Create a new variation for a given AI Config. The model in the request body requires a modelName and parameters, for example: ``` \"model\": { \"modelName\": \"claude-3-opus-20240229\", \"parameters\": { \"max_tokens\": 1024 } } ``` * @summary Create AI Config variation * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {string} configKey * @param {AIConfigVariationPost} aIConfigVariationPost AI Config variation object to create * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ postAIConfigVariation(lDAPIVersion: 'beta', projectKey: string, configKey: string, aIConfigVariationPost: AIConfigVariationPost, options?: AxiosRequestConfig): Promise>; /** * Create an AI model config. You can use this in any variation for any AI Config in your project. * @summary Create an AI model config * @param {'beta'} lDAPIVersion Version of the endpoint. * @param {string} projectKey * @param {ModelConfigPost} modelConfigPost AI model config object to create * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AIConfigsBetaApi */ postModelConfig(lDAPIVersion: 'beta', projectKey: string, modelConfigPost: ModelConfigPost, options?: AxiosRequestConfig): Promise>; } /** * AccessTokensApi - axios parameter creator * @export */ export declare const AccessTokensApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete an access token by ID. * @summary Delete access token * @param {string} id The ID of the access token to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteToken: (id: string, options?: AxiosRequestConfig) => Promise; /** * Get a single access token by ID. * @summary Get access token * @param {string} id The ID of the access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getToken: (id: string, options?: AxiosRequestConfig) => Promise; /** * Fetch a list of all access tokens. * @summary List access tokens * @param {boolean} [showAll] If set to true, and the authentication access token has the \'Admin\' role, personal access tokens for all members will be retrieved. * @param {number} [limit] The number of access tokens to return in the response. Defaults to 25. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTokens: (showAll?: boolean, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Update an access token\'s settings. Updating an access token uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch access token * @param {string} id The ID of the access token to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchToken: (id: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Create a new access token. * @summary Create access token * @param {AccessTokenPost} accessTokenPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postToken: (accessTokenPost: AccessTokenPost, options?: AxiosRequestConfig) => Promise; /** * Reset an access token\'s secret key with an optional expiry time for the old key. * @summary Reset access token * @param {string} id The ID of the access token to update * @param {number} [expiry] An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetToken: (id: string, expiry?: number, options?: AxiosRequestConfig) => Promise; }; /** * AccessTokensApi - functional programming interface * @export */ export declare const AccessTokensApiFp: (configuration?: Configuration) => { /** * Delete an access token by ID. * @summary Delete access token * @param {string} id The ID of the access token to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteToken(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single access token by ID. * @summary Get access token * @param {string} id The ID of the access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getToken(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch a list of all access tokens. * @summary List access tokens * @param {boolean} [showAll] If set to true, and the authentication access token has the \'Admin\' role, personal access tokens for all members will be retrieved. * @param {number} [limit] The number of access tokens to return in the response. Defaults to 25. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTokens(showAll?: boolean, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an access token\'s settings. Updating an access token uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch access token * @param {string} id The ID of the access token to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchToken(id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new access token. * @summary Create access token * @param {AccessTokenPost} accessTokenPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postToken(accessTokenPost: AccessTokenPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Reset an access token\'s secret key with an optional expiry time for the old key. * @summary Reset access token * @param {string} id The ID of the access token to update * @param {number} [expiry] An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetToken(id: string, expiry?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccessTokensApi - factory interface * @export */ export declare const AccessTokensApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete an access token by ID. * @summary Delete access token * @param {string} id The ID of the access token to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteToken(id: string, options?: any): AxiosPromise; /** * Get a single access token by ID. * @summary Get access token * @param {string} id The ID of the access token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getToken(id: string, options?: any): AxiosPromise; /** * Fetch a list of all access tokens. * @summary List access tokens * @param {boolean} [showAll] If set to true, and the authentication access token has the \'Admin\' role, personal access tokens for all members will be retrieved. * @param {number} [limit] The number of access tokens to return in the response. Defaults to 25. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTokens(showAll?: boolean, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Update an access token\'s settings. Updating an access token uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch access token * @param {string} id The ID of the access token to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchToken(id: string, patchOperation: Array, options?: any): AxiosPromise; /** * Create a new access token. * @summary Create access token * @param {AccessTokenPost} accessTokenPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postToken(accessTokenPost: AccessTokenPost, options?: any): AxiosPromise; /** * Reset an access token\'s secret key with an optional expiry time for the old key. * @summary Reset access token * @param {string} id The ID of the access token to update * @param {number} [expiry] An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetToken(id: string, expiry?: number, options?: any): AxiosPromise; }; /** * AccessTokensApi - object-oriented interface * @export * @class AccessTokensApi * @extends {BaseAPI} */ export declare class AccessTokensApi extends BaseAPI { /** * Delete an access token by ID. * @summary Delete access token * @param {string} id The ID of the access token to update * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccessTokensApi */ deleteToken(id: string, options?: AxiosRequestConfig): Promise>; /** * Get a single access token by ID. * @summary Get access token * @param {string} id The ID of the access token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccessTokensApi */ getToken(id: string, options?: AxiosRequestConfig): Promise>; /** * Fetch a list of all access tokens. * @summary List access tokens * @param {boolean} [showAll] If set to true, and the authentication access token has the \'Admin\' role, personal access tokens for all members will be retrieved. * @param {number} [limit] The number of access tokens to return in the response. Defaults to 25. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccessTokensApi */ getTokens(showAll?: boolean, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Update an access token\'s settings. Updating an access token uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch access token * @param {string} id The ID of the access token to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccessTokensApi */ patchToken(id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Create a new access token. * @summary Create access token * @param {AccessTokenPost} accessTokenPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccessTokensApi */ postToken(accessTokenPost: AccessTokenPost, options?: AxiosRequestConfig): Promise>; /** * Reset an access token\'s secret key with an optional expiry time for the old key. * @summary Reset access token * @param {string} id The ID of the access token to update * @param {number} [expiry] An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccessTokensApi */ resetToken(id: string, expiry?: number, options?: AxiosRequestConfig): Promise>; } /** * AccountMembersApi - axios parameter creator * @export */ export declare const AccountMembersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account. * @summary Delete account member * @param {string} id The member ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMember: (id: string, options?: AxiosRequestConfig) => Promise; /** * Get a single account member by member ID. `me` is a reserved value for the `id` parameter that returns the caller\'s member information. ### Expanding the member response LaunchDarkly supports one field for expanding the \"Get member\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary Get account member * @param {string} id The member ID * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMember: (id: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the members\' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `team` is a string that matches against the key of the teams the members belong to. It is not case sensitive. - `noteam` is a boolean that filters the list of members who are not on a team if true and members on a team if false. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `accessCheck` is a string that represents a specific action on a specific resource and is in the format `:`. It filters the list to members who have the ability to perform that action on that resource. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning). - For example, the filter `accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page` matches members with the ability to create an approval request for the `alternate-page` flag in the `test` environment of the `default` project. - Wildcard and tag filters are not supported when filtering for access. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member\'s email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest. ### Expanding the members response LaunchDarkly supports two fields for expanding the \"List members\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `customRoles` includes a list of the roles that you have assigned to the member. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary List account members * @param {number} [limit] The number of members to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMembers: (limit?: number, offset?: number, filter?: string, expand?: string, sort?: string, options?: AxiosRequestConfig) => Promise; /** * Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the account member object that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. For example, to add a new custom role to a member, use the following request body: ``` [ { \"op\": \"add\", \"path\": \"/customRoles/0\", \"value\": \"some-role-id\" } ] ``` You can update only an account member\'s role or custom role using a JSON patch. Members can update their own names and email addresses though the LaunchDarkly UI. When SAML SSO or SCIM is enabled for the account, account members are managed in the Identity Provider (IdP). Requests to update account members will succeed, but the IdP will override the update shortly afterwards. * @summary Modify an account member * @param {string} id The member ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMember: (id: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Add one member to one or more teams. * @summary Add a member to teams * @param {string} id The member ID * @param {MemberTeamsPostInput} memberTeamsPostInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMemberTeams: (id: string, memberTeamsPostInput: MemberTeamsPostInput, options?: AxiosRequestConfig) => Promise; /** * Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request). * @summary Invite new members * @param {Array} newMemberForm * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMembers: (newMemberForm: Array, options?: AxiosRequestConfig) => Promise; }; /** * AccountMembersApi - functional programming interface * @export */ export declare const AccountMembersApiFp: (configuration?: Configuration) => { /** * Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account. * @summary Delete account member * @param {string} id The member ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMember(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single account member by member ID. `me` is a reserved value for the `id` parameter that returns the caller\'s member information. ### Expanding the member response LaunchDarkly supports one field for expanding the \"Get member\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary Get account member * @param {string} id The member ID * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMember(id: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the members\' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `team` is a string that matches against the key of the teams the members belong to. It is not case sensitive. - `noteam` is a boolean that filters the list of members who are not on a team if true and members on a team if false. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `accessCheck` is a string that represents a specific action on a specific resource and is in the format `:`. It filters the list to members who have the ability to perform that action on that resource. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning). - For example, the filter `accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page` matches members with the ability to create an approval request for the `alternate-page` flag in the `test` environment of the `default` project. - Wildcard and tag filters are not supported when filtering for access. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member\'s email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest. ### Expanding the members response LaunchDarkly supports two fields for expanding the \"List members\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `customRoles` includes a list of the roles that you have assigned to the member. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary List account members * @param {number} [limit] The number of members to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMembers(limit?: number, offset?: number, filter?: string, expand?: string, sort?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the account member object that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. For example, to add a new custom role to a member, use the following request body: ``` [ { \"op\": \"add\", \"path\": \"/customRoles/0\", \"value\": \"some-role-id\" } ] ``` You can update only an account member\'s role or custom role using a JSON patch. Members can update their own names and email addresses though the LaunchDarkly UI. When SAML SSO or SCIM is enabled for the account, account members are managed in the Identity Provider (IdP). Requests to update account members will succeed, but the IdP will override the update shortly afterwards. * @summary Modify an account member * @param {string} id The member ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMember(id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add one member to one or more teams. * @summary Add a member to teams * @param {string} id The member ID * @param {MemberTeamsPostInput} memberTeamsPostInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMemberTeams(id: string, memberTeamsPostInput: MemberTeamsPostInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request). * @summary Invite new members * @param {Array} newMemberForm * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMembers(newMemberForm: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountMembersApi - factory interface * @export */ export declare const AccountMembersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account. * @summary Delete account member * @param {string} id The member ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMember(id: string, options?: any): AxiosPromise; /** * Get a single account member by member ID. `me` is a reserved value for the `id` parameter that returns the caller\'s member information. ### Expanding the member response LaunchDarkly supports one field for expanding the \"Get member\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary Get account member * @param {string} id The member ID * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMember(id: string, expand?: string, options?: any): AxiosPromise; /** * Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the members\' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `team` is a string that matches against the key of the teams the members belong to. It is not case sensitive. - `noteam` is a boolean that filters the list of members who are not on a team if true and members on a team if false. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `accessCheck` is a string that represents a specific action on a specific resource and is in the format `:`. It filters the list to members who have the ability to perform that action on that resource. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning). - For example, the filter `accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page` matches members with the ability to create an approval request for the `alternate-page` flag in the `test` environment of the `default` project. - Wildcard and tag filters are not supported when filtering for access. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member\'s email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest. ### Expanding the members response LaunchDarkly supports two fields for expanding the \"List members\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `customRoles` includes a list of the roles that you have assigned to the member. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary List account members * @param {number} [limit] The number of members to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMembers(limit?: number, offset?: number, filter?: string, expand?: string, sort?: string, options?: any): AxiosPromise; /** * Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the account member object that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. For example, to add a new custom role to a member, use the following request body: ``` [ { \"op\": \"add\", \"path\": \"/customRoles/0\", \"value\": \"some-role-id\" } ] ``` You can update only an account member\'s role or custom role using a JSON patch. Members can update their own names and email addresses though the LaunchDarkly UI. When SAML SSO or SCIM is enabled for the account, account members are managed in the Identity Provider (IdP). Requests to update account members will succeed, but the IdP will override the update shortly afterwards. * @summary Modify an account member * @param {string} id The member ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMember(id: string, patchOperation: Array, options?: any): AxiosPromise; /** * Add one member to one or more teams. * @summary Add a member to teams * @param {string} id The member ID * @param {MemberTeamsPostInput} memberTeamsPostInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMemberTeams(id: string, memberTeamsPostInput: MemberTeamsPostInput, options?: any): AxiosPromise; /** * Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request). * @summary Invite new members * @param {Array} newMemberForm * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMembers(newMemberForm: Array, options?: any): AxiosPromise; }; /** * AccountMembersApi - object-oriented interface * @export * @class AccountMembersApi * @extends {BaseAPI} */ export declare class AccountMembersApi extends BaseAPI { /** * Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account. * @summary Delete account member * @param {string} id The member ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountMembersApi */ deleteMember(id: string, options?: AxiosRequestConfig): Promise>; /** * Get a single account member by member ID. `me` is a reserved value for the `id` parameter that returns the caller\'s member information. ### Expanding the member response LaunchDarkly supports one field for expanding the \"Get member\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary Get account member * @param {string} id The member ID * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountMembersApi */ getMember(id: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the members\' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `team` is a string that matches against the key of the teams the members belong to. It is not case sensitive. - `noteam` is a boolean that filters the list of members who are not on a team if true and members on a team if false. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `accessCheck` is a string that represents a specific action on a specific resource and is in the format `:`. It filters the list to members who have the ability to perform that action on that resource. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning). - For example, the filter `accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page` matches members with the ability to create an approval request for the `alternate-page` flag in the `test` environment of the `default` project. - Wildcard and tag filters are not supported when filtering for access. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member\'s email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest. ### Expanding the members response LaunchDarkly supports two fields for expanding the \"List members\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `customRoles` includes a list of the roles that you have assigned to the member. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response. * @summary List account members * @param {number} [limit] The number of members to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountMembersApi */ getMembers(limit?: number, offset?: number, filter?: string, expand?: string, sort?: string, options?: AxiosRequestConfig): Promise>; /** * Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the account member object that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. For example, to add a new custom role to a member, use the following request body: ``` [ { \"op\": \"add\", \"path\": \"/customRoles/0\", \"value\": \"some-role-id\" } ] ``` You can update only an account member\'s role or custom role using a JSON patch. Members can update their own names and email addresses though the LaunchDarkly UI. When SAML SSO or SCIM is enabled for the account, account members are managed in the Identity Provider (IdP). Requests to update account members will succeed, but the IdP will override the update shortly afterwards. * @summary Modify an account member * @param {string} id The member ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountMembersApi */ patchMember(id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Add one member to one or more teams. * @summary Add a member to teams * @param {string} id The member ID * @param {MemberTeamsPostInput} memberTeamsPostInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountMembersApi */ postMemberTeams(id: string, memberTeamsPostInput: MemberTeamsPostInput, options?: AxiosRequestConfig): Promise>; /** * Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request). * @summary Invite new members * @param {Array} newMemberForm * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountMembersApi */ postMembers(newMemberForm: Array, options?: AxiosRequestConfig): Promise>; } /** * AccountMembersBetaApi - axios parameter creator * @export */ export declare const AccountMembersBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members.
Click to expand instructions for updating members #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMemberRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ```
* @summary Modify account members * @param {MembersPatchInput} membersPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMembers: (membersPatchInput: MembersPatchInput, options?: AxiosRequestConfig) => Promise; }; /** * AccountMembersBetaApi - functional programming interface * @export */ export declare const AccountMembersBetaApiFp: (configuration?: Configuration) => { /** * > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members.
Click to expand instructions for updating members #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMemberRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ```
* @summary Modify account members * @param {MembersPatchInput} membersPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMembers(membersPatchInput: MembersPatchInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountMembersBetaApi - factory interface * @export */ export declare const AccountMembersBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members.
Click to expand instructions for updating members #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMemberRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ```
* @summary Modify account members * @param {MembersPatchInput} membersPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMembers(membersPatchInput: MembersPatchInput, options?: any): AxiosPromise; }; /** * AccountMembersBetaApi - object-oriented interface * @export * @class AccountMembersBetaApi * @extends {BaseAPI} */ export declare class AccountMembersBetaApi extends BaseAPI { /** * > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members.
Click to expand instructions for updating members #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMemberRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly\'s built-in roles](https://launchdarkly.com/docs/home/account/built-in-roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ```
* @summary Modify account members * @param {MembersPatchInput} membersPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountMembersBetaApi */ patchMembers(membersPatchInput: MembersPatchInput, options?: AxiosRequestConfig): Promise>; } /** * AccountUsageBetaApi - axios parameter creator * @export */ export declare const AccountUsageBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a time-series array of the number of monthly data export events from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get data export events usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataExportEventsUsage: (from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig) => Promise; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get evaluations usage * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluationsUsage: (projectKey: string, environmentKey: string, featureFlagKey: string, from?: string, to?: string, tz?: string, options?: AxiosRequestConfig) => Promise; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get events usage * @param {string} type The type of event to retrieve. Must be either `received` or `published`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventsUsage: (type: string, from?: string, to?: string, options?: AxiosRequestConfig) => Promise; /** * Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation keys usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationKeysUsage: (from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig) => Promise; /** * Get a time-series array of the number of monthly experimentation units from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation units usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationUnitsUsage: (from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU SDKs by type * @param {string} [from] The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000. * @param {string} [to] The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000. * @param {string} [sdktype] The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauSdksByType: (from?: string, to?: string, sdktype?: string, options?: AxiosRequestConfig) => Promise; /** * Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [project] A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects. * @param {string} [environment] An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project. * @param {string} [sdktype] An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server * @param {string} [sdk] An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK. * @param {string} [anonymous] If specified, filters results to either anonymous or nonanonymous users. * @param {string} [groupby] If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId * @param {string} [aggregationType] If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental * @param {string} [contextKind] Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauUsage: (from?: string, to?: string, project?: string, environment?: string, sdktype?: string, sdk?: string, anonymous?: string, groupby?: string, aggregationType?: string, contextKind?: string, options?: AxiosRequestConfig) => Promise; /** * Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage by category * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauUsageByCategory: (from?: string, to?: string, options?: AxiosRequestConfig) => Promise; /** * Get a time-series array of the number of monthly service connections from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get service connection usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServiceConnectionUsage: (from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig) => Promise; /** * Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsage: (source: string, from?: string, to?: string, tz?: string, options?: AxiosRequestConfig) => Promise; /** * Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage by SDK version * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {string} [sdk] If included, this filters the returned series to only those that match this SDK name. * @param {string} [version] If included, this filters the returned series to only those that match this SDK version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsageBySdkVersion: (source: string, from?: string, to?: string, tz?: string, sdk?: string, version?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days. * @summary Get stream usage SDK versions * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsageSdkversion: (source: string, options?: AxiosRequestConfig) => Promise; }; /** * AccountUsageBetaApi - functional programming interface * @export */ export declare const AccountUsageBetaApiFp: (configuration?: Configuration) => { /** * Get a time-series array of the number of monthly data export events from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get data export events usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataExportEventsUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get evaluations usage * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluationsUsage(projectKey: string, environmentKey: string, featureFlagKey: string, from?: string, to?: string, tz?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get events usage * @param {string} type The type of event to retrieve. Must be either `received` or `published`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventsUsage(type: string, from?: string, to?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation keys usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationKeysUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a time-series array of the number of monthly experimentation units from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation units usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationUnitsUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU SDKs by type * @param {string} [from] The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000. * @param {string} [to] The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000. * @param {string} [sdktype] The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauSdksByType(from?: string, to?: string, sdktype?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [project] A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects. * @param {string} [environment] An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project. * @param {string} [sdktype] An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server * @param {string} [sdk] An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK. * @param {string} [anonymous] If specified, filters results to either anonymous or nonanonymous users. * @param {string} [groupby] If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId * @param {string} [aggregationType] If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental * @param {string} [contextKind] Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauUsage(from?: string, to?: string, project?: string, environment?: string, sdktype?: string, sdk?: string, anonymous?: string, groupby?: string, aggregationType?: string, contextKind?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage by category * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauUsageByCategory(from?: string, to?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a time-series array of the number of monthly service connections from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get service connection usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServiceConnectionUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsage(source: string, from?: string, to?: string, tz?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage by SDK version * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {string} [sdk] If included, this filters the returned series to only those that match this SDK name. * @param {string} [version] If included, this filters the returned series to only those that match this SDK version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsageBySdkVersion(source: string, from?: string, to?: string, tz?: string, sdk?: string, version?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days. * @summary Get stream usage SDK versions * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsageSdkversion(source: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountUsageBetaApi - factory interface * @export */ export declare const AccountUsageBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a time-series array of the number of monthly data export events from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get data export events usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataExportEventsUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: any): AxiosPromise; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get evaluations usage * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluationsUsage(projectKey: string, environmentKey: string, featureFlagKey: string, from?: string, to?: string, tz?: string, options?: any): AxiosPromise; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get events usage * @param {string} type The type of event to retrieve. Must be either `received` or `published`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventsUsage(type: string, from?: string, to?: string, options?: any): AxiosPromise; /** * Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation keys usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationKeysUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: any): AxiosPromise; /** * Get a time-series array of the number of monthly experimentation units from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation units usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationUnitsUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: any): AxiosPromise; /** * Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU SDKs by type * @param {string} [from] The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000. * @param {string} [to] The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000. * @param {string} [sdktype] The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauSdksByType(from?: string, to?: string, sdktype?: string, options?: any): AxiosPromise; /** * Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [project] A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects. * @param {string} [environment] An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project. * @param {string} [sdktype] An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server * @param {string} [sdk] An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK. * @param {string} [anonymous] If specified, filters results to either anonymous or nonanonymous users. * @param {string} [groupby] If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId * @param {string} [aggregationType] If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental * @param {string} [contextKind] Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauUsage(from?: string, to?: string, project?: string, environment?: string, sdktype?: string, sdk?: string, anonymous?: string, groupby?: string, aggregationType?: string, contextKind?: string, options?: any): AxiosPromise; /** * Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage by category * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMauUsageByCategory(from?: string, to?: string, options?: any): AxiosPromise; /** * Get a time-series array of the number of monthly service connections from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get service connection usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServiceConnectionUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: any): AxiosPromise; /** * Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsage(source: string, from?: string, to?: string, tz?: string, options?: any): AxiosPromise; /** * Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage by SDK version * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {string} [sdk] If included, this filters the returned series to only those that match this SDK name. * @param {string} [version] If included, this filters the returned series to only those that match this SDK version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsageBySdkVersion(source: string, from?: string, to?: string, tz?: string, sdk?: string, version?: string, options?: any): AxiosPromise; /** * Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days. * @summary Get stream usage SDK versions * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStreamUsageSdkversion(source: string, options?: any): AxiosPromise; }; /** * AccountUsageBetaApi - object-oriented interface * @export * @class AccountUsageBetaApi * @extends {BaseAPI} */ export declare class AccountUsageBetaApi extends BaseAPI { /** * Get a time-series array of the number of monthly data export events from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get data export events usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getDataExportEventsUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise>; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get evaluations usage * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getEvaluationsUsage(projectKey: string, environmentKey: string, featureFlagKey: string, from?: string, to?: string, tz?: string, options?: AxiosRequestConfig): Promise>; /** * Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get events usage * @param {string} type The type of event to retrieve. Must be either `received` or `published`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getEventsUsage(type: string, from?: string, to?: string, options?: AxiosRequestConfig): Promise>; /** * Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation keys usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getExperimentationKeysUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise>; /** * Get a time-series array of the number of monthly experimentation units from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get experimentation units usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getExperimentationUnitsUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU SDKs by type * @param {string} [from] The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000. * @param {string} [to] The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000. * @param {string} [sdktype] The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getMauSdksByType(from?: string, to?: string, sdktype?: string, options?: AxiosRequestConfig): Promise>; /** * Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [project] A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects. * @param {string} [environment] An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project. * @param {string} [sdktype] An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server * @param {string} [sdk] An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK. * @param {string} [anonymous] If specified, filters results to either anonymous or nonanonymous users. * @param {string} [groupby] If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId * @param {string} [aggregationType] If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental * @param {string} [contextKind] Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getMauUsage(from?: string, to?: string, project?: string, environment?: string, sdktype?: string, sdk?: string, anonymous?: string, groupby?: string, aggregationType?: string, contextKind?: string, options?: AxiosRequestConfig): Promise>; /** * Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.

Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](https://launchdarkly.com/docs/home/account/metrics). * @summary Get MAU usage by category * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getMauUsageByCategory(from?: string, to?: string, options?: AxiosRequestConfig): Promise>; /** * Get a time-series array of the number of monthly service connections from your account. The granularity is always daily, with a maximum of 31 days. * @summary Get service connection usage * @param {string} [from] The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. * @param {string} [to] The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. * @param {string} [projectKey] A project key. If specified, `environmentKey` is required and results apply to the corresponding environment in this project. * @param {string} [environmentKey] An environment key. If specified, `projectKey` is required and results apply to the corresponding environment in this project. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getServiceConnectionUsage(from?: string, to?: string, projectKey?: string, environmentKey?: string, options?: AxiosRequestConfig): Promise>; /** * Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 30 days ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getStreamUsage(source: string, from?: string, to?: string, tz?: string, options?: AxiosRequestConfig): Promise>; /** * Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned. * @summary Get stream usage by SDK version * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {string} [from] The series of data returned starts from this timestamp. Defaults to 24 hours ago. * @param {string} [to] The series of data returned ends at this timestamp. Defaults to the current time. * @param {string} [tz] The timezone to use for breaks between days when returning daily data. * @param {string} [sdk] If included, this filters the returned series to only those that match this SDK name. * @param {string} [version] If included, this filters the returned series to only those that match this SDK version. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getStreamUsageBySdkVersion(source: string, from?: string, to?: string, tz?: string, sdk?: string, version?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days. * @summary Get stream usage SDK versions * @param {string} source The source of streaming connections to describe. Must be either `client` or `server`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountUsageBetaApi */ getStreamUsageSdkversion(source: string, options?: AxiosRequestConfig): Promise>; } /** * AnnouncementsApi - axios parameter creator * @export */ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create an announcement * @summary Create an announcement * @param {CreateAnnouncementBody} createAnnouncementBody Announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAnnouncementPublic: (createAnnouncementBody: CreateAnnouncementBody, options?: AxiosRequestConfig) => Promise; /** * Delete an announcement * @summary Delete an announcement * @param {string} announcementId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAnnouncementPublic: (announcementId: string, options?: AxiosRequestConfig) => Promise; /** * Get announcements * @summary Get announcements * @param {'active' | 'inactive' | 'scheduled'} [status] Filter announcements by status. * @param {number} [limit] The number of announcements to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAnnouncementsPublic: (status?: 'active' | 'inactive' | 'scheduled', limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Update an announcement * @summary Update an announcement * @param {string} announcementId * @param {Array} announcementPatchOperation Update announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAnnouncementPublic: (announcementId: string, announcementPatchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * AnnouncementsApi - functional programming interface * @export */ export declare const AnnouncementsApiFp: (configuration?: Configuration) => { /** * Create an announcement * @summary Create an announcement * @param {CreateAnnouncementBody} createAnnouncementBody Announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAnnouncementPublic(createAnnouncementBody: CreateAnnouncementBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an announcement * @summary Delete an announcement * @param {string} announcementId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAnnouncementPublic(announcementId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get announcements * @summary Get announcements * @param {'active' | 'inactive' | 'scheduled'} [status] Filter announcements by status. * @param {number} [limit] The number of announcements to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAnnouncementsPublic(status?: 'active' | 'inactive' | 'scheduled', limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an announcement * @summary Update an announcement * @param {string} announcementId * @param {Array} announcementPatchOperation Update announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAnnouncementPublic(announcementId: string, announcementPatchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AnnouncementsApi - factory interface * @export */ export declare const AnnouncementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create an announcement * @summary Create an announcement * @param {CreateAnnouncementBody} createAnnouncementBody Announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAnnouncementPublic(createAnnouncementBody: CreateAnnouncementBody, options?: any): AxiosPromise; /** * Delete an announcement * @summary Delete an announcement * @param {string} announcementId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAnnouncementPublic(announcementId: string, options?: any): AxiosPromise; /** * Get announcements * @summary Get announcements * @param {'active' | 'inactive' | 'scheduled'} [status] Filter announcements by status. * @param {number} [limit] The number of announcements to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAnnouncementsPublic(status?: 'active' | 'inactive' | 'scheduled', limit?: number, offset?: number, options?: any): AxiosPromise; /** * Update an announcement * @summary Update an announcement * @param {string} announcementId * @param {Array} announcementPatchOperation Update announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAnnouncementPublic(announcementId: string, announcementPatchOperation: Array, options?: any): AxiosPromise; }; /** * AnnouncementsApi - object-oriented interface * @export * @class AnnouncementsApi * @extends {BaseAPI} */ export declare class AnnouncementsApi extends BaseAPI { /** * Create an announcement * @summary Create an announcement * @param {CreateAnnouncementBody} createAnnouncementBody Announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnnouncementsApi */ createAnnouncementPublic(createAnnouncementBody: CreateAnnouncementBody, options?: AxiosRequestConfig): Promise>; /** * Delete an announcement * @summary Delete an announcement * @param {string} announcementId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnnouncementsApi */ deleteAnnouncementPublic(announcementId: string, options?: AxiosRequestConfig): Promise>; /** * Get announcements * @summary Get announcements * @param {'active' | 'inactive' | 'scheduled'} [status] Filter announcements by status. * @param {number} [limit] The number of announcements to return. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnnouncementsApi */ getAnnouncementsPublic(status?: 'active' | 'inactive' | 'scheduled', limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Update an announcement * @summary Update an announcement * @param {string} announcementId * @param {Array} announcementPatchOperation Update announcement request body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnnouncementsApi */ updateAnnouncementPublic(announcementId: string, announcementPatchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * ApplicationsBetaApi - axios parameter creator * @export */ export declare const ApplicationsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete an application. * @summary Delete application * @param {string} applicationKey The application key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplication: (applicationKey: string, options?: AxiosRequestConfig) => Promise; /** * Delete an application version. * @summary Delete application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplicationVersion: (applicationKey: string, versionKey: string, options?: AxiosRequestConfig) => Promise; /** * Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the \"Get application\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get application by key * @param {string} applicationKey The application key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplication: (applicationKey: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of versions for a specific application in an account. * @summary Get application versions by application key * @param {string} applicationKey The application key * @param {string} [filter] Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of versions to return. Defaults to 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplicationVersions: (applicationKey: string, filter?: string, limit?: number, offset?: number, sort?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the \"Get applications\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get applications * @param {string} [filter] Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of applications to return. Defaults to 10. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplications: (filter?: string, limit?: number, offset?: number, sort?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Update an application. You can update the `description` and `kind` fields. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application * @param {string} applicationKey The application key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApplication: (applicationKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Update an application version. You can update the `supported` field. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application version. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApplicationVersion: (applicationKey: string, versionKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * ApplicationsBetaApi - functional programming interface * @export */ export declare const ApplicationsBetaApiFp: (configuration?: Configuration) => { /** * Delete an application. * @summary Delete application * @param {string} applicationKey The application key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplication(applicationKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an application version. * @summary Delete application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplicationVersion(applicationKey: string, versionKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the \"Get application\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get application by key * @param {string} applicationKey The application key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplication(applicationKey: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of versions for a specific application in an account. * @summary Get application versions by application key * @param {string} applicationKey The application key * @param {string} [filter] Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of versions to return. Defaults to 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplicationVersions(applicationKey: string, filter?: string, limit?: number, offset?: number, sort?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the \"Get applications\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get applications * @param {string} [filter] Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of applications to return. Defaults to 10. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplications(filter?: string, limit?: number, offset?: number, sort?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an application. You can update the `description` and `kind` fields. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application * @param {string} applicationKey The application key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApplication(applicationKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an application version. You can update the `supported` field. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application version. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApplicationVersion(applicationKey: string, versionKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ApplicationsBetaApi - factory interface * @export */ export declare const ApplicationsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete an application. * @summary Delete application * @param {string} applicationKey The application key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplication(applicationKey: string, options?: any): AxiosPromise; /** * Delete an application version. * @summary Delete application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplicationVersion(applicationKey: string, versionKey: string, options?: any): AxiosPromise; /** * Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the \"Get application\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get application by key * @param {string} applicationKey The application key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplication(applicationKey: string, expand?: string, options?: any): AxiosPromise; /** * Get a list of versions for a specific application in an account. * @summary Get application versions by application key * @param {string} applicationKey The application key * @param {string} [filter] Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of versions to return. Defaults to 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplicationVersions(applicationKey: string, filter?: string, limit?: number, offset?: number, sort?: string, options?: any): AxiosPromise; /** * Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the \"Get applications\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get applications * @param {string} [filter] Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of applications to return. Defaults to 10. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplications(filter?: string, limit?: number, offset?: number, sort?: string, expand?: string, options?: any): AxiosPromise; /** * Update an application. You can update the `description` and `kind` fields. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application * @param {string} applicationKey The application key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApplication(applicationKey: string, patchOperation: Array, options?: any): AxiosPromise; /** * Update an application version. You can update the `supported` field. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application version. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApplicationVersion(applicationKey: string, versionKey: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * ApplicationsBetaApi - object-oriented interface * @export * @class ApplicationsBetaApi * @extends {BaseAPI} */ export declare class ApplicationsBetaApi extends BaseAPI { /** * Delete an application. * @summary Delete application * @param {string} applicationKey The application key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationsBetaApi */ deleteApplication(applicationKey: string, options?: AxiosRequestConfig): Promise>; /** * Delete an application version. * @summary Delete application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationsBetaApi */ deleteApplicationVersion(applicationKey: string, versionKey: string, options?: AxiosRequestConfig): Promise>; /** * Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the \"Get application\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get application by key * @param {string} applicationKey The application key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationsBetaApi */ getApplication(applicationKey: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of versions for a specific application in an account. * @summary Get application versions by application key * @param {string} applicationKey The application key * @param {string} [filter] Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of versions to return. Defaults to 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationsBetaApi */ getApplicationVersions(applicationKey: string, filter?: string, limit?: number, offset?: number, sort?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the \"Get applications\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response. * @summary Get applications * @param {string} [filter] Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). * @param {number} [limit] The number of applications to return. Defaults to 10. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationsBetaApi */ getApplications(filter?: string, limit?: number, offset?: number, sort?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Update an application. You can update the `description` and `kind` fields. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application * @param {string} applicationKey The application key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationsBetaApi */ patchApplication(applicationKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Update an application version. You can update the `supported` field. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application version. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update application version * @param {string} applicationKey The application key * @param {string} versionKey The application version key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationsBetaApi */ patchApplicationVersion(applicationKey: string, versionKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * ApprovalsApi - axios parameter creator * @export */ export declare const ApprovalsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete an approval request. * @summary Delete approval request * @param {string} id The approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApprovalRequest: (id: string, options?: AxiosRequestConfig) => Promise; /** * Delete an approval request for a feature flag. * @summary Delete approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApprovalRequestForFlag: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a single approval request for a feature flag. * @summary Get approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalForFlag: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get an approval request by approval request ID. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `environments` includes the environments the approval request relates to - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `resource` includes details on the resource (flag or segment) the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary Get approval request * @param {string} id The approval request ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalRequest: (id: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get all approval requests. ### Filtering approvals LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `notifyMemberIds` filters for only approvals that are assigned to a member in the specified list. For example: `filter=notifyMemberIds anyOf [\"memberId1\", \"memberId2\"]`. - `requestorId` filters for only approvals that correspond to the ID of the member who requested the approval. For example: `filter=requestorId equals 457034721476302714390214`. - `resourceId` filters for only approvals that correspond to the the specified resource identifier. For example: `filter=resourceId equals proj/my-project:env/my-environment:flag/my-flag`. - `resourceKind` filters for only approvals that correspond to the specified resource kind. For example: `filter=resourceKind equals flag`. Currently, `flag` and `segment` resource kinds are supported. - `reviewStatus` filters for only approvals which correspond to the review status in the specified list. The possible values are `approved`, `declined`, and `pending`. For example: `filter=reviewStatus anyOf [\"pending\", \"approved\"]`. - `status` filters for only approvals which correspond to the status in the specified list. The possible values are `pending`, `scheduled`, `failed`, and `completed`. For example: `filter=status anyOf [\"pending\", \"scheduled\"]`. You can also apply multiple filters at once. For example, setting `filter=projectKey equals my-project, reviewStatus anyOf [\"pending\",\"approved\"]` matches approval requests which correspond to the `my-project` project key, and a review status of either `pending` or `approved`. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `environments` includes the environments the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary List approval requests * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {number} [limit] The number of approvals to return. Defaults to 20. Maximum limit is 200. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalRequests: (filter?: string, expand?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Get all approval requests for a feature flag. * @summary List approval requests for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalsForFlag: (projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Create an approval request. This endpoint requires a list of `instructions`, in semantic patch format, that will be applied when the approval request is approved and applied. If you are creating an approval request for a flag, you can use the following `instructions`: - `addVariation` - `removeVariation` - `updateVariation` - `updateDefaultVariation` For details on using these instructions, read [Update feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag). To create an approval for a flag specific to an environment, use [Create approval request for a flag](https://launchdarkly.com/docs/api/approvals/post-approval-request-for-flag). If you are creating an approval request for a segment, you can use the following read [Patch segment](https://launchdarkly.com/docs/api/segments/patch-segment) for details on the available `instructions`. * @summary Create approval request * @param {CreateApprovalRequestRequest} createApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequest: (createApprovalRequestRequest: CreateApprovalRequestRequest, options?: AxiosRequestConfig) => Promise; /** * Apply an approval request that has been approved. This endpoint works with approval requests for either flag or segment changes. * @summary Apply approval request * @param {string} id The approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestApply: (id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: AxiosRequestConfig) => Promise; /** * Apply an approval request that has been approved. This endpoint requires a feature flag key, and can only be used for applying approval requests on flags. * @summary Apply approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestApplyForFlag: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: AxiosRequestConfig) => Promise; /** * Create an approval request for a feature flag. * @summary Create approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CreateFlagConfigApprovalRequestRequest} createFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestForFlag: (projectKey: string, featureFlagKey: string, environmentKey: string, createFlagConfigApprovalRequestRequest: CreateFlagConfigApprovalRequestRequest, options?: AxiosRequestConfig) => Promise; /** * Review an approval request by approving or denying changes. * @summary Review approval request * @param {string} id The approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestReview: (id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: AxiosRequestConfig) => Promise; /** * Review an approval request by approving or denying changes. * @summary Review approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestReviewForFlag: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: AxiosRequestConfig) => Promise; /** * Create an approval request to copy a feature flag\'s configuration across environments. * @summary Create approval request to copy flag configurations across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key for the target environment * @param {CreateCopyFlagConfigApprovalRequestRequest} createCopyFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFlagCopyConfigApprovalRequest: (projectKey: string, featureFlagKey: string, environmentKey: string, createCopyFlagConfigApprovalRequestRequest: CreateCopyFlagConfigApprovalRequestRequest, options?: AxiosRequestConfig) => Promise; }; /** * ApprovalsApi - functional programming interface * @export */ export declare const ApprovalsApiFp: (configuration?: Configuration) => { /** * Delete an approval request. * @summary Delete approval request * @param {string} id The approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApprovalRequest(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an approval request for a feature flag. * @summary Delete approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApprovalRequestForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single approval request for a feature flag. * @summary Get approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get an approval request by approval request ID. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `environments` includes the environments the approval request relates to - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `resource` includes details on the resource (flag or segment) the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary Get approval request * @param {string} id The approval request ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalRequest(id: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all approval requests. ### Filtering approvals LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `notifyMemberIds` filters for only approvals that are assigned to a member in the specified list. For example: `filter=notifyMemberIds anyOf [\"memberId1\", \"memberId2\"]`. - `requestorId` filters for only approvals that correspond to the ID of the member who requested the approval. For example: `filter=requestorId equals 457034721476302714390214`. - `resourceId` filters for only approvals that correspond to the the specified resource identifier. For example: `filter=resourceId equals proj/my-project:env/my-environment:flag/my-flag`. - `resourceKind` filters for only approvals that correspond to the specified resource kind. For example: `filter=resourceKind equals flag`. Currently, `flag` and `segment` resource kinds are supported. - `reviewStatus` filters for only approvals which correspond to the review status in the specified list. The possible values are `approved`, `declined`, and `pending`. For example: `filter=reviewStatus anyOf [\"pending\", \"approved\"]`. - `status` filters for only approvals which correspond to the status in the specified list. The possible values are `pending`, `scheduled`, `failed`, and `completed`. For example: `filter=status anyOf [\"pending\", \"scheduled\"]`. You can also apply multiple filters at once. For example, setting `filter=projectKey equals my-project, reviewStatus anyOf [\"pending\",\"approved\"]` matches approval requests which correspond to the `my-project` project key, and a review status of either `pending` or `approved`. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `environments` includes the environments the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary List approval requests * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {number} [limit] The number of approvals to return. Defaults to 20. Maximum limit is 200. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalRequests(filter?: string, expand?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all approval requests for a feature flag. * @summary List approval requests for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalsForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an approval request. This endpoint requires a list of `instructions`, in semantic patch format, that will be applied when the approval request is approved and applied. If you are creating an approval request for a flag, you can use the following `instructions`: - `addVariation` - `removeVariation` - `updateVariation` - `updateDefaultVariation` For details on using these instructions, read [Update feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag). To create an approval for a flag specific to an environment, use [Create approval request for a flag](https://launchdarkly.com/docs/api/approvals/post-approval-request-for-flag). If you are creating an approval request for a segment, you can use the following read [Patch segment](https://launchdarkly.com/docs/api/segments/patch-segment) for details on the available `instructions`. * @summary Create approval request * @param {CreateApprovalRequestRequest} createApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequest(createApprovalRequestRequest: CreateApprovalRequestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Apply an approval request that has been approved. This endpoint works with approval requests for either flag or segment changes. * @summary Apply approval request * @param {string} id The approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestApply(id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Apply an approval request that has been approved. This endpoint requires a feature flag key, and can only be used for applying approval requests on flags. * @summary Apply approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestApplyForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an approval request for a feature flag. * @summary Create approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CreateFlagConfigApprovalRequestRequest} createFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, createFlagConfigApprovalRequestRequest: CreateFlagConfigApprovalRequestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Review an approval request by approving or denying changes. * @summary Review approval request * @param {string} id The approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestReview(id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Review an approval request by approving or denying changes. * @summary Review approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestReviewForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an approval request to copy a feature flag\'s configuration across environments. * @summary Create approval request to copy flag configurations across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key for the target environment * @param {CreateCopyFlagConfigApprovalRequestRequest} createCopyFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFlagCopyConfigApprovalRequest(projectKey: string, featureFlagKey: string, environmentKey: string, createCopyFlagConfigApprovalRequestRequest: CreateCopyFlagConfigApprovalRequestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ApprovalsApi - factory interface * @export */ export declare const ApprovalsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete an approval request. * @summary Delete approval request * @param {string} id The approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApprovalRequest(id: string, options?: any): AxiosPromise; /** * Delete an approval request for a feature flag. * @summary Delete approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApprovalRequestForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Get a single approval request for a feature flag. * @summary Get approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Get an approval request by approval request ID. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `environments` includes the environments the approval request relates to - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `resource` includes details on the resource (flag or segment) the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary Get approval request * @param {string} id The approval request ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalRequest(id: string, expand?: string, options?: any): AxiosPromise; /** * Get all approval requests. ### Filtering approvals LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `notifyMemberIds` filters for only approvals that are assigned to a member in the specified list. For example: `filter=notifyMemberIds anyOf [\"memberId1\", \"memberId2\"]`. - `requestorId` filters for only approvals that correspond to the ID of the member who requested the approval. For example: `filter=requestorId equals 457034721476302714390214`. - `resourceId` filters for only approvals that correspond to the the specified resource identifier. For example: `filter=resourceId equals proj/my-project:env/my-environment:flag/my-flag`. - `resourceKind` filters for only approvals that correspond to the specified resource kind. For example: `filter=resourceKind equals flag`. Currently, `flag` and `segment` resource kinds are supported. - `reviewStatus` filters for only approvals which correspond to the review status in the specified list. The possible values are `approved`, `declined`, and `pending`. For example: `filter=reviewStatus anyOf [\"pending\", \"approved\"]`. - `status` filters for only approvals which correspond to the status in the specified list. The possible values are `pending`, `scheduled`, `failed`, and `completed`. For example: `filter=status anyOf [\"pending\", \"scheduled\"]`. You can also apply multiple filters at once. For example, setting `filter=projectKey equals my-project, reviewStatus anyOf [\"pending\",\"approved\"]` matches approval requests which correspond to the `my-project` project key, and a review status of either `pending` or `approved`. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `environments` includes the environments the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary List approval requests * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {number} [limit] The number of approvals to return. Defaults to 20. Maximum limit is 200. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalRequests(filter?: string, expand?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Get all approval requests for a feature flag. * @summary List approval requests for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApprovalsForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Create an approval request. This endpoint requires a list of `instructions`, in semantic patch format, that will be applied when the approval request is approved and applied. If you are creating an approval request for a flag, you can use the following `instructions`: - `addVariation` - `removeVariation` - `updateVariation` - `updateDefaultVariation` For details on using these instructions, read [Update feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag). To create an approval for a flag specific to an environment, use [Create approval request for a flag](https://launchdarkly.com/docs/api/approvals/post-approval-request-for-flag). If you are creating an approval request for a segment, you can use the following read [Patch segment](https://launchdarkly.com/docs/api/segments/patch-segment) for details on the available `instructions`. * @summary Create approval request * @param {CreateApprovalRequestRequest} createApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequest(createApprovalRequestRequest: CreateApprovalRequestRequest, options?: any): AxiosPromise; /** * Apply an approval request that has been approved. This endpoint works with approval requests for either flag or segment changes. * @summary Apply approval request * @param {string} id The approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestApply(id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: any): AxiosPromise; /** * Apply an approval request that has been approved. This endpoint requires a feature flag key, and can only be used for applying approval requests on flags. * @summary Apply approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestApplyForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: any): AxiosPromise; /** * Create an approval request for a feature flag. * @summary Create approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CreateFlagConfigApprovalRequestRequest} createFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, createFlagConfigApprovalRequestRequest: CreateFlagConfigApprovalRequestRequest, options?: any): AxiosPromise; /** * Review an approval request by approving or denying changes. * @summary Review approval request * @param {string} id The approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestReview(id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: any): AxiosPromise; /** * Review an approval request by approving or denying changes. * @summary Review approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postApprovalRequestReviewForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: any): AxiosPromise; /** * Create an approval request to copy a feature flag\'s configuration across environments. * @summary Create approval request to copy flag configurations across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key for the target environment * @param {CreateCopyFlagConfigApprovalRequestRequest} createCopyFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFlagCopyConfigApprovalRequest(projectKey: string, featureFlagKey: string, environmentKey: string, createCopyFlagConfigApprovalRequestRequest: CreateCopyFlagConfigApprovalRequestRequest, options?: any): AxiosPromise; }; /** * ApprovalsApi - object-oriented interface * @export * @class ApprovalsApi * @extends {BaseAPI} */ export declare class ApprovalsApi extends BaseAPI { /** * Delete an approval request. * @summary Delete approval request * @param {string} id The approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ deleteApprovalRequest(id: string, options?: AxiosRequestConfig): Promise>; /** * Delete an approval request for a feature flag. * @summary Delete approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ deleteApprovalRequestForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a single approval request for a feature flag. * @summary Get approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ getApprovalForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get an approval request by approval request ID. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `environments` includes the environments the approval request relates to - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `resource` includes details on the resource (flag or segment) the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary Get approval request * @param {string} id The approval request ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ getApprovalRequest(id: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get all approval requests. ### Filtering approvals LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `notifyMemberIds` filters for only approvals that are assigned to a member in the specified list. For example: `filter=notifyMemberIds anyOf [\"memberId1\", \"memberId2\"]`. - `requestorId` filters for only approvals that correspond to the ID of the member who requested the approval. For example: `filter=requestorId equals 457034721476302714390214`. - `resourceId` filters for only approvals that correspond to the the specified resource identifier. For example: `filter=resourceId equals proj/my-project:env/my-environment:flag/my-flag`. - `resourceKind` filters for only approvals that correspond to the specified resource kind. For example: `filter=resourceKind equals flag`. Currently, `flag` and `segment` resource kinds are supported. - `reviewStatus` filters for only approvals which correspond to the review status in the specified list. The possible values are `approved`, `declined`, and `pending`. For example: `filter=reviewStatus anyOf [\"pending\", \"approved\"]`. - `status` filters for only approvals which correspond to the status in the specified list. The possible values are `pending`, `scheduled`, `failed`, and `completed`. For example: `filter=status anyOf [\"pending\", \"scheduled\"]`. You can also apply multiple filters at once. For example, setting `filter=projectKey equals my-project, reviewStatus anyOf [\"pending\",\"approved\"]` matches approval requests which correspond to the `my-project` project key, and a review status of either `pending` or `approved`. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `environments` includes the environments the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response. * @summary List approval requests * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {number} [limit] The number of approvals to return. Defaults to 20. Maximum limit is 200. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ getApprovalRequests(filter?: string, expand?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Get all approval requests for a feature flag. * @summary List approval requests for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ getApprovalsForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Create an approval request. This endpoint requires a list of `instructions`, in semantic patch format, that will be applied when the approval request is approved and applied. If you are creating an approval request for a flag, you can use the following `instructions`: - `addVariation` - `removeVariation` - `updateVariation` - `updateDefaultVariation` For details on using these instructions, read [Update feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag). To create an approval for a flag specific to an environment, use [Create approval request for a flag](https://launchdarkly.com/docs/api/approvals/post-approval-request-for-flag). If you are creating an approval request for a segment, you can use the following read [Patch segment](https://launchdarkly.com/docs/api/segments/patch-segment) for details on the available `instructions`. * @summary Create approval request * @param {CreateApprovalRequestRequest} createApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ postApprovalRequest(createApprovalRequestRequest: CreateApprovalRequestRequest, options?: AxiosRequestConfig): Promise>; /** * Apply an approval request that has been approved. This endpoint works with approval requests for either flag or segment changes. * @summary Apply approval request * @param {string} id The approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ postApprovalRequestApply(id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: AxiosRequestConfig): Promise>; /** * Apply an approval request that has been approved. This endpoint requires a feature flag key, and can only be used for applying approval requests on flags. * @summary Apply approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestApplyRequest} postApprovalRequestApplyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ postApprovalRequestApplyForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestApplyRequest: PostApprovalRequestApplyRequest, options?: AxiosRequestConfig): Promise>; /** * Create an approval request for a feature flag. * @summary Create approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CreateFlagConfigApprovalRequestRequest} createFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ postApprovalRequestForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, createFlagConfigApprovalRequestRequest: CreateFlagConfigApprovalRequestRequest, options?: AxiosRequestConfig): Promise>; /** * Review an approval request by approving or denying changes. * @summary Review approval request * @param {string} id The approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ postApprovalRequestReview(id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: AxiosRequestConfig): Promise>; /** * Review an approval request by approving or denying changes. * @summary Review approval request for a flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The feature flag approval request ID * @param {PostApprovalRequestReviewRequest} postApprovalRequestReviewRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ postApprovalRequestReviewForFlag(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, postApprovalRequestReviewRequest: PostApprovalRequestReviewRequest, options?: AxiosRequestConfig): Promise>; /** * Create an approval request to copy a feature flag\'s configuration across environments. * @summary Create approval request to copy flag configurations across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key for the target environment * @param {CreateCopyFlagConfigApprovalRequestRequest} createCopyFlagConfigApprovalRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsApi */ postFlagCopyConfigApprovalRequest(projectKey: string, featureFlagKey: string, environmentKey: string, createCopyFlagConfigApprovalRequestRequest: CreateCopyFlagConfigApprovalRequestRequest, options?: AxiosRequestConfig): Promise>; } /** * ApprovalsBetaApi - axios parameter creator * @export */ export declare const ApprovalsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with approval requests for either flag or segment changes. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } ``` * @summary Update approval request * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApprovalRequest: (id: string, options?: AxiosRequestConfig) => Promise; /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. * @summary Update flag approval request * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagConfigApprovalRequest: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; }; /** * ApprovalsBetaApi - functional programming interface * @export */ export declare const ApprovalsBetaApiFp: (configuration?: Configuration) => { /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with approval requests for either flag or segment changes. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } ``` * @summary Update approval request * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApprovalRequest(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. * @summary Update flag approval request * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagConfigApprovalRequest(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ApprovalsBetaApi - factory interface * @export */ export declare const ApprovalsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with approval requests for either flag or segment changes. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } ``` * @summary Update approval request * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchApprovalRequest(id: string, options?: any): AxiosPromise; /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. * @summary Update flag approval request * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagConfigApprovalRequest(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; }; /** * ApprovalsBetaApi - object-oriented interface * @export * @class ApprovalsBetaApi * @extends {BaseAPI} */ export declare class ApprovalsBetaApi extends BaseAPI { /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with approval requests for either flag or segment changes. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } ``` * @summary Update approval request * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsBetaApi */ patchApprovalRequest(id: string, options?: AxiosRequestConfig): Promise>; /** * Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instruction for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. * @summary Update flag approval request * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The approval ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApprovalsBetaApi */ patchFlagConfigApprovalRequest(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; } /** * AuditLogApi - axios parameter creator * @export */ export declare const AuditLogApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary List audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {string} [spec] A resource specifier that lets you filter audit log listings by resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogEntries: (before?: number, after?: number, q?: string, limit?: number, spec?: string, options?: AxiosRequestConfig) => Promise; /** * Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation, including: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity * @summary Get audit log entry * @param {string} id The ID of the audit log entry * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogEntry: (id: string, options?: AxiosRequestConfig) => Promise; /** * Search your audit log entries. The query parameters let you restrict the results that return by date ranges, or a full-text search query. The request body lets you restrict the results that return by resource specifiers. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary Search audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {Array} [statementPost] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAuditLogEntries: (before?: number, after?: number, q?: string, limit?: number, statementPost?: Array, options?: AxiosRequestConfig) => Promise; }; /** * AuditLogApi - functional programming interface * @export */ export declare const AuditLogApiFp: (configuration?: Configuration) => { /** * Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary List audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {string} [spec] A resource specifier that lets you filter audit log listings by resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogEntries(before?: number, after?: number, q?: string, limit?: number, spec?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation, including: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity * @summary Get audit log entry * @param {string} id The ID of the audit log entry * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogEntry(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search your audit log entries. The query parameters let you restrict the results that return by date ranges, or a full-text search query. The request body lets you restrict the results that return by resource specifiers. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary Search audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {Array} [statementPost] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAuditLogEntries(before?: number, after?: number, q?: string, limit?: number, statementPost?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuditLogApi - factory interface * @export */ export declare const AuditLogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary List audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {string} [spec] A resource specifier that lets you filter audit log listings by resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogEntries(before?: number, after?: number, q?: string, limit?: number, spec?: string, options?: any): AxiosPromise; /** * Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation, including: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity * @summary Get audit log entry * @param {string} id The ID of the audit log entry * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogEntry(id: string, options?: any): AxiosPromise; /** * Search your audit log entries. The query parameters let you restrict the results that return by date ranges, or a full-text search query. The request body lets you restrict the results that return by resource specifiers. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary Search audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {Array} [statementPost] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAuditLogEntries(before?: number, after?: number, q?: string, limit?: number, statementPost?: Array, options?: any): AxiosPromise; }; /** * AuditLogApi - object-oriented interface * @export * @class AuditLogApi * @extends {BaseAPI} */ export declare class AuditLogApi extends BaseAPI { /** * Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary List audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {string} [spec] A resource specifier that lets you filter audit log listings by resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogApi */ getAuditLogEntries(before?: number, after?: number, q?: string, limit?: number, spec?: string, options?: AxiosRequestConfig): Promise>; /** * Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation, including: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity * @summary Get audit log entry * @param {string} id The ID of the audit log entry * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogApi */ getAuditLogEntry(id: string, options?: AxiosRequestConfig): Promise>; /** * Search your audit log entries. The query parameters let you restrict the results that return by date ranges, or a full-text search query. The request body lets you restrict the results that return by resource specifiers. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read [About the resource specifier syntax](https://launchdarkly.com/docs/home/account/role-resources#about-the-resource-specifier-syntax). * @summary Search audit log entries * @param {number} [before] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred before the timestamp. * @param {number} [after] A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred after the timestamp. * @param {string} [q] Text to search for. You can search for the full or partial name of the resource. * @param {number} [limit] A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. * @param {Array} [statementPost] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogApi */ postAuditLogEntries(before?: number, after?: number, q?: string, limit?: number, statementPost?: Array, options?: AxiosRequestConfig): Promise>; } /** * CodeReferencesApi - axios parameter creator * @export */ export declare const CodeReferencesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Asynchronously delete a number of branches. * @summary Delete branches * @param {string} repo The repository name to delete branches for. * @param {Array} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBranches: (repo: string, requestBody: Array, options?: AxiosRequestConfig) => Promise; /** * Delete a repository with the specified name. * @summary Delete repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRepository: (repo: string, options?: AxiosRequestConfig) => Promise; /** * Get a specific branch in a repository. * @summary Get branch * @param {string} repo The repository name * @param {string} branch The url-encoded branch name * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBranch: (repo: string, branch: string, projKey?: string, flagKey?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of branches. * @summary List branches * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBranches: (repo: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all extinctions. LaunchDarkly creates an extinction event after you remove all code references to a flag. To learn more, read [About extinction events](https://launchdarkly.com/docs/home/observability/code-references#about-extinction-events). * @summary List extinctions * @param {string} [repoName] Filter results to a specific repository * @param {string} [branchName] Filter results to a specific branch. By default, only the default branch will be queried for extinctions. * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {number} [from] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `to`. * @param {number} [to] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `from`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExtinctions: (repoName?: string, branchName?: string, projKey?: string, flagKey?: string, from?: number, to?: number, options?: AxiosRequestConfig) => Promise; /** * Get a list of connected repositories. Optionally, you can include branch metadata with the `withBranches` query parameter. Embed references for the default branch with `ReferencesForDefaultBranch`. You can also filter the list of code references by project key and flag key. * @summary List repositories * @param {string} [withBranches] If set to any value, the endpoint returns repositories with associated branch data * @param {string} [withReferencesForDefaultBranch] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {string} [projKey] A LaunchDarkly project key. If provided, this filters code reference results to the specified project. * @param {string} [flagKey] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRepositories: (withBranches?: string, withReferencesForDefaultBranch?: string, projKey?: string, flagKey?: string, options?: AxiosRequestConfig) => Promise; /** * Get a single repository by name. * @summary Get repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRepository: (repo: string, options?: AxiosRequestConfig) => Promise; /** * Get links for all projects that have code references. * @summary Get links to code reference repositories for each project * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRootStatistic: (options?: AxiosRequestConfig) => Promise; /** * Get statistics about all the code references across repositories for all flags in your project that have code references in the default branch, for example, `main`. Optionally, you can include the `flagKey` query parameter to limit your request to statistics about code references for a single flag. This endpoint returns the number of references to your flag keys in your repositories, as well as a link to each repository. * @summary Get code references statistics for flags * @param {string} projectKey The project key * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStatistics: (projectKey: string, flagKey?: string, options?: AxiosRequestConfig) => Promise; /** * Update a repository\'s settings. Updating repository settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update repository * @param {string} repo The repository name * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchRepository: (repo: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Create a new extinction. * @summary Create extinction * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {Array} extinction * @param {*} [options] Override http request option. * @throws {RequiredError} */ postExtinction: (repo: string, branch: string, extinction: Array, options?: AxiosRequestConfig) => Promise; /** * Create a repository with the specified name. * @summary Create repository * @param {RepositoryPost} repositoryPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postRepository: (repositoryPost: RepositoryPost, options?: AxiosRequestConfig) => Promise; /** * Create a new branch if it doesn\'t exist, or update the branch if it already exists. * @summary Upsert branch * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {PutBranch} putBranch * @param {*} [options] Override http request option. * @throws {RequiredError} */ putBranch: (repo: string, branch: string, putBranch: PutBranch, options?: AxiosRequestConfig) => Promise; }; /** * CodeReferencesApi - functional programming interface * @export */ export declare const CodeReferencesApiFp: (configuration?: Configuration) => { /** * Asynchronously delete a number of branches. * @summary Delete branches * @param {string} repo The repository name to delete branches for. * @param {Array} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBranches(repo: string, requestBody: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a repository with the specified name. * @summary Delete repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRepository(repo: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a specific branch in a repository. * @summary Get branch * @param {string} repo The repository name * @param {string} branch The url-encoded branch name * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBranch(repo: string, branch: string, projKey?: string, flagKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of branches. * @summary List branches * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBranches(repo: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all extinctions. LaunchDarkly creates an extinction event after you remove all code references to a flag. To learn more, read [About extinction events](https://launchdarkly.com/docs/home/observability/code-references#about-extinction-events). * @summary List extinctions * @param {string} [repoName] Filter results to a specific repository * @param {string} [branchName] Filter results to a specific branch. By default, only the default branch will be queried for extinctions. * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {number} [from] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `to`. * @param {number} [to] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `from`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExtinctions(repoName?: string, branchName?: string, projKey?: string, flagKey?: string, from?: number, to?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of connected repositories. Optionally, you can include branch metadata with the `withBranches` query parameter. Embed references for the default branch with `ReferencesForDefaultBranch`. You can also filter the list of code references by project key and flag key. * @summary List repositories * @param {string} [withBranches] If set to any value, the endpoint returns repositories with associated branch data * @param {string} [withReferencesForDefaultBranch] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {string} [projKey] A LaunchDarkly project key. If provided, this filters code reference results to the specified project. * @param {string} [flagKey] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRepositories(withBranches?: string, withReferencesForDefaultBranch?: string, projKey?: string, flagKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single repository by name. * @summary Get repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRepository(repo: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get links for all projects that have code references. * @summary Get links to code reference repositories for each project * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRootStatistic(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get statistics about all the code references across repositories for all flags in your project that have code references in the default branch, for example, `main`. Optionally, you can include the `flagKey` query parameter to limit your request to statistics about code references for a single flag. This endpoint returns the number of references to your flag keys in your repositories, as well as a link to each repository. * @summary Get code references statistics for flags * @param {string} projectKey The project key * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStatistics(projectKey: string, flagKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a repository\'s settings. Updating repository settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update repository * @param {string} repo The repository name * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchRepository(repo: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new extinction. * @summary Create extinction * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {Array} extinction * @param {*} [options] Override http request option. * @throws {RequiredError} */ postExtinction(repo: string, branch: string, extinction: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a repository with the specified name. * @summary Create repository * @param {RepositoryPost} repositoryPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postRepository(repositoryPost: RepositoryPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new branch if it doesn\'t exist, or update the branch if it already exists. * @summary Upsert branch * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {PutBranch} putBranch * @param {*} [options] Override http request option. * @throws {RequiredError} */ putBranch(repo: string, branch: string, putBranch: PutBranch, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CodeReferencesApi - factory interface * @export */ export declare const CodeReferencesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Asynchronously delete a number of branches. * @summary Delete branches * @param {string} repo The repository name to delete branches for. * @param {Array} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBranches(repo: string, requestBody: Array, options?: any): AxiosPromise; /** * Delete a repository with the specified name. * @summary Delete repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRepository(repo: string, options?: any): AxiosPromise; /** * Get a specific branch in a repository. * @summary Get branch * @param {string} repo The repository name * @param {string} branch The url-encoded branch name * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBranch(repo: string, branch: string, projKey?: string, flagKey?: string, options?: any): AxiosPromise; /** * Get a list of branches. * @summary List branches * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBranches(repo: string, options?: any): AxiosPromise; /** * Get a list of all extinctions. LaunchDarkly creates an extinction event after you remove all code references to a flag. To learn more, read [About extinction events](https://launchdarkly.com/docs/home/observability/code-references#about-extinction-events). * @summary List extinctions * @param {string} [repoName] Filter results to a specific repository * @param {string} [branchName] Filter results to a specific branch. By default, only the default branch will be queried for extinctions. * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {number} [from] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `to`. * @param {number} [to] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `from`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExtinctions(repoName?: string, branchName?: string, projKey?: string, flagKey?: string, from?: number, to?: number, options?: any): AxiosPromise; /** * Get a list of connected repositories. Optionally, you can include branch metadata with the `withBranches` query parameter. Embed references for the default branch with `ReferencesForDefaultBranch`. You can also filter the list of code references by project key and flag key. * @summary List repositories * @param {string} [withBranches] If set to any value, the endpoint returns repositories with associated branch data * @param {string} [withReferencesForDefaultBranch] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {string} [projKey] A LaunchDarkly project key. If provided, this filters code reference results to the specified project. * @param {string} [flagKey] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRepositories(withBranches?: string, withReferencesForDefaultBranch?: string, projKey?: string, flagKey?: string, options?: any): AxiosPromise; /** * Get a single repository by name. * @summary Get repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRepository(repo: string, options?: any): AxiosPromise; /** * Get links for all projects that have code references. * @summary Get links to code reference repositories for each project * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRootStatistic(options?: any): AxiosPromise; /** * Get statistics about all the code references across repositories for all flags in your project that have code references in the default branch, for example, `main`. Optionally, you can include the `flagKey` query parameter to limit your request to statistics about code references for a single flag. This endpoint returns the number of references to your flag keys in your repositories, as well as a link to each repository. * @summary Get code references statistics for flags * @param {string} projectKey The project key * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStatistics(projectKey: string, flagKey?: string, options?: any): AxiosPromise; /** * Update a repository\'s settings. Updating repository settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update repository * @param {string} repo The repository name * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchRepository(repo: string, patchOperation: Array, options?: any): AxiosPromise; /** * Create a new extinction. * @summary Create extinction * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {Array} extinction * @param {*} [options] Override http request option. * @throws {RequiredError} */ postExtinction(repo: string, branch: string, extinction: Array, options?: any): AxiosPromise; /** * Create a repository with the specified name. * @summary Create repository * @param {RepositoryPost} repositoryPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postRepository(repositoryPost: RepositoryPost, options?: any): AxiosPromise; /** * Create a new branch if it doesn\'t exist, or update the branch if it already exists. * @summary Upsert branch * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {PutBranch} putBranch * @param {*} [options] Override http request option. * @throws {RequiredError} */ putBranch(repo: string, branch: string, putBranch: PutBranch, options?: any): AxiosPromise; }; /** * CodeReferencesApi - object-oriented interface * @export * @class CodeReferencesApi * @extends {BaseAPI} */ export declare class CodeReferencesApi extends BaseAPI { /** * Asynchronously delete a number of branches. * @summary Delete branches * @param {string} repo The repository name to delete branches for. * @param {Array} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ deleteBranches(repo: string, requestBody: Array, options?: AxiosRequestConfig): Promise>; /** * Delete a repository with the specified name. * @summary Delete repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ deleteRepository(repo: string, options?: AxiosRequestConfig): Promise>; /** * Get a specific branch in a repository. * @summary Get branch * @param {string} repo The repository name * @param {string} branch The url-encoded branch name * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ getBranch(repo: string, branch: string, projKey?: string, flagKey?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of branches. * @summary List branches * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ getBranches(repo: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all extinctions. LaunchDarkly creates an extinction event after you remove all code references to a flag. To learn more, read [About extinction events](https://launchdarkly.com/docs/home/observability/code-references#about-extinction-events). * @summary List extinctions * @param {string} [repoName] Filter results to a specific repository * @param {string} [branchName] Filter results to a specific branch. By default, only the default branch will be queried for extinctions. * @param {string} [projKey] Filter results to a specific project * @param {string} [flagKey] Filter results to a specific flag key * @param {number} [from] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `to`. * @param {number} [to] Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `from`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ getExtinctions(repoName?: string, branchName?: string, projKey?: string, flagKey?: string, from?: number, to?: number, options?: AxiosRequestConfig): Promise>; /** * Get a list of connected repositories. Optionally, you can include branch metadata with the `withBranches` query parameter. Embed references for the default branch with `ReferencesForDefaultBranch`. You can also filter the list of code references by project key and flag key. * @summary List repositories * @param {string} [withBranches] If set to any value, the endpoint returns repositories with associated branch data * @param {string} [withReferencesForDefaultBranch] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {string} [projKey] A LaunchDarkly project key. If provided, this filters code reference results to the specified project. * @param {string} [flagKey] If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ getRepositories(withBranches?: string, withReferencesForDefaultBranch?: string, projKey?: string, flagKey?: string, options?: AxiosRequestConfig): Promise>; /** * Get a single repository by name. * @summary Get repository * @param {string} repo The repository name * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ getRepository(repo: string, options?: AxiosRequestConfig): Promise>; /** * Get links for all projects that have code references. * @summary Get links to code reference repositories for each project * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ getRootStatistic(options?: AxiosRequestConfig): Promise>; /** * Get statistics about all the code references across repositories for all flags in your project that have code references in the default branch, for example, `main`. Optionally, you can include the `flagKey` query parameter to limit your request to statistics about code references for a single flag. This endpoint returns the number of references to your flag keys in your repositories, as well as a link to each repository. * @summary Get code references statistics for flags * @param {string} projectKey The project key * @param {string} [flagKey] Filter results to a specific flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ getStatistics(projectKey: string, flagKey?: string, options?: AxiosRequestConfig): Promise>; /** * Update a repository\'s settings. Updating repository settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update repository * @param {string} repo The repository name * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ patchRepository(repo: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Create a new extinction. * @summary Create extinction * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {Array} extinction * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ postExtinction(repo: string, branch: string, extinction: Array, options?: AxiosRequestConfig): Promise>; /** * Create a repository with the specified name. * @summary Create repository * @param {RepositoryPost} repositoryPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ postRepository(repositoryPost: RepositoryPost, options?: AxiosRequestConfig): Promise>; /** * Create a new branch if it doesn\'t exist, or update the branch if it already exists. * @summary Upsert branch * @param {string} repo The repository name * @param {string} branch The URL-encoded branch name * @param {PutBranch} putBranch * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CodeReferencesApi */ putBranch(repo: string, branch: string, putBranch: PutBranch, options?: AxiosRequestConfig): Promise>; } /** * ContextSettingsApi - axios parameter creator * @export */ export declare const ContextSettingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Enable or disable a feature flag for a context based on its context kind and key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a context. If you previously patched the flag, and the patch included the context\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context\'s key and kind before, it calculates the flag values based on the context kind and key. * @summary Update flag settings for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} contextKind The context kind * @param {string} contextKey The context key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContextFlagSetting: (projectKey: string, environmentKey: string, contextKind: string, contextKey: string, featureFlagKey: string, valuePut: ValuePut, options?: AxiosRequestConfig) => Promise; }; /** * ContextSettingsApi - functional programming interface * @export */ export declare const ContextSettingsApiFp: (configuration?: Configuration) => { /** * Enable or disable a feature flag for a context based on its context kind and key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a context. If you previously patched the flag, and the patch included the context\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context\'s key and kind before, it calculates the flag values based on the context kind and key. * @summary Update flag settings for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} contextKind The context kind * @param {string} contextKey The context key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContextFlagSetting(projectKey: string, environmentKey: string, contextKind: string, contextKey: string, featureFlagKey: string, valuePut: ValuePut, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContextSettingsApi - factory interface * @export */ export declare const ContextSettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Enable or disable a feature flag for a context based on its context kind and key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a context. If you previously patched the flag, and the patch included the context\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context\'s key and kind before, it calculates the flag values based on the context kind and key. * @summary Update flag settings for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} contextKind The context kind * @param {string} contextKey The context key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContextFlagSetting(projectKey: string, environmentKey: string, contextKind: string, contextKey: string, featureFlagKey: string, valuePut: ValuePut, options?: any): AxiosPromise; }; /** * ContextSettingsApi - object-oriented interface * @export * @class ContextSettingsApi * @extends {BaseAPI} */ export declare class ContextSettingsApi extends BaseAPI { /** * Enable or disable a feature flag for a context based on its context kind and key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a context. If you previously patched the flag, and the patch included the context\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context\'s key and kind before, it calculates the flag values based on the context kind and key. * @summary Update flag settings for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} contextKind The context kind * @param {string} contextKey The context key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextSettingsApi */ putContextFlagSetting(projectKey: string, environmentKey: string, contextKind: string, contextKey: string, featureFlagKey: string, valuePut: ValuePut, options?: AxiosRequestConfig): Promise>; } /** * ContextsApi - axios parameter creator * @export */ export declare const ContextsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete context instances by ID. * @summary Delete context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContextInstances: (projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly\'s SDKs and REST API](https://launchdarkly.com/docs/guides/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags\' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains [\"beta\",\"q1\"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains [\"beta\",\"q1\"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`. * @summary Evaluate flags for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {number} [limit] The number of feature flags to return. Defaults to -1, which returns all flags * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ evaluateContextInstance: (projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig) => Promise; /** * Get context attribute names. * @summary Get context attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 100) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextAttributeNames: (projectKey: string, environmentKey: string, filter?: string, limit?: number, options?: AxiosRequestConfig) => Promise; /** * Get context attribute values. * @summary Get context attribute values * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} attributeName The attribute name * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 50) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextAttributeValues: (projectKey: string, environmentKey: string, attributeName: string, filter?: string, limit?: number, options?: AxiosRequestConfig) => Promise; /** * Get context instances by ID. * @summary Get context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {number} [limit] Specifies the maximum number of context instances to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextInstances: (projectKey: string, environmentKey: string, id: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig) => Promise; /** * Get all context kinds for a given project. * @summary Get context kinds * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextKindsByProjectKey: (projectKey: string, options?: AxiosRequestConfig) => Promise; /** * Get contexts based on kind and key. * @summary Get contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} kind The context kind * @param {string} key The context key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContexts: (projectKey: string, environmentKey: string, kind: string, key: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig) => Promise; /** * Create or update a context kind by key. Only the included fields will be updated. * @summary Create or update context kind * @param {string} projectKey The project key * @param {string} key The context kind key * @param {UpsertContextKindPayload} upsertContextKindPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContextKind: (projectKey: string, key: string, upsertContextKindPayload: UpsertContextKindPayload, options?: AxiosRequestConfig) => Promise; /** * Search for context instances. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about context instances, read [Context instances](https://launchdarkly.com/docs/home/observability/multi-contexts#context-instances). * @summary Search for context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextInstanceSearch} contextInstanceSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContextInstances: (projectKey: string, environmentKey: string, contextInstanceSearch: ContextInstanceSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig) => Promise; /** * Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Contexts and context kinds](https://launchdarkly.com/docs/home/observability/contexts#contexts-and-context-kinds). * @summary Search for contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextSearch} contextSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContexts: (projectKey: string, environmentKey: string, contextSearch: ContextSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig) => Promise; }; /** * ContextsApi - functional programming interface * @export */ export declare const ContextsApiFp: (configuration?: Configuration) => { /** * Delete context instances by ID. * @summary Delete context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContextInstances(projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly\'s SDKs and REST API](https://launchdarkly.com/docs/guides/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags\' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains [\"beta\",\"q1\"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains [\"beta\",\"q1\"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`. * @summary Evaluate flags for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {number} [limit] The number of feature flags to return. Defaults to -1, which returns all flags * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ evaluateContextInstance(projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get context attribute names. * @summary Get context attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 100) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextAttributeNames(projectKey: string, environmentKey: string, filter?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get context attribute values. * @summary Get context attribute values * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} attributeName The attribute name * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 50) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextAttributeValues(projectKey: string, environmentKey: string, attributeName: string, filter?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get context instances by ID. * @summary Get context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {number} [limit] Specifies the maximum number of context instances to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextInstances(projectKey: string, environmentKey: string, id: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all context kinds for a given project. * @summary Get context kinds * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextKindsByProjectKey(projectKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get contexts based on kind and key. * @summary Get contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} kind The context kind * @param {string} key The context key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContexts(projectKey: string, environmentKey: string, kind: string, key: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create or update a context kind by key. Only the included fields will be updated. * @summary Create or update context kind * @param {string} projectKey The project key * @param {string} key The context kind key * @param {UpsertContextKindPayload} upsertContextKindPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContextKind(projectKey: string, key: string, upsertContextKindPayload: UpsertContextKindPayload, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search for context instances. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about context instances, read [Context instances](https://launchdarkly.com/docs/home/observability/multi-contexts#context-instances). * @summary Search for context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextInstanceSearch} contextInstanceSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContextInstances(projectKey: string, environmentKey: string, contextInstanceSearch: ContextInstanceSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Contexts and context kinds](https://launchdarkly.com/docs/home/observability/contexts#contexts-and-context-kinds). * @summary Search for contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextSearch} contextSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContexts(projectKey: string, environmentKey: string, contextSearch: ContextSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContextsApi - factory interface * @export */ export declare const ContextsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete context instances by ID. * @summary Delete context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContextInstances(projectKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly\'s SDKs and REST API](https://launchdarkly.com/docs/guides/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags\' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains [\"beta\",\"q1\"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains [\"beta\",\"q1\"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`. * @summary Evaluate flags for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {number} [limit] The number of feature flags to return. Defaults to -1, which returns all flags * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ evaluateContextInstance(projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, limit?: number, offset?: number, sort?: string, filter?: string, options?: any): AxiosPromise; /** * Get context attribute names. * @summary Get context attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 100) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextAttributeNames(projectKey: string, environmentKey: string, filter?: string, limit?: number, options?: any): AxiosPromise; /** * Get context attribute values. * @summary Get context attribute values * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} attributeName The attribute name * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 50) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextAttributeValues(projectKey: string, environmentKey: string, attributeName: string, filter?: string, limit?: number, options?: any): AxiosPromise; /** * Get context instances by ID. * @summary Get context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {number} [limit] Specifies the maximum number of context instances to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextInstances(projectKey: string, environmentKey: string, id: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: any): AxiosPromise; /** * Get all context kinds for a given project. * @summary Get context kinds * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextKindsByProjectKey(projectKey: string, options?: any): AxiosPromise; /** * Get contexts based on kind and key. * @summary Get contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} kind The context kind * @param {string} key The context key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContexts(projectKey: string, environmentKey: string, kind: string, key: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: any): AxiosPromise; /** * Create or update a context kind by key. Only the included fields will be updated. * @summary Create or update context kind * @param {string} projectKey The project key * @param {string} key The context kind key * @param {UpsertContextKindPayload} upsertContextKindPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContextKind(projectKey: string, key: string, upsertContextKindPayload: UpsertContextKindPayload, options?: any): AxiosPromise; /** * Search for context instances. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about context instances, read [Context instances](https://launchdarkly.com/docs/home/observability/multi-contexts#context-instances). * @summary Search for context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextInstanceSearch} contextInstanceSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContextInstances(projectKey: string, environmentKey: string, contextInstanceSearch: ContextInstanceSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: any): AxiosPromise; /** * Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Contexts and context kinds](https://launchdarkly.com/docs/home/observability/contexts#contexts-and-context-kinds). * @summary Search for contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextSearch} contextSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchContexts(projectKey: string, environmentKey: string, contextSearch: ContextSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: any): AxiosPromise; }; /** * ContextsApi - object-oriented interface * @export * @class ContextsApi * @extends {BaseAPI} */ export declare class ContextsApi extends BaseAPI { /** * Delete context instances by ID. * @summary Delete context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ deleteContextInstances(projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly\'s SDKs and REST API](https://launchdarkly.com/docs/guides/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags\' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains [\"beta\",\"q1\"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains [\"beta\",\"q1\"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`. * @summary Evaluate flags for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {number} [limit] The number of feature flags to return. Defaults to -1, which returns all flags * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ evaluateContextInstance(projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig): Promise>; /** * Get context attribute names. * @summary Get context attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 100) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ getContextAttributeNames(projectKey: string, environmentKey: string, filter?: string, limit?: number, options?: AxiosRequestConfig): Promise>; /** * Get context attribute values. * @summary Get context attribute values * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} attributeName The attribute name * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 100, default: 50) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ getContextAttributeValues(projectKey: string, environmentKey: string, attributeName: string, filter?: string, limit?: number, options?: AxiosRequestConfig): Promise>; /** * Get context instances by ID. * @summary Get context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The context instance ID * @param {number} [limit] Specifies the maximum number of context instances to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ getContextInstances(projectKey: string, environmentKey: string, id: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise>; /** * Get all context kinds for a given project. * @summary Get context kinds * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ getContextKindsByProjectKey(projectKey: string, options?: AxiosRequestConfig): Promise>; /** * Get contexts based on kind and key. * @summary Get contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} kind The context kind * @param {string} key The context key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ getContexts(projectKey: string, environmentKey: string, kind: string, key: string, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise>; /** * Create or update a context kind by key. Only the included fields will be updated. * @summary Create or update context kind * @param {string} projectKey The project key * @param {string} key The context kind key * @param {UpsertContextKindPayload} upsertContextKindPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ putContextKind(projectKey: string, key: string, upsertContextKindPayload: UpsertContextKindPayload, options?: AxiosRequestConfig): Promise>; /** * Search for context instances. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about context instances, read [Context instances](https://launchdarkly.com/docs/home/observability/multi-contexts#context-instances). * @summary Search for context instances * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextInstanceSearch} contextInstanceSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching context instances. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ searchContextInstances(projectKey: string, environmentKey: string, contextInstanceSearch: ContextInstanceSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise>; /** * Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Contexts and context kinds](https://launchdarkly.com/docs/home/observability/contexts#contexts-and-context-kinds). * @summary Search for contexts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ContextSearch} contextSearch * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {string} [continuationToken] Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. * @param {string} [filter] A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances). * @param {boolean} [includeTotalCount] Specifies whether to include or omit the total count of matching contexts. Defaults to true. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContextsApi */ searchContexts(projectKey: string, environmentKey: string, contextSearch: ContextSearch, limit?: number, continuationToken?: string, sort?: string, filter?: string, includeTotalCount?: boolean, options?: AxiosRequestConfig): Promise>; } /** * CustomRolesApi - axios parameter creator * @export */ export declare const CustomRolesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a custom role by key * @summary Delete custom role * @param {string} customRoleKey The custom role key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomRole: (customRoleKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a single custom role by key or ID * @summary Get custom role * @param {string} customRoleKey The custom role key or ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomRole: (customRoleKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it\'s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you\'re interested in learning more about our enterprise plans, contact sales@launchdarkly.com. * @summary List custom roles * @param {number} [limit] The maximum number of custom roles to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomRoles: (limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Update a single custom role. Updating a custom role uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the `policy` array, set the `path` to `/policy` and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update custom role * @param {string} customRoleKey The custom role key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCustomRole: (customRoleKey: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig) => Promise; /** * Create a new custom role * @summary Create custom role * @param {CustomRolePost} customRolePost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomRole: (customRolePost: CustomRolePost, options?: AxiosRequestConfig) => Promise; }; /** * CustomRolesApi - functional programming interface * @export */ export declare const CustomRolesApiFp: (configuration?: Configuration) => { /** * Delete a custom role by key * @summary Delete custom role * @param {string} customRoleKey The custom role key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomRole(customRoleKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single custom role by key or ID * @summary Get custom role * @param {string} customRoleKey The custom role key or ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomRole(customRoleKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it\'s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you\'re interested in learning more about our enterprise plans, contact sales@launchdarkly.com. * @summary List custom roles * @param {number} [limit] The maximum number of custom roles to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomRoles(limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a single custom role. Updating a custom role uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the `policy` array, set the `path` to `/policy` and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update custom role * @param {string} customRoleKey The custom role key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCustomRole(customRoleKey: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new custom role * @summary Create custom role * @param {CustomRolePost} customRolePost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomRole(customRolePost: CustomRolePost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CustomRolesApi - factory interface * @export */ export declare const CustomRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a custom role by key * @summary Delete custom role * @param {string} customRoleKey The custom role key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomRole(customRoleKey: string, options?: any): AxiosPromise; /** * Get a single custom role by key or ID * @summary Get custom role * @param {string} customRoleKey The custom role key or ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomRole(customRoleKey: string, options?: any): AxiosPromise; /** * Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it\'s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you\'re interested in learning more about our enterprise plans, contact sales@launchdarkly.com. * @summary List custom roles * @param {number} [limit] The maximum number of custom roles to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomRoles(limit?: number, offset?: number, options?: any): AxiosPromise; /** * Update a single custom role. Updating a custom role uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the `policy` array, set the `path` to `/policy` and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update custom role * @param {string} customRoleKey The custom role key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchCustomRole(customRoleKey: string, patchWithComment: PatchWithComment, options?: any): AxiosPromise; /** * Create a new custom role * @summary Create custom role * @param {CustomRolePost} customRolePost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomRole(customRolePost: CustomRolePost, options?: any): AxiosPromise; }; /** * CustomRolesApi - object-oriented interface * @export * @class CustomRolesApi * @extends {BaseAPI} */ export declare class CustomRolesApi extends BaseAPI { /** * Delete a custom role by key * @summary Delete custom role * @param {string} customRoleKey The custom role key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomRolesApi */ deleteCustomRole(customRoleKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a single custom role by key or ID * @summary Get custom role * @param {string} customRoleKey The custom role key or ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomRolesApi */ getCustomRole(customRoleKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it\'s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you\'re interested in learning more about our enterprise plans, contact sales@launchdarkly.com. * @summary List custom roles * @param {number} [limit] The maximum number of custom roles to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomRolesApi */ getCustomRoles(limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Update a single custom role. Updating a custom role uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the `policy` array, set the `path` to `/policy` and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update custom role * @param {string} customRoleKey The custom role key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomRolesApi */ patchCustomRole(customRoleKey: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig): Promise>; /** * Create a new custom role * @summary Create custom role * @param {CustomRolePost} customRolePost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomRolesApi */ postCustomRole(customRolePost: CustomRolePost, options?: AxiosRequestConfig): Promise>; } /** * DataExportDestinationsApi - axios parameter creator * @export */ export declare const DataExportDestinationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a Data Export destination by ID. * @summary Delete Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDestination: (projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a single Data Export destination by ID. * @summary Get destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestination: (projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of Data Export destinations configured across all projects and environments. * @summary List destinations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestinations: (options?: AxiosRequestConfig) => Promise; /** * Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDestination: (projectKey: string, environmentKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination.
Click to expand config parameter details #### Azure Event Hubs To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields: * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields: * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields: * `region`: The Kinesis stream\'s AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields: * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your end users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields: * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly\'s calls to Segment. #### Snowflake To create a Data Export destination with a `kind` of `snowflake-v2`, the `config` object requires the following fields: * `publicKey`: The `publicKey` is returned as part of the [Generate Snowflake destination key pair](https://launchdarkly.com/docs/api/data-export-destinations/post-generate-warehouse-destination-key-pair) response. It is the `public_key` field. * `snowflakeHostAddress`: Your Snowflake account URL.
* @summary Create Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {DestinationPost} destinationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDestination: (projectKey: string, environmentKey: string, destinationPost: DestinationPost, options?: AxiosRequestConfig) => Promise; /** * Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination * @summary Generate Snowflake destination key pair * @param {*} [options] Override http request option. * @throws {RequiredError} */ postGenerateWarehouseDestinationKeyPair: (options?: AxiosRequestConfig) => Promise; }; /** * DataExportDestinationsApi - functional programming interface * @export */ export declare const DataExportDestinationsApiFp: (configuration?: Configuration) => { /** * Delete a Data Export destination by ID. * @summary Delete Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDestination(projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single Data Export destination by ID. * @summary Get destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestination(projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of Data Export destinations configured across all projects and environments. * @summary List destinations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestinations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDestination(projectKey: string, environmentKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination.
Click to expand config parameter details #### Azure Event Hubs To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields: * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields: * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields: * `region`: The Kinesis stream\'s AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields: * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your end users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields: * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly\'s calls to Segment. #### Snowflake To create a Data Export destination with a `kind` of `snowflake-v2`, the `config` object requires the following fields: * `publicKey`: The `publicKey` is returned as part of the [Generate Snowflake destination key pair](https://launchdarkly.com/docs/api/data-export-destinations/post-generate-warehouse-destination-key-pair) response. It is the `public_key` field. * `snowflakeHostAddress`: Your Snowflake account URL.
* @summary Create Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {DestinationPost} destinationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDestination(projectKey: string, environmentKey: string, destinationPost: DestinationPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination * @summary Generate Snowflake destination key pair * @param {*} [options] Override http request option. * @throws {RequiredError} */ postGenerateWarehouseDestinationKeyPair(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DataExportDestinationsApi - factory interface * @export */ export declare const DataExportDestinationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a Data Export destination by ID. * @summary Delete Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDestination(projectKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Get a single Data Export destination by ID. * @summary Get destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestination(projectKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Get a list of Data Export destinations configured across all projects and environments. * @summary List destinations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestinations(options?: any): AxiosPromise; /** * Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchDestination(projectKey: string, environmentKey: string, id: string, patchOperation: Array, options?: any): AxiosPromise; /** * Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination.
Click to expand config parameter details #### Azure Event Hubs To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields: * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields: * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields: * `region`: The Kinesis stream\'s AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields: * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your end users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields: * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly\'s calls to Segment. #### Snowflake To create a Data Export destination with a `kind` of `snowflake-v2`, the `config` object requires the following fields: * `publicKey`: The `publicKey` is returned as part of the [Generate Snowflake destination key pair](https://launchdarkly.com/docs/api/data-export-destinations/post-generate-warehouse-destination-key-pair) response. It is the `public_key` field. * `snowflakeHostAddress`: Your Snowflake account URL.
* @summary Create Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {DestinationPost} destinationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDestination(projectKey: string, environmentKey: string, destinationPost: DestinationPost, options?: any): AxiosPromise; /** * Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination * @summary Generate Snowflake destination key pair * @param {*} [options] Override http request option. * @throws {RequiredError} */ postGenerateWarehouseDestinationKeyPair(options?: any): AxiosPromise; }; /** * DataExportDestinationsApi - object-oriented interface * @export * @class DataExportDestinationsApi * @extends {BaseAPI} */ export declare class DataExportDestinationsApi extends BaseAPI { /** * Delete a Data Export destination by ID. * @summary Delete Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportDestinationsApi */ deleteDestination(projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a single Data Export destination by ID. * @summary Get destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportDestinationsApi */ getDestination(projectKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of Data Export destinations configured across all projects and environments. * @summary List destinations * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportDestinationsApi */ getDestinations(options?: AxiosRequestConfig): Promise>; /** * Update a Data Export destination. Updating a destination uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} id The Data Export destination ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportDestinationsApi */ patchDestination(projectKey: string, environmentKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Create a new Data Export destination. In the `config` request body parameter, the fields required depend on the type of Data Export destination.
Click to expand config parameter details #### Azure Event Hubs To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields: * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace. #### Google Cloud Pub/Sub To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields: * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to #### Amazon Kinesis To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields: * `region`: The Kinesis stream\'s AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream. #### mParticle To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields: * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your end users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous end users in mParticle #### Segment To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields: * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly\'s calls to Segment. #### Snowflake To create a Data Export destination with a `kind` of `snowflake-v2`, the `config` object requires the following fields: * `publicKey`: The `publicKey` is returned as part of the [Generate Snowflake destination key pair](https://launchdarkly.com/docs/api/data-export-destinations/post-generate-warehouse-destination-key-pair) response. It is the `public_key` field. * `snowflakeHostAddress`: Your Snowflake account URL.
* @summary Create Data Export destination * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {DestinationPost} destinationPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportDestinationsApi */ postDestination(projectKey: string, environmentKey: string, destinationPost: DestinationPost, options?: AxiosRequestConfig): Promise>; /** * Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination * @summary Generate Snowflake destination key pair * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportDestinationsApi */ postGenerateWarehouseDestinationKeyPair(options?: AxiosRequestConfig): Promise>; } /** * EnvironmentsApi - axios parameter creator * @export */ export declare const EnvironmentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a environment by key. * @summary Delete environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment: (projectKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * > ### Approval settings > > The `approvalSettings` key is only returned when [approvals](https://launchdarkly.com/docs/home/releases/approvals) for flags or segments are enabled. Get an environment given a project and key. * @summary Get environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironment: (projectKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering environments LaunchDarkly supports two fields for filters: - `query` is a string that matches against the environments\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of environment tags. It filters the list of environments that have all of the tags in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches environments with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting environments LaunchDarkly supports the following fields for sorting: - `createdOn` sorts by the creation date of the environment. - `critical` sorts by whether the environments are marked as critical. - `name` sorts by environment name. For example, `sort=name` sorts the response by environment name in ascending order. * @summary List environments * @param {string} projectKey The project key * @param {number} [limit] The number of environments to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironmentsByProject: (projectKey: string, limit?: number, offset?: number, filter?: string, sort?: string, options?: AxiosRequestConfig) => Promise; /** * Update an environment. Updating an environment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the environment object that are arrays, set the `path` to the name of the field and then append `/`. Using `/0` appends to the beginning of the array. ### Approval settings This request only returns the `approvalSettings` key if the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. Only the `canReviewOwnRequest`, `canApplyDeclinedChanges`, `minNumApprovals`, `required` and `requiredApprovalTagsfields` are editable. If you try to patch the environment by setting both `required` and `requiredApprovalTags`, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both. * @summary Update environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchEnvironment: (projectKey: string, environmentKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * > ### Approval settings > > The `approvalSettings` key is only returned when the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. > > You cannot update approval settings when creating new environments. Update approval settings with the [https://launchdarkly.com/docs/api/environments/patch-environment). Create a new environment in a specified project with a given name, key, swatch color, and default TTL. * @summary Create environment * @param {string} projectKey The project key * @param {EnvironmentPost} environmentPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postEnvironment: (projectKey: string, environmentPost: EnvironmentPost, options?: AxiosRequestConfig) => Promise; /** * Reset an environment\'s mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately. * @summary Reset environment mobile SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEnvironmentMobileKey: (projectKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Reset an environment\'s SDK key with an optional expiry time for the old key. * @summary Reset environment SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [expiry] The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately. During the period between this call and the time when the old SDK key expires, both the old SDK key and the new SDK key will work. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEnvironmentSDKKey: (projectKey: string, environmentKey: string, expiry?: number, options?: AxiosRequestConfig) => Promise; }; /** * EnvironmentsApi - functional programming interface * @export */ export declare const EnvironmentsApiFp: (configuration?: Configuration) => { /** * Delete a environment by key. * @summary Delete environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Approval settings > > The `approvalSettings` key is only returned when [approvals](https://launchdarkly.com/docs/home/releases/approvals) for flags or segments are enabled. Get an environment given a project and key. * @summary Get environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironment(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering environments LaunchDarkly supports two fields for filters: - `query` is a string that matches against the environments\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of environment tags. It filters the list of environments that have all of the tags in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches environments with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting environments LaunchDarkly supports the following fields for sorting: - `createdOn` sorts by the creation date of the environment. - `critical` sorts by whether the environments are marked as critical. - `name` sorts by environment name. For example, `sort=name` sorts the response by environment name in ascending order. * @summary List environments * @param {string} projectKey The project key * @param {number} [limit] The number of environments to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironmentsByProject(projectKey: string, limit?: number, offset?: number, filter?: string, sort?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an environment. Updating an environment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the environment object that are arrays, set the `path` to the name of the field and then append `/`. Using `/0` appends to the beginning of the array. ### Approval settings This request only returns the `approvalSettings` key if the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. Only the `canReviewOwnRequest`, `canApplyDeclinedChanges`, `minNumApprovals`, `required` and `requiredApprovalTagsfields` are editable. If you try to patch the environment by setting both `required` and `requiredApprovalTags`, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both. * @summary Update environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchEnvironment(projectKey: string, environmentKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Approval settings > > The `approvalSettings` key is only returned when the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. > > You cannot update approval settings when creating new environments. Update approval settings with the [https://launchdarkly.com/docs/api/environments/patch-environment). Create a new environment in a specified project with a given name, key, swatch color, and default TTL. * @summary Create environment * @param {string} projectKey The project key * @param {EnvironmentPost} environmentPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postEnvironment(projectKey: string, environmentPost: EnvironmentPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Reset an environment\'s mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately. * @summary Reset environment mobile SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEnvironmentMobileKey(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Reset an environment\'s SDK key with an optional expiry time for the old key. * @summary Reset environment SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [expiry] The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately. During the period between this call and the time when the old SDK key expires, both the old SDK key and the new SDK key will work. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEnvironmentSDKKey(projectKey: string, environmentKey: string, expiry?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EnvironmentsApi - factory interface * @export */ export declare const EnvironmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a environment by key. * @summary Delete environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEnvironment(projectKey: string, environmentKey: string, options?: any): AxiosPromise; /** * > ### Approval settings > > The `approvalSettings` key is only returned when [approvals](https://launchdarkly.com/docs/home/releases/approvals) for flags or segments are enabled. Get an environment given a project and key. * @summary Get environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironment(projectKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering environments LaunchDarkly supports two fields for filters: - `query` is a string that matches against the environments\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of environment tags. It filters the list of environments that have all of the tags in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches environments with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting environments LaunchDarkly supports the following fields for sorting: - `createdOn` sorts by the creation date of the environment. - `critical` sorts by whether the environments are marked as critical. - `name` sorts by environment name. For example, `sort=name` sorts the response by environment name in ascending order. * @summary List environments * @param {string} projectKey The project key * @param {number} [limit] The number of environments to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEnvironmentsByProject(projectKey: string, limit?: number, offset?: number, filter?: string, sort?: string, options?: any): AxiosPromise; /** * Update an environment. Updating an environment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the environment object that are arrays, set the `path` to the name of the field and then append `/`. Using `/0` appends to the beginning of the array. ### Approval settings This request only returns the `approvalSettings` key if the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. Only the `canReviewOwnRequest`, `canApplyDeclinedChanges`, `minNumApprovals`, `required` and `requiredApprovalTagsfields` are editable. If you try to patch the environment by setting both `required` and `requiredApprovalTags`, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both. * @summary Update environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchEnvironment(projectKey: string, environmentKey: string, patchOperation: Array, options?: any): AxiosPromise; /** * > ### Approval settings > > The `approvalSettings` key is only returned when the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. > > You cannot update approval settings when creating new environments. Update approval settings with the [https://launchdarkly.com/docs/api/environments/patch-environment). Create a new environment in a specified project with a given name, key, swatch color, and default TTL. * @summary Create environment * @param {string} projectKey The project key * @param {EnvironmentPost} environmentPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postEnvironment(projectKey: string, environmentPost: EnvironmentPost, options?: any): AxiosPromise; /** * Reset an environment\'s mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately. * @summary Reset environment mobile SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEnvironmentMobileKey(projectKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Reset an environment\'s SDK key with an optional expiry time for the old key. * @summary Reset environment SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [expiry] The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately. During the period between this call and the time when the old SDK key expires, both the old SDK key and the new SDK key will work. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEnvironmentSDKKey(projectKey: string, environmentKey: string, expiry?: number, options?: any): AxiosPromise; }; /** * EnvironmentsApi - object-oriented interface * @export * @class EnvironmentsApi * @extends {BaseAPI} */ export declare class EnvironmentsApi extends BaseAPI { /** * Delete a environment by key. * @summary Delete environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ deleteEnvironment(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * > ### Approval settings > > The `approvalSettings` key is only returned when [approvals](https://launchdarkly.com/docs/home/releases/approvals) for flags or segments are enabled. Get an environment given a project and key. * @summary Get environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ getEnvironment(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering environments LaunchDarkly supports two fields for filters: - `query` is a string that matches against the environments\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of environment tags. It filters the list of environments that have all of the tags in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches environments with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting environments LaunchDarkly supports the following fields for sorting: - `createdOn` sorts by the creation date of the environment. - `critical` sorts by whether the environments are marked as critical. - `name` sorts by environment name. For example, `sort=name` sorts the response by environment name in ascending order. * @summary List environments * @param {string} projectKey The project key * @param {number} [limit] The number of environments to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ getEnvironmentsByProject(projectKey: string, limit?: number, offset?: number, filter?: string, sort?: string, options?: AxiosRequestConfig): Promise>; /** * Update an environment. Updating an environment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). To update fields in the environment object that are arrays, set the `path` to the name of the field and then append `/`. Using `/0` appends to the beginning of the array. ### Approval settings This request only returns the `approvalSettings` key if the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. Only the `canReviewOwnRequest`, `canApplyDeclinedChanges`, `minNumApprovals`, `required` and `requiredApprovalTagsfields` are editable. If you try to patch the environment by setting both `required` and `requiredApprovalTags`, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both. * @summary Update environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ patchEnvironment(projectKey: string, environmentKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * > ### Approval settings > > The `approvalSettings` key is only returned when the [approvals](https://launchdarkly.com/docs/home/releases/approvals/) feature is enabled. > > You cannot update approval settings when creating new environments. Update approval settings with the [https://launchdarkly.com/docs/api/environments/patch-environment). Create a new environment in a specified project with a given name, key, swatch color, and default TTL. * @summary Create environment * @param {string} projectKey The project key * @param {EnvironmentPost} environmentPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ postEnvironment(projectKey: string, environmentPost: EnvironmentPost, options?: AxiosRequestConfig): Promise>; /** * Reset an environment\'s mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately. * @summary Reset environment mobile SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ resetEnvironmentMobileKey(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Reset an environment\'s SDK key with an optional expiry time for the old key. * @summary Reset environment SDK key * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [expiry] The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately. During the period between this call and the time when the old SDK key expires, both the old SDK key and the new SDK key will work. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EnvironmentsApi */ resetEnvironmentSDKKey(projectKey: string, environmentKey: string, expiry?: number, options?: AxiosRequestConfig): Promise>; } /** * ExperimentsApi - axios parameter creator * @export */ export declare const ExperimentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create an experiment. To run this experiment, you\'ll need to [create an iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) and then [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` instruction. To learn more, read [Creating experiments](https://launchdarkly.com/docs/home/experimentation/create). * @summary Create experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ExperimentPost} experimentPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createExperiment: (projectKey: string, environmentKey: string, experimentPost: ExperimentPost, options?: AxiosRequestConfig) => Promise; /** * Create an experiment iteration. Experiment iterations let you record experiments in individual blocks of time. Initially, iterations are created with a status of `not_started` and appear in the `draftIteration` field of an experiment. To start or stop an iteration, [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://launchdarkly.com/docs/home/experimentation/feature#start-experiment-iterations). * @summary Create iteration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {IterationInput} iterationInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIteration: (projectKey: string, environmentKey: string, experimentKey: string, iterationInput: IterationInput, options?: AxiosRequestConfig) => Promise; /** * Get details about an experiment. ### Expanding the experiment response LaunchDarkly supports four fields for expanding the \"Get experiment\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperiment: (projectKey: string, environmentKey: string, experimentKey: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get results from an experiment for a particular metric. LaunchDarkly supports one field for expanding the \"Get experiment results\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter with the following field: * `traffic` includes the total count of units for each treatment. For example, `expand=traffic` includes the `traffic` field for the project in the response. * @summary Get experiment results (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricKey The metric key * @param {string} [iterationId] The iteration ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExperimentResults: (projectKey: string, environmentKey: string, experimentKey: string, metricKey: string, iterationId?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get results from an experiment for a particular metric group. * @summary Get experiment results for metric group (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricGroupKey The metric group key * @param {string} [iterationId] The iteration ID * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExperimentResultsForMetricGroup: (projectKey: string, environmentKey: string, experimentKey: string, metricGroupKey: string, iterationId?: string, options?: AxiosRequestConfig) => Promise; /** * Get current experimentation settings for the given project * @summary Get experimentation settings * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationSettings: (projectKey: string, options?: AxiosRequestConfig) => Promise; /** * Get details about all experiments in an environment. ### Filtering experiments LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `flagKey` filters for only experiments that use the flag with the given key. - `metricKey` filters for only experiments that use the metric with the given key. - `status` filters for only experiments with an iteration with the given status. An iteration can have the status `not_started`, `running` or `stopped`. For example, `filter=flagKey:my-flag,status:running,metricKey:page-load-ms` filters for experiments for the given flag key and the given metric key which have a currently running iteration. ### Expanding the experiments response LaunchDarkly supports four fields for expanding the \"Get experiments\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The maximum number of experiments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {string} [lifecycleState] A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperiments: (projectKey: string, environmentKey: string, limit?: number, offset?: number, filter?: string, expand?: string, lifecycleState?: string, options?: AxiosRequestConfig) => Promise; /** * Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating experiments. #### updateName Updates the experiment name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Example updated experiment name\" }] } ``` #### updateDescription Updates the experiment description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Example updated description\" }] } ``` #### startIteration Starts a new iteration for this experiment. You must [create a new iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) before calling this instruction. An iteration may not be started until it meets the following criteria: * Its associated flag is toggled on and is not archived * Its `randomizationUnit` is set * At least one of its `treatments` has a non-zero `allocationPercent` ##### Parameters - `changeJustification`: The reason for starting a new iteration. Required when you call `startIteration` on an already running experiment, otherwise optional. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"startIteration\", \"changeJustification\": \"It\'s time to start a new iteration\" }] } ``` #### stopIteration Stops the current iteration for this experiment. ##### Parameters - `winningTreatmentId`: The ID of the winning treatment. Treatment IDs are returned as part of the [Get experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/get-experiment) response. They are the `_id` of each element in the `treatments` array. - `winningReason`: The reason for the winner Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"stopIteration\", \"winningTreatmentId\": \"3a548ec2-72ac-4e59-8518-5c24f5609ccf\", \"winningReason\": \"Example reason to stop the iteration\" }] } ``` #### archiveExperiment Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"archiveExperiment\" }] } ``` #### restoreExperiment Restores an archived experiment. After restoring an experiment, you can start new iterations for it again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"restoreExperiment\" }] } ``` * @summary Patch experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {ExperimentPatchInput} experimentPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExperiment: (projectKey: string, environmentKey: string, experimentKey: string, experimentPatchInput: ExperimentPatchInput, options?: AxiosRequestConfig) => Promise; /** * Update experimentation settings for the given project * @summary Update experimentation settings * @param {string} projectKey The project key * @param {RandomizationSettingsPut} randomizationSettingsPut * @param {*} [options] Override http request option. * @throws {RequiredError} */ putExperimentationSettings: (projectKey: string, randomizationSettingsPut: RandomizationSettingsPut, options?: AxiosRequestConfig) => Promise; }; /** * ExperimentsApi - functional programming interface * @export */ export declare const ExperimentsApiFp: (configuration?: Configuration) => { /** * Create an experiment. To run this experiment, you\'ll need to [create an iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) and then [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` instruction. To learn more, read [Creating experiments](https://launchdarkly.com/docs/home/experimentation/create). * @summary Create experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ExperimentPost} experimentPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createExperiment(projectKey: string, environmentKey: string, experimentPost: ExperimentPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an experiment iteration. Experiment iterations let you record experiments in individual blocks of time. Initially, iterations are created with a status of `not_started` and appear in the `draftIteration` field of an experiment. To start or stop an iteration, [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://launchdarkly.com/docs/home/experimentation/feature#start-experiment-iterations). * @summary Create iteration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {IterationInput} iterationInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIteration(projectKey: string, environmentKey: string, experimentKey: string, iterationInput: IterationInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get details about an experiment. ### Expanding the experiment response LaunchDarkly supports four fields for expanding the \"Get experiment\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperiment(projectKey: string, environmentKey: string, experimentKey: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get results from an experiment for a particular metric. LaunchDarkly supports one field for expanding the \"Get experiment results\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter with the following field: * `traffic` includes the total count of units for each treatment. For example, `expand=traffic` includes the `traffic` field for the project in the response. * @summary Get experiment results (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricKey The metric key * @param {string} [iterationId] The iteration ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExperimentResults(projectKey: string, environmentKey: string, experimentKey: string, metricKey: string, iterationId?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get results from an experiment for a particular metric group. * @summary Get experiment results for metric group (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricGroupKey The metric group key * @param {string} [iterationId] The iteration ID * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExperimentResultsForMetricGroup(projectKey: string, environmentKey: string, experimentKey: string, metricGroupKey: string, iterationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get current experimentation settings for the given project * @summary Get experimentation settings * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationSettings(projectKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get details about all experiments in an environment. ### Filtering experiments LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `flagKey` filters for only experiments that use the flag with the given key. - `metricKey` filters for only experiments that use the metric with the given key. - `status` filters for only experiments with an iteration with the given status. An iteration can have the status `not_started`, `running` or `stopped`. For example, `filter=flagKey:my-flag,status:running,metricKey:page-load-ms` filters for experiments for the given flag key and the given metric key which have a currently running iteration. ### Expanding the experiments response LaunchDarkly supports four fields for expanding the \"Get experiments\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The maximum number of experiments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {string} [lifecycleState] A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperiments(projectKey: string, environmentKey: string, limit?: number, offset?: number, filter?: string, expand?: string, lifecycleState?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating experiments. #### updateName Updates the experiment name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Example updated experiment name\" }] } ``` #### updateDescription Updates the experiment description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Example updated description\" }] } ``` #### startIteration Starts a new iteration for this experiment. You must [create a new iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) before calling this instruction. An iteration may not be started until it meets the following criteria: * Its associated flag is toggled on and is not archived * Its `randomizationUnit` is set * At least one of its `treatments` has a non-zero `allocationPercent` ##### Parameters - `changeJustification`: The reason for starting a new iteration. Required when you call `startIteration` on an already running experiment, otherwise optional. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"startIteration\", \"changeJustification\": \"It\'s time to start a new iteration\" }] } ``` #### stopIteration Stops the current iteration for this experiment. ##### Parameters - `winningTreatmentId`: The ID of the winning treatment. Treatment IDs are returned as part of the [Get experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/get-experiment) response. They are the `_id` of each element in the `treatments` array. - `winningReason`: The reason for the winner Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"stopIteration\", \"winningTreatmentId\": \"3a548ec2-72ac-4e59-8518-5c24f5609ccf\", \"winningReason\": \"Example reason to stop the iteration\" }] } ``` #### archiveExperiment Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"archiveExperiment\" }] } ``` #### restoreExperiment Restores an archived experiment. After restoring an experiment, you can start new iterations for it again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"restoreExperiment\" }] } ``` * @summary Patch experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {ExperimentPatchInput} experimentPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExperiment(projectKey: string, environmentKey: string, experimentKey: string, experimentPatchInput: ExperimentPatchInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update experimentation settings for the given project * @summary Update experimentation settings * @param {string} projectKey The project key * @param {RandomizationSettingsPut} randomizationSettingsPut * @param {*} [options] Override http request option. * @throws {RequiredError} */ putExperimentationSettings(projectKey: string, randomizationSettingsPut: RandomizationSettingsPut, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ExperimentsApi - factory interface * @export */ export declare const ExperimentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create an experiment. To run this experiment, you\'ll need to [create an iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) and then [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` instruction. To learn more, read [Creating experiments](https://launchdarkly.com/docs/home/experimentation/create). * @summary Create experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ExperimentPost} experimentPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createExperiment(projectKey: string, environmentKey: string, experimentPost: ExperimentPost, options?: any): AxiosPromise; /** * Create an experiment iteration. Experiment iterations let you record experiments in individual blocks of time. Initially, iterations are created with a status of `not_started` and appear in the `draftIteration` field of an experiment. To start or stop an iteration, [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://launchdarkly.com/docs/home/experimentation/feature#start-experiment-iterations). * @summary Create iteration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {IterationInput} iterationInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIteration(projectKey: string, environmentKey: string, experimentKey: string, iterationInput: IterationInput, options?: any): AxiosPromise; /** * Get details about an experiment. ### Expanding the experiment response LaunchDarkly supports four fields for expanding the \"Get experiment\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperiment(projectKey: string, environmentKey: string, experimentKey: string, expand?: string, options?: any): AxiosPromise; /** * Get results from an experiment for a particular metric. LaunchDarkly supports one field for expanding the \"Get experiment results\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter with the following field: * `traffic` includes the total count of units for each treatment. For example, `expand=traffic` includes the `traffic` field for the project in the response. * @summary Get experiment results (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricKey The metric key * @param {string} [iterationId] The iteration ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExperimentResults(projectKey: string, environmentKey: string, experimentKey: string, metricKey: string, iterationId?: string, expand?: string, options?: any): AxiosPromise; /** * Get results from an experiment for a particular metric group. * @summary Get experiment results for metric group (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricGroupKey The metric group key * @param {string} [iterationId] The iteration ID * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExperimentResultsForMetricGroup(projectKey: string, environmentKey: string, experimentKey: string, metricGroupKey: string, iterationId?: string, options?: any): AxiosPromise; /** * Get current experimentation settings for the given project * @summary Get experimentation settings * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperimentationSettings(projectKey: string, options?: any): AxiosPromise; /** * Get details about all experiments in an environment. ### Filtering experiments LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `flagKey` filters for only experiments that use the flag with the given key. - `metricKey` filters for only experiments that use the metric with the given key. - `status` filters for only experiments with an iteration with the given status. An iteration can have the status `not_started`, `running` or `stopped`. For example, `filter=flagKey:my-flag,status:running,metricKey:page-load-ms` filters for experiments for the given flag key and the given metric key which have a currently running iteration. ### Expanding the experiments response LaunchDarkly supports four fields for expanding the \"Get experiments\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The maximum number of experiments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {string} [lifecycleState] A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExperiments(projectKey: string, environmentKey: string, limit?: number, offset?: number, filter?: string, expand?: string, lifecycleState?: string, options?: any): AxiosPromise; /** * Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating experiments. #### updateName Updates the experiment name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Example updated experiment name\" }] } ``` #### updateDescription Updates the experiment description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Example updated description\" }] } ``` #### startIteration Starts a new iteration for this experiment. You must [create a new iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) before calling this instruction. An iteration may not be started until it meets the following criteria: * Its associated flag is toggled on and is not archived * Its `randomizationUnit` is set * At least one of its `treatments` has a non-zero `allocationPercent` ##### Parameters - `changeJustification`: The reason for starting a new iteration. Required when you call `startIteration` on an already running experiment, otherwise optional. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"startIteration\", \"changeJustification\": \"It\'s time to start a new iteration\" }] } ``` #### stopIteration Stops the current iteration for this experiment. ##### Parameters - `winningTreatmentId`: The ID of the winning treatment. Treatment IDs are returned as part of the [Get experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/get-experiment) response. They are the `_id` of each element in the `treatments` array. - `winningReason`: The reason for the winner Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"stopIteration\", \"winningTreatmentId\": \"3a548ec2-72ac-4e59-8518-5c24f5609ccf\", \"winningReason\": \"Example reason to stop the iteration\" }] } ``` #### archiveExperiment Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"archiveExperiment\" }] } ``` #### restoreExperiment Restores an archived experiment. After restoring an experiment, you can start new iterations for it again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"restoreExperiment\" }] } ``` * @summary Patch experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {ExperimentPatchInput} experimentPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExperiment(projectKey: string, environmentKey: string, experimentKey: string, experimentPatchInput: ExperimentPatchInput, options?: any): AxiosPromise; /** * Update experimentation settings for the given project * @summary Update experimentation settings * @param {string} projectKey The project key * @param {RandomizationSettingsPut} randomizationSettingsPut * @param {*} [options] Override http request option. * @throws {RequiredError} */ putExperimentationSettings(projectKey: string, randomizationSettingsPut: RandomizationSettingsPut, options?: any): AxiosPromise; }; /** * ExperimentsApi - object-oriented interface * @export * @class ExperimentsApi * @extends {BaseAPI} */ export declare class ExperimentsApi extends BaseAPI { /** * Create an experiment. To run this experiment, you\'ll need to [create an iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) and then [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` instruction. To learn more, read [Creating experiments](https://launchdarkly.com/docs/home/experimentation/create). * @summary Create experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {ExperimentPost} experimentPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExperimentsApi */ createExperiment(projectKey: string, environmentKey: string, experimentPost: ExperimentPost, options?: AxiosRequestConfig): Promise>; /** * Create an experiment iteration. Experiment iterations let you record experiments in individual blocks of time. Initially, iterations are created with a status of `not_started` and appear in the `draftIteration` field of an experiment. To start or stop an iteration, [update the experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/patch-experiment) with the `startIteration` or `stopIteration` instruction. To learn more, read [Start experiment iterations](https://launchdarkly.com/docs/home/experimentation/feature#start-experiment-iterations). * @summary Create iteration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {IterationInput} iterationInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExperimentsApi */ createIteration(projectKey: string, environmentKey: string, experimentKey: string, iterationInput: IterationInput, options?: AxiosRequestConfig): Promise>; /** * Get details about an experiment. ### Expanding the experiment response LaunchDarkly supports four fields for expanding the \"Get experiment\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExperimentsApi */ getExperiment(projectKey: string, environmentKey: string, experimentKey: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get results from an experiment for a particular metric. LaunchDarkly supports one field for expanding the \"Get experiment results\" response. By default, this field is **not** included in the response. To expand the response, append the `expand` query parameter with the following field: * `traffic` includes the total count of units for each treatment. For example, `expand=traffic` includes the `traffic` field for the project in the response. * @summary Get experiment results (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricKey The metric key * @param {string} [iterationId] The iteration ID * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof ExperimentsApi */ getExperimentResults(projectKey: string, environmentKey: string, experimentKey: string, metricKey: string, iterationId?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get results from an experiment for a particular metric group. * @summary Get experiment results for metric group (Deprecated) * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {string} metricGroupKey The metric group key * @param {string} [iterationId] The iteration ID * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof ExperimentsApi */ getExperimentResultsForMetricGroup(projectKey: string, environmentKey: string, experimentKey: string, metricGroupKey: string, iterationId?: string, options?: AxiosRequestConfig): Promise>; /** * Get current experimentation settings for the given project * @summary Get experimentation settings * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExperimentsApi */ getExperimentationSettings(projectKey: string, options?: AxiosRequestConfig): Promise>; /** * Get details about all experiments in an environment. ### Filtering experiments LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `flagKey` filters for only experiments that use the flag with the given key. - `metricKey` filters for only experiments that use the metric with the given key. - `status` filters for only experiments with an iteration with the given status. An iteration can have the status `not_started`, `running` or `stopped`. For example, `filter=flagKey:my-flag,status:running,metricKey:page-load-ms` filters for experiments for the given flag key and the given metric key which have a currently running iteration. ### Expanding the experiments response LaunchDarkly supports four fields for expanding the \"Get experiments\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get experiments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The maximum number of experiments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {string} [lifecycleState] A comma-separated list of experiment archived states. Supports `archived`, `active`, or both. Defaults to `active` experiments. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExperimentsApi */ getExperiments(projectKey: string, environmentKey: string, limit?: number, offset?: number, filter?: string, expand?: string, lifecycleState?: string, options?: AxiosRequestConfig): Promise>; /** * Update an experiment. Updating an experiment uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating experiments. #### updateName Updates the experiment name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Example updated experiment name\" }] } ``` #### updateDescription Updates the experiment description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Example updated description\" }] } ``` #### startIteration Starts a new iteration for this experiment. You must [create a new iteration](https://launchdarkly.com/docs/ld-docs/api/experiments/create-iteration) before calling this instruction. An iteration may not be started until it meets the following criteria: * Its associated flag is toggled on and is not archived * Its `randomizationUnit` is set * At least one of its `treatments` has a non-zero `allocationPercent` ##### Parameters - `changeJustification`: The reason for starting a new iteration. Required when you call `startIteration` on an already running experiment, otherwise optional. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"startIteration\", \"changeJustification\": \"It\'s time to start a new iteration\" }] } ``` #### stopIteration Stops the current iteration for this experiment. ##### Parameters - `winningTreatmentId`: The ID of the winning treatment. Treatment IDs are returned as part of the [Get experiment](https://launchdarkly.com/docs/ld-docs/api/experiments/get-experiment) response. They are the `_id` of each element in the `treatments` array. - `winningReason`: The reason for the winner Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"stopIteration\", \"winningTreatmentId\": \"3a548ec2-72ac-4e59-8518-5c24f5609ccf\", \"winningReason\": \"Example reason to stop the iteration\" }] } ``` #### archiveExperiment Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"archiveExperiment\" }] } ``` #### restoreExperiment Restores an archived experiment. After restoring an experiment, you can start new iterations for it again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"restoreExperiment\" }] } ``` * @summary Patch experiment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} experimentKey The experiment key * @param {ExperimentPatchInput} experimentPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExperimentsApi */ patchExperiment(projectKey: string, environmentKey: string, experimentKey: string, experimentPatchInput: ExperimentPatchInput, options?: AxiosRequestConfig): Promise>; /** * Update experimentation settings for the given project * @summary Update experimentation settings * @param {string} projectKey The project key * @param {RandomizationSettingsPut} randomizationSettingsPut * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExperimentsApi */ putExperimentationSettings(projectKey: string, randomizationSettingsPut: RandomizationSettingsPut, options?: AxiosRequestConfig): Promise>; } /** * FeatureFlagsApi - axios parameter creator * @export */ export declare const FeatureFlagsApiAxiosParamCreator: (configuration?: Configuration) => { /** * > ### Copying flag settings is an Enterprise feature > > Copying flag settings is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Copy flag settings from a source environment to a target environment. By default, this operation copies the entire flag configuration. You can use the `includedActions` or `excludedActions` to specify that only part of the flag configuration is copied. If you provide the optional `currentVersion` of a flag, this operation tests to ensure that the current flag version in the environment matches the version you\'ve specified. The operation rejects attempts to copy flag settings if the environment\'s current version of the flag does not match the version you\'ve specified. You can use this to enforce optimistic locking on copy attempts. * @summary Copy feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {FlagCopyConfigPost} flagCopyConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFeatureFlag: (projectKey: string, featureFlagKey: string, flagCopyConfigPost: FlagCopyConfigPost, options?: AxiosRequestConfig) => Promise; /** * Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses. * @summary Delete feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFeatureFlag: (projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of context targets on a feature flag that are scheduled for removal. * @summary Get expiring context targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringContextTargets: (projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring context targets for feature flag](https://launchdarkly.com/docs/api/feature-flags/get-expiring-context-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of user targets on a feature flag that are scheduled for removal. * @summary Get expiring user targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringUserTargets: (projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment. > #### Recommended use > > This endpoint can return a large amount of information. Specifying one or multiple environments with the `env` parameter can decrease response time and overall payload size. We recommend using this parameter to return only the environments relevant to your query. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. * @summary Get feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Filter configurations by environment * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlag: (projectKey: string, featureFlagKey: string, env?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get the status for a particular feature flag. * @summary Get feature flag status * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatus: (projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * Get the status for a particular feature flag across environments. * @summary Get flag status across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Optional environment filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatusAcrossEnvironments: (projectKey: string, featureFlagKey: string, env?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - `new`: You created the flag fewer than seven days ago and it has never been requested. - `active`: LaunchDarkly is receiving requests for this flag, but there are either multiple variations configured, or it is toggled off, or there have been changes to configuration in the past seven days. - `inactive`: You created the feature flag more than seven days ago, and hasn\'t been requested within the past seven days. - `launched`: LaunchDarkly is receiving requests for this flag, it is toggled on, there is only one variation configured, and there have been no changes to configuration in the past seven days. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-status). * @summary List feature flag statuses * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatuses: (projectKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all feature flags in the given project. You can include information specific to different environments by adding `env` query parameter. For example, setting `env=production` adds configuration details about your production environment to the response. You can also filter feature flags by tag with the `tag` query parameter. > #### Recommended use > > This endpoint can return a large amount of information. We recommend using some or all of these query parameters to decrease response time and overall payload size: `limit`, `env`, `query`, and `filter=creationDate`. ### Filtering flags You can filter on certain fields using the `filter` query parameter. For example, setting `filter=query:dark-mode,tags:beta+test` matches flags with the string `dark-mode` in their key or name, ignoring case, which also have the tags `beta` and `test`. The `filter` query parameter supports the following arguments: | Filter argument | Description | Example | |-----------------------|-------------|----------------------| | `applicationEvaluated` | A string. It filters the list to flags that are evaluated in the application with the given key. | `filter=applicationEvaluated:com.launchdarkly.cafe` | | `archived` | (deprecated) A boolean value. It filters the list to archived flags. | Use `filter=state:archived` instead | | `contextKindsEvaluated` | A `+`-separated list of context kind keys. It filters the list to flags which have been evaluated in the past 30 days for all of the context kinds in the list. | `filter=contextKindsEvaluated:user+application` | | `codeReferences.max` | An integer value. Use `0` to return flags that do not have code references. | `filter=codeReferences.max:0` | | `codeReferences.min` | An integer value. Use `1` to return flags that do have code references. | `filter=codeReferences.min:1` | | `creationDate` | An object with an optional `before` field whose value is Unix time in milliseconds. It filters the list to flags created before the date. | `filter=creationDate:{\"before\":1690527600000}` | | `evaluated` | An object that contains a key of `after` and a value in Unix time in milliseconds. It filters the list to all flags that have been evaluated since the time you specify, in the environment provided. This filter requires the `filterEnv` filter. | `filter=evaluated:{\"after\":1690527600000},filterEnv:production` | | `filterEnv` | A valid environment key. You must use this field for filters that are environment-specific. If there are multiple environment-specific filters, you only need to include this field once. | `filter=evaluated:{\"after\": 1590768455282},filterEnv:production` | | `hasExperiment` | A boolean value. It filters the list to flags that are used in an experiment. | `filter=hasExperiment:true` | | `maintainerId` | A valid member ID. It filters the list to flags that are maintained by this member. | `filter=maintainerId:12ab3c45de678910abc12345` | | `maintainerTeamKey` | A string. It filters the list to flags that are maintained by the team with this key. | `filter=maintainerTeamKey:example-team-key` | | `query` | A string. It filters the list to flags that include the specified string in their key or name. It is not case sensitive. | `filter=query:example` | | `releasePipeline` | A release pipeline key. It filters the list to flags that are either currently active in the release pipeline or have completed the release pipeline. | `filter=releasePipeline:default-release-pipeline` | | `state` | A string, either `live`, `deprecated`, or `archived`. It filters the list to flags in this state. | `filter=state:archived` | | `sdkAvailability` | A string, one of `client`, `mobile`, `anyClient`, `server`. Using `client` filters the list to flags whose client-side SDK availability is set to use the client-side ID. Using `mobile` filters to flags set to use the mobile key. Using `anyClient` filters to flags set to use either the client-side ID or the mobile key. Using `server` filters to flags set to use neither, that is, to flags only available in server-side SDKs. | `filter=sdkAvailability:client` | | `tags` | A `+`-separated list of tags. It filters the list to flags that have all of the tags in the list. | `filter=tags:beta+test` | | `type` | A string, either `temporary` or `permanent`. It filters the list to flags with the specified type. | `filter=type:permanent` | The documented values for the `filter` query are prior to URL encoding. For example, the `+` in `filter=tags:beta+test` must be encoded to `%2B`. By default, this endpoint returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Sorting flags You can sort flags based on the following fields: - `creationDate` sorts by the creation date of the flag. - `key` sorts by the key of the flag. - `maintainerId` sorts by the flag maintainer. - `name` sorts by flag name. - `tags` sorts by tags. - `targetingModifiedDate` sorts by the date that the flag\'s targeting rules were last modified in a given environment. It must be used with `env` parameter and it can not be combined with any other sort. If multiple `env` values are provided, it will perform sort using the first one. For example, `sort=-targetingModifiedDate&env=production&env=staging` returns results sorted by `targetingModifiedDate` for the `production` environment. - `type` sorts by flag type All fields are sorted in ascending order by default. To sort in descending order, prefix the field with a dash ( - ). For example, `sort=-name` sorts the response by flag name in descending order. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `codeReferences` includes code references for the feature flag - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response, and default cohort information is included in the `fallthrough` property of a flag\'s response. To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration). * @summary List feature flags * @param {string} projectKey The project key * @param {string} [env] Filter configurations by environment * @param {string} [tag] Filter feature flags by tag * @param {number} [limit] The number of feature flags to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {boolean} [archived] Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned * @param {boolean} [summary] By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {boolean} [compare] Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlags: (projectKey: string, env?: string, tag?: string, limit?: number, offset?: number, archived?: boolean, summary?: boolean, filter?: string, sort?: string, compare?: boolean, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Schedule a context for removal from individual targeting on a feature flag. The flag must already individually target the context. You can add, update, or remove a scheduled removal date. You can only schedule a context for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring targets.
Click to expand instructions for updating expiring targets #### addExpiringTarget Adds a date and time that LaunchDarkly will remove the context from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### updateExpiringTarget Updates the date and time that LaunchDarkly will remove the context from the flag\'s individual targeting ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` * `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### removeExpiringTarget Removes the scheduled removal of the context from the flag\'s individual targeting. The context will remain part of the flag\'s individual targeting until you explicitly remove it, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ```
* @summary Update expiring context targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringTargets: (projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: AxiosRequestConfig) => Promise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring context targets on feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-expiring-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Schedule a target for removal from individual targeting on a feature flag. The flag must already serve a variation to specific targets based on their key. You can add, update, or remove a scheduled removal date. You can only schedule a target for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting * `version`: (Optional) The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until you explicitly remove them, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting
* @summary Update expiring user targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringUserTargets: (projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: AxiosRequestConfig) => Promise; /** * Perform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a feature flag To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating feature flags takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required for some instructions only) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following `kind` instructions for updating feature flags.
Click to expand instructions for turning flags on and off These instructions require the `environmentKey` parameter. #### turnFlagOff Sets the flag\'s targeting state to **Off**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOff\" } ] } ``` #### turnFlagOn Sets the flag\'s targeting state to **On**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOn\" } ] } ```

Click to expand instructions for working with targeting and variations These instructions require the `environmentKey` parameter. Several of the instructions for working with targeting and variations require flag rule IDs, variation IDs, or clause IDs as parameters. Each of these are returned as part of the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) response. The flag rule ID is the `_id` field of each element in the `rules` array within each environment listed in the `environments` object. The variation ID is the `_id` field in each element of the `variations` array. The clause ID is the `_id` field of each element of the `clauses` array within the `rules` array within each environment listed in the `environments` object. #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"USA\", \"Canada\"] }] }] } ``` #### addPrerequisite Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag in the path parameter. ##### Parameters - `key`: Flag key of the prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addPrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addRule Adds a new targeting rule to the flag. The rule may contain `clauses` and serve the variation that `variationId` indicates, or serve a percentage rollout that `rolloutWeights`, `rolloutBucketBy`, and `rolloutContextKind` indicate. If you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `beforeRuleId`: (Optional) ID of a flag rule. - Either - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }] }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }], \"rolloutContextKind\": \"organization\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### addTargets Adds context keys to the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Returns an error if this causes the flag to target the same context key in multiple variations. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addUserTargets Adds user keys to the individual user targets for the variation that `variationId` specifies. Returns an error if this causes the flag to target the same user key in multiple variations. If you are working with contexts, use `addTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### addVariation Adds a variation to the flag. ##### Parameters - `value`: The variation value. - `name`: (Optional) The variation name. - `description`: (Optional) A description for the variation. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addVariation\", \"value\": 20, \"name\": \"New variation\" } ] } ``` #### clearTargets Removes all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### clearUserTargets Removes all individual user targets from the variation that `variationId` specifies. If you are working with contexts, use `clearTargets` instead of this instruction. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearUserTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removePrerequisite Removes the prerequisite flag indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removePrerequisite\", \"key\": \"prereq-flag-key-123abc\" } ] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ] } ``` #### removeTargets Removes context keys from the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Does nothing if the flag does not target the context keys. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeUserTargets Removes user keys from the individual user targets for the variation that `variationId` specifies. Does nothing if the flag does not target the user keys. If you are working with contexts, use `removeTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeVariation Removes a variation from the flag. ##### Parameters - `variationId`: ID of a variation of the flag to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### replacePrerequisites Removes all existing prerequisites and replaces them with the list you provide. ##### Parameters - `prerequisites`: A list of prerequisites. Each item in the list must include a flag `key` and `variationId`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"prereq-flag-key-123abc\", \"variationId\": \"10a58772-3121-400f-846b-b8a04e8944ed\" }, { \"key\": \"another-prereq-flag-key-456def\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\" } ] } ] } ``` #### replaceRules Removes all targeting rules for the flag and replaces them with the list you provide. ##### Parameters - `rules`: A list of rules. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"description\": \"My new rule\", \"clauses\": [ { \"contextKind\": \"user\", \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ] } ``` #### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - `targets`: A list of context targeting. Each item in the list includes an optional `contextKind` that defaults to `user`, a required `variationId`, and a required list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceTargets\", \"targets\": [ { \"contextKind\": \"user\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\"] }, { \"contextKind\": \"device\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"device-key-456def\"] } ] } ] } ``` #### replaceUserTargets Removes all existing user targeting and replaces it with the list of targets you provide. In the list of targets, you must include a target for each of the flag\'s variations. If you are working with contexts, use `replaceTargets` instead of this instruction. ##### Parameters - `targets`: A list of user targeting. Each item in the list must include a `variationId` and a list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\", \"user-key-456def\"] }, { \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"user-key-789ghi\"] } ] } ] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateDefaultVariation Updates the default on or off variation of the flag. ##### Parameters - `onVariationValue`: (Optional) The value of the variation of the new on variation. - `offVariationValue`: (Optional) The value of the variation of the new off variation Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ] } ``` #### updateFallthroughVariationOrRollout Updates the default or \"fallthrough\" rule for the flag, which the flag serves when a context matches none of the targeting rules. The rule can serve either the variation that `variationId` indicates, or a percentage rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutContextKind\": \"user\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### updateOffVariation Updates the default off variation to `variationId`. The flag serves the default off variation when the flag\'s targeting is **Off**. ##### Parameters - `variationId`: ID of a variation of the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### updatePrerequisite Changes the prerequisite flag that `key` indicates to use the variation that `variationId` indicates. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updatePrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateRuleDescription Updates the description of the feature flag rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag associated with this rule. ##### Parameters - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleTrackEvents\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"trackEvents\": true }] } ``` #### updateRuleVariationOrRollout Updates what `ruleId` serves when its clauses evaluate to true. The rule can serve either the variation that `variationId` indicates, or a percent rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `ruleId`: ID of a rule in the flag. - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag, for all rules. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ] } ``` #### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the feature flag, for the default rule. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ] } ``` #### updateVariation Updates a variation of the flag. ##### Parameters - `variationId`: The ID of the variation to update. - `name`: (Optional) The updated variation name. - `value`: (Optional) The updated variation value. - `description`: (Optional) The updated variation description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"value\": 20 } ] } ```

Click to expand instructions for updating flag settings These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### addCustomProperties Adds a new custom property to the feature flag. Custom properties are used to associate feature flags with LaunchDarkly integrations. For example, if you create an integration with an issue tracking service, you may want to associate a flag with a list of issues related to a feature\'s development. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### addTags Adds tags to the feature flag. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### makeFlagPermanent Marks the feature flag as permanent. LaunchDarkly does not prompt you to remove permanent flags, even if one variation is rolled out to all your customers. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagPermanent\" } ] } ``` #### makeFlagTemporary Marks the feature flag as temporary. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagTemporary\" } ] } ``` #### removeCustomProperties Removes the associated values from a custom property. If all the associated values are removed, this instruction also removes the custom property. ##### Parameters - `key`: The custom property key. - `values`: A list of the associated values to remove from the custom property. ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### removeMaintainer Removes the flag\'s maintainer. To set a new maintainer, use the `updateMaintainerMember` or `updateMaintainerTeam` instructions. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeMaintainer\" } ] } ``` #### removeTags Removes tags from the feature flag. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### replaceCustomProperties Replaces the existing associated values for a custom property with the new values. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the new associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### turnOffClientSideAvailability Turns off client-side SDK availability for the flag. This is equivalent to unchecking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn off availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOffClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### turnOnClientSideAvailability Turns on client-side SDK availability for the flag. This is equivalent to checking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn on availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOnClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### updateDescription Updates the feature flag description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDescription\", \"value\": \"Updated flag description\" } ] } ``` #### updateMaintainerMember Updates the maintainer of the flag to an existing member and removes the existing maintainer. ##### Parameters - `value`: The ID of the member. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerMember\", \"value\": \"61e9b714fd47591727db558a\" } ] } ``` #### updateMaintainerTeam Updates the maintainer of the flag to an existing team and removes the existing maintainer. ##### Parameters - `value`: The key of the team. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerTeam\", \"value\": \"example-team-key\" } ] } ``` #### updateName Updates the feature flag name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateName\", \"value\": \"Updated flag name\" } ] } ```

Click to expand instructions for updating the flag lifecycle These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### archiveFlag Archives the feature flag. This retires it from LaunchDarkly without deleting it. You cannot archive a flag that is a prerequisite of other flags. ```json { \"instructions\": [ { \"kind\": \"archiveFlag\" } ] } ``` #### deleteFlag Deletes the feature flag and its rules. You cannot restore a deleted flag. If this flag is requested again, the flag value defined in code will be returned for all contexts. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deleteFlag\" } ] } ``` #### deprecateFlag Deprecates the feature flag. This hides it from the live flags list without archiving or deleting it. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deprecateFlag\" } ] } ``` #### restoreDeprecatedFlag Restores the feature flag if it was previously deprecated. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreDeprecatedFlag\" } ] } ``` #### restoreFlag Restores the feature flag if it was previously archived. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreFlag\" } ] } ```
### Using JSON patches on a feature flag If you do not include the semantic patch header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. In the JSON patch representation, use a JSON pointer in the `path` element to describe what field to change. Use the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) endpoint to find the field you want to update. There are a few special cases to keep in mind when determining the value of the `path` element: * To add an individual target to a specific variation if the flag variation already has individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ] ``` * To add an individual target to a specific variation if the flag variation does not already have individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` * To add a flag to a release pipeline, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/releasePipelineKey\", \"value\": \"example-release-pipeline-key\" } ] ``` ### Required approvals If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will require creating an [approval request](https://launchdarkly.com/docs/api/approvals) or a [workflow](https://launchdarkly.com/docs/api/workflows). ### Conflicts If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an `ignoreConflicts` query parameter set to `true`. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response. You can update cohorts by updating `rules`. Default cohort information is included in the `fallthrough` property of a flag\'s response. You can update the default cohort by updating `fallthrough`. When you update the rollout for a cohort or the default cohort through the API, provide a rollout instead of a single `variationId`. To learn more, read [Migration flags](https://launchdarkly.com/docs/home/flags/migration). * @summary Update feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {PatchWithComment} patchWithComment * @param {boolean} [ignoreConflicts] If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFeatureFlag: (projectKey: string, featureFlagKey: string, patchWithComment: PatchWithComment, ignoreConflicts?: boolean, options?: AxiosRequestConfig) => Promise; /** * Create a feature flag with the given name, key, and variations.
Click to expand instructions for creating a migration flag ### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration. To create a migration flag, omit the `variations` and `defaults` information. Instead, provide a `purpose` of `migration`, and `migrationSettings`. If you create a migration flag with six stages, `contextKind` is required. Otherwise, it should be omitted. Here\'s an example: ```json { \"key\": \"flag-key-123\", \"purpose\": \"migration\", \"migrationSettings\": { \"stageCount\": 6, \"contextKind\": \"account\" } } ``` To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration).
* @summary Create a feature flag * @param {string} projectKey The project key * @param {FeatureFlagBody} featureFlagBody * @param {string} [clone] The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFeatureFlag: (projectKey: string, featureFlagBody: FeatureFlagBody, clone?: string, options?: AxiosRequestConfig) => Promise; /** * Returns the migration safety issues that are associated with the POSTed flag patch. The patch must use the semantic patch format for updating feature flags. * @summary Get migration safety issues * @param {string} projectKey The project key * @param {string} flagKey The migration flag key * @param {string} environmentKey The environment key * @param {FlagSempatch} flagSempatch * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMigrationSafetyIssues: (projectKey: string, flagKey: string, environmentKey: string, flagSempatch: FlagSempatch, options?: AxiosRequestConfig) => Promise; }; /** * FeatureFlagsApi - functional programming interface * @export */ export declare const FeatureFlagsApiFp: (configuration?: Configuration) => { /** * > ### Copying flag settings is an Enterprise feature > > Copying flag settings is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Copy flag settings from a source environment to a target environment. By default, this operation copies the entire flag configuration. You can use the `includedActions` or `excludedActions` to specify that only part of the flag configuration is copied. If you provide the optional `currentVersion` of a flag, this operation tests to ensure that the current flag version in the environment matches the version you\'ve specified. The operation rejects attempts to copy flag settings if the environment\'s current version of the flag does not match the version you\'ve specified. You can use this to enforce optimistic locking on copy attempts. * @summary Copy feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {FlagCopyConfigPost} flagCopyConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFeatureFlag(projectKey: string, featureFlagKey: string, flagCopyConfigPost: FlagCopyConfigPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses. * @summary Delete feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFeatureFlag(projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of context targets on a feature flag that are scheduled for removal. * @summary Get expiring context targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringContextTargets(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring context targets for feature flag](https://launchdarkly.com/docs/api/feature-flags/get-expiring-context-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of user targets on a feature flag that are scheduled for removal. * @summary Get expiring user targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringUserTargets(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment. > #### Recommended use > > This endpoint can return a large amount of information. Specifying one or multiple environments with the `env` parameter can decrease response time and overall payload size. We recommend using this parameter to return only the environments relevant to your query. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. * @summary Get feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Filter configurations by environment * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlag(projectKey: string, featureFlagKey: string, env?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the status for a particular feature flag. * @summary Get feature flag status * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatus(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the status for a particular feature flag across environments. * @summary Get flag status across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Optional environment filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatusAcrossEnvironments(projectKey: string, featureFlagKey: string, env?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - `new`: You created the flag fewer than seven days ago and it has never been requested. - `active`: LaunchDarkly is receiving requests for this flag, but there are either multiple variations configured, or it is toggled off, or there have been changes to configuration in the past seven days. - `inactive`: You created the feature flag more than seven days ago, and hasn\'t been requested within the past seven days. - `launched`: LaunchDarkly is receiving requests for this flag, it is toggled on, there is only one variation configured, and there have been no changes to configuration in the past seven days. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-status). * @summary List feature flag statuses * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatuses(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all feature flags in the given project. You can include information specific to different environments by adding `env` query parameter. For example, setting `env=production` adds configuration details about your production environment to the response. You can also filter feature flags by tag with the `tag` query parameter. > #### Recommended use > > This endpoint can return a large amount of information. We recommend using some or all of these query parameters to decrease response time and overall payload size: `limit`, `env`, `query`, and `filter=creationDate`. ### Filtering flags You can filter on certain fields using the `filter` query parameter. For example, setting `filter=query:dark-mode,tags:beta+test` matches flags with the string `dark-mode` in their key or name, ignoring case, which also have the tags `beta` and `test`. The `filter` query parameter supports the following arguments: | Filter argument | Description | Example | |-----------------------|-------------|----------------------| | `applicationEvaluated` | A string. It filters the list to flags that are evaluated in the application with the given key. | `filter=applicationEvaluated:com.launchdarkly.cafe` | | `archived` | (deprecated) A boolean value. It filters the list to archived flags. | Use `filter=state:archived` instead | | `contextKindsEvaluated` | A `+`-separated list of context kind keys. It filters the list to flags which have been evaluated in the past 30 days for all of the context kinds in the list. | `filter=contextKindsEvaluated:user+application` | | `codeReferences.max` | An integer value. Use `0` to return flags that do not have code references. | `filter=codeReferences.max:0` | | `codeReferences.min` | An integer value. Use `1` to return flags that do have code references. | `filter=codeReferences.min:1` | | `creationDate` | An object with an optional `before` field whose value is Unix time in milliseconds. It filters the list to flags created before the date. | `filter=creationDate:{\"before\":1690527600000}` | | `evaluated` | An object that contains a key of `after` and a value in Unix time in milliseconds. It filters the list to all flags that have been evaluated since the time you specify, in the environment provided. This filter requires the `filterEnv` filter. | `filter=evaluated:{\"after\":1690527600000},filterEnv:production` | | `filterEnv` | A valid environment key. You must use this field for filters that are environment-specific. If there are multiple environment-specific filters, you only need to include this field once. | `filter=evaluated:{\"after\": 1590768455282},filterEnv:production` | | `hasExperiment` | A boolean value. It filters the list to flags that are used in an experiment. | `filter=hasExperiment:true` | | `maintainerId` | A valid member ID. It filters the list to flags that are maintained by this member. | `filter=maintainerId:12ab3c45de678910abc12345` | | `maintainerTeamKey` | A string. It filters the list to flags that are maintained by the team with this key. | `filter=maintainerTeamKey:example-team-key` | | `query` | A string. It filters the list to flags that include the specified string in their key or name. It is not case sensitive. | `filter=query:example` | | `releasePipeline` | A release pipeline key. It filters the list to flags that are either currently active in the release pipeline or have completed the release pipeline. | `filter=releasePipeline:default-release-pipeline` | | `state` | A string, either `live`, `deprecated`, or `archived`. It filters the list to flags in this state. | `filter=state:archived` | | `sdkAvailability` | A string, one of `client`, `mobile`, `anyClient`, `server`. Using `client` filters the list to flags whose client-side SDK availability is set to use the client-side ID. Using `mobile` filters to flags set to use the mobile key. Using `anyClient` filters to flags set to use either the client-side ID or the mobile key. Using `server` filters to flags set to use neither, that is, to flags only available in server-side SDKs. | `filter=sdkAvailability:client` | | `tags` | A `+`-separated list of tags. It filters the list to flags that have all of the tags in the list. | `filter=tags:beta+test` | | `type` | A string, either `temporary` or `permanent`. It filters the list to flags with the specified type. | `filter=type:permanent` | The documented values for the `filter` query are prior to URL encoding. For example, the `+` in `filter=tags:beta+test` must be encoded to `%2B`. By default, this endpoint returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Sorting flags You can sort flags based on the following fields: - `creationDate` sorts by the creation date of the flag. - `key` sorts by the key of the flag. - `maintainerId` sorts by the flag maintainer. - `name` sorts by flag name. - `tags` sorts by tags. - `targetingModifiedDate` sorts by the date that the flag\'s targeting rules were last modified in a given environment. It must be used with `env` parameter and it can not be combined with any other sort. If multiple `env` values are provided, it will perform sort using the first one. For example, `sort=-targetingModifiedDate&env=production&env=staging` returns results sorted by `targetingModifiedDate` for the `production` environment. - `type` sorts by flag type All fields are sorted in ascending order by default. To sort in descending order, prefix the field with a dash ( - ). For example, `sort=-name` sorts the response by flag name in descending order. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `codeReferences` includes code references for the feature flag - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response, and default cohort information is included in the `fallthrough` property of a flag\'s response. To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration). * @summary List feature flags * @param {string} projectKey The project key * @param {string} [env] Filter configurations by environment * @param {string} [tag] Filter feature flags by tag * @param {number} [limit] The number of feature flags to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {boolean} [archived] Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned * @param {boolean} [summary] By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {boolean} [compare] Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlags(projectKey: string, env?: string, tag?: string, limit?: number, offset?: number, archived?: boolean, summary?: boolean, filter?: string, sort?: string, compare?: boolean, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Schedule a context for removal from individual targeting on a feature flag. The flag must already individually target the context. You can add, update, or remove a scheduled removal date. You can only schedule a context for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring targets.
Click to expand instructions for updating expiring targets #### addExpiringTarget Adds a date and time that LaunchDarkly will remove the context from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### updateExpiringTarget Updates the date and time that LaunchDarkly will remove the context from the flag\'s individual targeting ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` * `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### removeExpiringTarget Removes the scheduled removal of the context from the flag\'s individual targeting. The context will remain part of the flag\'s individual targeting until you explicitly remove it, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ```
* @summary Update expiring context targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringTargets(projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring context targets on feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-expiring-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Schedule a target for removal from individual targeting on a feature flag. The flag must already serve a variation to specific targets based on their key. You can add, update, or remove a scheduled removal date. You can only schedule a target for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting * `version`: (Optional) The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until you explicitly remove them, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting
* @summary Update expiring user targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringUserTargets(projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Perform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a feature flag To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating feature flags takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required for some instructions only) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following `kind` instructions for updating feature flags.
Click to expand instructions for turning flags on and off These instructions require the `environmentKey` parameter. #### turnFlagOff Sets the flag\'s targeting state to **Off**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOff\" } ] } ``` #### turnFlagOn Sets the flag\'s targeting state to **On**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOn\" } ] } ```

Click to expand instructions for working with targeting and variations These instructions require the `environmentKey` parameter. Several of the instructions for working with targeting and variations require flag rule IDs, variation IDs, or clause IDs as parameters. Each of these are returned as part of the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) response. The flag rule ID is the `_id` field of each element in the `rules` array within each environment listed in the `environments` object. The variation ID is the `_id` field in each element of the `variations` array. The clause ID is the `_id` field of each element of the `clauses` array within the `rules` array within each environment listed in the `environments` object. #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"USA\", \"Canada\"] }] }] } ``` #### addPrerequisite Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag in the path parameter. ##### Parameters - `key`: Flag key of the prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addPrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addRule Adds a new targeting rule to the flag. The rule may contain `clauses` and serve the variation that `variationId` indicates, or serve a percentage rollout that `rolloutWeights`, `rolloutBucketBy`, and `rolloutContextKind` indicate. If you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `beforeRuleId`: (Optional) ID of a flag rule. - Either - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }] }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }], \"rolloutContextKind\": \"organization\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### addTargets Adds context keys to the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Returns an error if this causes the flag to target the same context key in multiple variations. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addUserTargets Adds user keys to the individual user targets for the variation that `variationId` specifies. Returns an error if this causes the flag to target the same user key in multiple variations. If you are working with contexts, use `addTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### addVariation Adds a variation to the flag. ##### Parameters - `value`: The variation value. - `name`: (Optional) The variation name. - `description`: (Optional) A description for the variation. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addVariation\", \"value\": 20, \"name\": \"New variation\" } ] } ``` #### clearTargets Removes all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### clearUserTargets Removes all individual user targets from the variation that `variationId` specifies. If you are working with contexts, use `clearTargets` instead of this instruction. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearUserTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removePrerequisite Removes the prerequisite flag indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removePrerequisite\", \"key\": \"prereq-flag-key-123abc\" } ] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ] } ``` #### removeTargets Removes context keys from the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Does nothing if the flag does not target the context keys. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeUserTargets Removes user keys from the individual user targets for the variation that `variationId` specifies. Does nothing if the flag does not target the user keys. If you are working with contexts, use `removeTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeVariation Removes a variation from the flag. ##### Parameters - `variationId`: ID of a variation of the flag to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### replacePrerequisites Removes all existing prerequisites and replaces them with the list you provide. ##### Parameters - `prerequisites`: A list of prerequisites. Each item in the list must include a flag `key` and `variationId`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"prereq-flag-key-123abc\", \"variationId\": \"10a58772-3121-400f-846b-b8a04e8944ed\" }, { \"key\": \"another-prereq-flag-key-456def\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\" } ] } ] } ``` #### replaceRules Removes all targeting rules for the flag and replaces them with the list you provide. ##### Parameters - `rules`: A list of rules. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"description\": \"My new rule\", \"clauses\": [ { \"contextKind\": \"user\", \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ] } ``` #### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - `targets`: A list of context targeting. Each item in the list includes an optional `contextKind` that defaults to `user`, a required `variationId`, and a required list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceTargets\", \"targets\": [ { \"contextKind\": \"user\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\"] }, { \"contextKind\": \"device\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"device-key-456def\"] } ] } ] } ``` #### replaceUserTargets Removes all existing user targeting and replaces it with the list of targets you provide. In the list of targets, you must include a target for each of the flag\'s variations. If you are working with contexts, use `replaceTargets` instead of this instruction. ##### Parameters - `targets`: A list of user targeting. Each item in the list must include a `variationId` and a list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\", \"user-key-456def\"] }, { \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"user-key-789ghi\"] } ] } ] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateDefaultVariation Updates the default on or off variation of the flag. ##### Parameters - `onVariationValue`: (Optional) The value of the variation of the new on variation. - `offVariationValue`: (Optional) The value of the variation of the new off variation Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ] } ``` #### updateFallthroughVariationOrRollout Updates the default or \"fallthrough\" rule for the flag, which the flag serves when a context matches none of the targeting rules. The rule can serve either the variation that `variationId` indicates, or a percentage rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutContextKind\": \"user\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### updateOffVariation Updates the default off variation to `variationId`. The flag serves the default off variation when the flag\'s targeting is **Off**. ##### Parameters - `variationId`: ID of a variation of the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### updatePrerequisite Changes the prerequisite flag that `key` indicates to use the variation that `variationId` indicates. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updatePrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateRuleDescription Updates the description of the feature flag rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag associated with this rule. ##### Parameters - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleTrackEvents\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"trackEvents\": true }] } ``` #### updateRuleVariationOrRollout Updates what `ruleId` serves when its clauses evaluate to true. The rule can serve either the variation that `variationId` indicates, or a percent rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `ruleId`: ID of a rule in the flag. - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag, for all rules. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ] } ``` #### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the feature flag, for the default rule. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ] } ``` #### updateVariation Updates a variation of the flag. ##### Parameters - `variationId`: The ID of the variation to update. - `name`: (Optional) The updated variation name. - `value`: (Optional) The updated variation value. - `description`: (Optional) The updated variation description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"value\": 20 } ] } ```

Click to expand instructions for updating flag settings These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### addCustomProperties Adds a new custom property to the feature flag. Custom properties are used to associate feature flags with LaunchDarkly integrations. For example, if you create an integration with an issue tracking service, you may want to associate a flag with a list of issues related to a feature\'s development. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### addTags Adds tags to the feature flag. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### makeFlagPermanent Marks the feature flag as permanent. LaunchDarkly does not prompt you to remove permanent flags, even if one variation is rolled out to all your customers. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagPermanent\" } ] } ``` #### makeFlagTemporary Marks the feature flag as temporary. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagTemporary\" } ] } ``` #### removeCustomProperties Removes the associated values from a custom property. If all the associated values are removed, this instruction also removes the custom property. ##### Parameters - `key`: The custom property key. - `values`: A list of the associated values to remove from the custom property. ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### removeMaintainer Removes the flag\'s maintainer. To set a new maintainer, use the `updateMaintainerMember` or `updateMaintainerTeam` instructions. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeMaintainer\" } ] } ``` #### removeTags Removes tags from the feature flag. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### replaceCustomProperties Replaces the existing associated values for a custom property with the new values. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the new associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### turnOffClientSideAvailability Turns off client-side SDK availability for the flag. This is equivalent to unchecking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn off availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOffClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### turnOnClientSideAvailability Turns on client-side SDK availability for the flag. This is equivalent to checking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn on availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOnClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### updateDescription Updates the feature flag description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDescription\", \"value\": \"Updated flag description\" } ] } ``` #### updateMaintainerMember Updates the maintainer of the flag to an existing member and removes the existing maintainer. ##### Parameters - `value`: The ID of the member. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerMember\", \"value\": \"61e9b714fd47591727db558a\" } ] } ``` #### updateMaintainerTeam Updates the maintainer of the flag to an existing team and removes the existing maintainer. ##### Parameters - `value`: The key of the team. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerTeam\", \"value\": \"example-team-key\" } ] } ``` #### updateName Updates the feature flag name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateName\", \"value\": \"Updated flag name\" } ] } ```

Click to expand instructions for updating the flag lifecycle These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### archiveFlag Archives the feature flag. This retires it from LaunchDarkly without deleting it. You cannot archive a flag that is a prerequisite of other flags. ```json { \"instructions\": [ { \"kind\": \"archiveFlag\" } ] } ``` #### deleteFlag Deletes the feature flag and its rules. You cannot restore a deleted flag. If this flag is requested again, the flag value defined in code will be returned for all contexts. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deleteFlag\" } ] } ``` #### deprecateFlag Deprecates the feature flag. This hides it from the live flags list without archiving or deleting it. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deprecateFlag\" } ] } ``` #### restoreDeprecatedFlag Restores the feature flag if it was previously deprecated. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreDeprecatedFlag\" } ] } ``` #### restoreFlag Restores the feature flag if it was previously archived. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreFlag\" } ] } ```
### Using JSON patches on a feature flag If you do not include the semantic patch header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. In the JSON patch representation, use a JSON pointer in the `path` element to describe what field to change. Use the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) endpoint to find the field you want to update. There are a few special cases to keep in mind when determining the value of the `path` element: * To add an individual target to a specific variation if the flag variation already has individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ] ``` * To add an individual target to a specific variation if the flag variation does not already have individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` * To add a flag to a release pipeline, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/releasePipelineKey\", \"value\": \"example-release-pipeline-key\" } ] ``` ### Required approvals If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will require creating an [approval request](https://launchdarkly.com/docs/api/approvals) or a [workflow](https://launchdarkly.com/docs/api/workflows). ### Conflicts If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an `ignoreConflicts` query parameter set to `true`. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response. You can update cohorts by updating `rules`. Default cohort information is included in the `fallthrough` property of a flag\'s response. You can update the default cohort by updating `fallthrough`. When you update the rollout for a cohort or the default cohort through the API, provide a rollout instead of a single `variationId`. To learn more, read [Migration flags](https://launchdarkly.com/docs/home/flags/migration). * @summary Update feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {PatchWithComment} patchWithComment * @param {boolean} [ignoreConflicts] If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFeatureFlag(projectKey: string, featureFlagKey: string, patchWithComment: PatchWithComment, ignoreConflicts?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a feature flag with the given name, key, and variations.
Click to expand instructions for creating a migration flag ### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration. To create a migration flag, omit the `variations` and `defaults` information. Instead, provide a `purpose` of `migration`, and `migrationSettings`. If you create a migration flag with six stages, `contextKind` is required. Otherwise, it should be omitted. Here\'s an example: ```json { \"key\": \"flag-key-123\", \"purpose\": \"migration\", \"migrationSettings\": { \"stageCount\": 6, \"contextKind\": \"account\" } } ``` To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration).
* @summary Create a feature flag * @param {string} projectKey The project key * @param {FeatureFlagBody} featureFlagBody * @param {string} [clone] The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFeatureFlag(projectKey: string, featureFlagBody: FeatureFlagBody, clone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the migration safety issues that are associated with the POSTed flag patch. The patch must use the semantic patch format for updating feature flags. * @summary Get migration safety issues * @param {string} projectKey The project key * @param {string} flagKey The migration flag key * @param {string} environmentKey The environment key * @param {FlagSempatch} flagSempatch * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMigrationSafetyIssues(projectKey: string, flagKey: string, environmentKey: string, flagSempatch: FlagSempatch, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * FeatureFlagsApi - factory interface * @export */ export declare const FeatureFlagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * > ### Copying flag settings is an Enterprise feature > > Copying flag settings is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Copy flag settings from a source environment to a target environment. By default, this operation copies the entire flag configuration. You can use the `includedActions` or `excludedActions` to specify that only part of the flag configuration is copied. If you provide the optional `currentVersion` of a flag, this operation tests to ensure that the current flag version in the environment matches the version you\'ve specified. The operation rejects attempts to copy flag settings if the environment\'s current version of the flag does not match the version you\'ve specified. You can use this to enforce optimistic locking on copy attempts. * @summary Copy feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {FlagCopyConfigPost} flagCopyConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ copyFeatureFlag(projectKey: string, featureFlagKey: string, flagCopyConfigPost: FlagCopyConfigPost, options?: any): AxiosPromise; /** * Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses. * @summary Delete feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFeatureFlag(projectKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * Get a list of context targets on a feature flag that are scheduled for removal. * @summary Get expiring context targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringContextTargets(projectKey: string, environmentKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring context targets for feature flag](https://launchdarkly.com/docs/api/feature-flags/get-expiring-context-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of user targets on a feature flag that are scheduled for removal. * @summary Get expiring user targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringUserTargets(projectKey: string, environmentKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment. > #### Recommended use > > This endpoint can return a large amount of information. Specifying one or multiple environments with the `env` parameter can decrease response time and overall payload size. We recommend using this parameter to return only the environments relevant to your query. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. * @summary Get feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Filter configurations by environment * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlag(projectKey: string, featureFlagKey: string, env?: string, expand?: string, options?: any): AxiosPromise; /** * Get the status for a particular feature flag. * @summary Get feature flag status * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatus(projectKey: string, environmentKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * Get the status for a particular feature flag across environments. * @summary Get flag status across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Optional environment filter * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatusAcrossEnvironments(projectKey: string, featureFlagKey: string, env?: string, options?: any): AxiosPromise; /** * Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - `new`: You created the flag fewer than seven days ago and it has never been requested. - `active`: LaunchDarkly is receiving requests for this flag, but there are either multiple variations configured, or it is toggled off, or there have been changes to configuration in the past seven days. - `inactive`: You created the feature flag more than seven days ago, and hasn\'t been requested within the past seven days. - `launched`: LaunchDarkly is receiving requests for this flag, it is toggled on, there is only one variation configured, and there have been no changes to configuration in the past seven days. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-status). * @summary List feature flag statuses * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagStatuses(projectKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Get a list of all feature flags in the given project. You can include information specific to different environments by adding `env` query parameter. For example, setting `env=production` adds configuration details about your production environment to the response. You can also filter feature flags by tag with the `tag` query parameter. > #### Recommended use > > This endpoint can return a large amount of information. We recommend using some or all of these query parameters to decrease response time and overall payload size: `limit`, `env`, `query`, and `filter=creationDate`. ### Filtering flags You can filter on certain fields using the `filter` query parameter. For example, setting `filter=query:dark-mode,tags:beta+test` matches flags with the string `dark-mode` in their key or name, ignoring case, which also have the tags `beta` and `test`. The `filter` query parameter supports the following arguments: | Filter argument | Description | Example | |-----------------------|-------------|----------------------| | `applicationEvaluated` | A string. It filters the list to flags that are evaluated in the application with the given key. | `filter=applicationEvaluated:com.launchdarkly.cafe` | | `archived` | (deprecated) A boolean value. It filters the list to archived flags. | Use `filter=state:archived` instead | | `contextKindsEvaluated` | A `+`-separated list of context kind keys. It filters the list to flags which have been evaluated in the past 30 days for all of the context kinds in the list. | `filter=contextKindsEvaluated:user+application` | | `codeReferences.max` | An integer value. Use `0` to return flags that do not have code references. | `filter=codeReferences.max:0` | | `codeReferences.min` | An integer value. Use `1` to return flags that do have code references. | `filter=codeReferences.min:1` | | `creationDate` | An object with an optional `before` field whose value is Unix time in milliseconds. It filters the list to flags created before the date. | `filter=creationDate:{\"before\":1690527600000}` | | `evaluated` | An object that contains a key of `after` and a value in Unix time in milliseconds. It filters the list to all flags that have been evaluated since the time you specify, in the environment provided. This filter requires the `filterEnv` filter. | `filter=evaluated:{\"after\":1690527600000},filterEnv:production` | | `filterEnv` | A valid environment key. You must use this field for filters that are environment-specific. If there are multiple environment-specific filters, you only need to include this field once. | `filter=evaluated:{\"after\": 1590768455282},filterEnv:production` | | `hasExperiment` | A boolean value. It filters the list to flags that are used in an experiment. | `filter=hasExperiment:true` | | `maintainerId` | A valid member ID. It filters the list to flags that are maintained by this member. | `filter=maintainerId:12ab3c45de678910abc12345` | | `maintainerTeamKey` | A string. It filters the list to flags that are maintained by the team with this key. | `filter=maintainerTeamKey:example-team-key` | | `query` | A string. It filters the list to flags that include the specified string in their key or name. It is not case sensitive. | `filter=query:example` | | `releasePipeline` | A release pipeline key. It filters the list to flags that are either currently active in the release pipeline or have completed the release pipeline. | `filter=releasePipeline:default-release-pipeline` | | `state` | A string, either `live`, `deprecated`, or `archived`. It filters the list to flags in this state. | `filter=state:archived` | | `sdkAvailability` | A string, one of `client`, `mobile`, `anyClient`, `server`. Using `client` filters the list to flags whose client-side SDK availability is set to use the client-side ID. Using `mobile` filters to flags set to use the mobile key. Using `anyClient` filters to flags set to use either the client-side ID or the mobile key. Using `server` filters to flags set to use neither, that is, to flags only available in server-side SDKs. | `filter=sdkAvailability:client` | | `tags` | A `+`-separated list of tags. It filters the list to flags that have all of the tags in the list. | `filter=tags:beta+test` | | `type` | A string, either `temporary` or `permanent`. It filters the list to flags with the specified type. | `filter=type:permanent` | The documented values for the `filter` query are prior to URL encoding. For example, the `+` in `filter=tags:beta+test` must be encoded to `%2B`. By default, this endpoint returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Sorting flags You can sort flags based on the following fields: - `creationDate` sorts by the creation date of the flag. - `key` sorts by the key of the flag. - `maintainerId` sorts by the flag maintainer. - `name` sorts by flag name. - `tags` sorts by tags. - `targetingModifiedDate` sorts by the date that the flag\'s targeting rules were last modified in a given environment. It must be used with `env` parameter and it can not be combined with any other sort. If multiple `env` values are provided, it will perform sort using the first one. For example, `sort=-targetingModifiedDate&env=production&env=staging` returns results sorted by `targetingModifiedDate` for the `production` environment. - `type` sorts by flag type All fields are sorted in ascending order by default. To sort in descending order, prefix the field with a dash ( - ). For example, `sort=-name` sorts the response by flag name in descending order. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `codeReferences` includes code references for the feature flag - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response, and default cohort information is included in the `fallthrough` property of a flag\'s response. To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration). * @summary List feature flags * @param {string} projectKey The project key * @param {string} [env] Filter configurations by environment * @param {string} [tag] Filter feature flags by tag * @param {number} [limit] The number of feature flags to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {boolean} [archived] Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned * @param {boolean} [summary] By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {boolean} [compare] Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlags(projectKey: string, env?: string, tag?: string, limit?: number, offset?: number, archived?: boolean, summary?: boolean, filter?: string, sort?: string, compare?: boolean, expand?: string, options?: any): AxiosPromise; /** * Schedule a context for removal from individual targeting on a feature flag. The flag must already individually target the context. You can add, update, or remove a scheduled removal date. You can only schedule a context for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring targets.
Click to expand instructions for updating expiring targets #### addExpiringTarget Adds a date and time that LaunchDarkly will remove the context from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### updateExpiringTarget Updates the date and time that LaunchDarkly will remove the context from the flag\'s individual targeting ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` * `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### removeExpiringTarget Removes the scheduled removal of the context from the flag\'s individual targeting. The context will remain part of the flag\'s individual targeting until you explicitly remove it, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ```
* @summary Update expiring context targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringTargets(projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: any): AxiosPromise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring context targets on feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-expiring-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Schedule a target for removal from individual targeting on a feature flag. The flag must already serve a variation to specific targets based on their key. You can add, update, or remove a scheduled removal date. You can only schedule a target for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting * `version`: (Optional) The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until you explicitly remove them, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting
* @summary Update expiring user targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringUserTargets(projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: any): AxiosPromise; /** * Perform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a feature flag To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating feature flags takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required for some instructions only) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following `kind` instructions for updating feature flags.
Click to expand instructions for turning flags on and off These instructions require the `environmentKey` parameter. #### turnFlagOff Sets the flag\'s targeting state to **Off**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOff\" } ] } ``` #### turnFlagOn Sets the flag\'s targeting state to **On**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOn\" } ] } ```

Click to expand instructions for working with targeting and variations These instructions require the `environmentKey` parameter. Several of the instructions for working with targeting and variations require flag rule IDs, variation IDs, or clause IDs as parameters. Each of these are returned as part of the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) response. The flag rule ID is the `_id` field of each element in the `rules` array within each environment listed in the `environments` object. The variation ID is the `_id` field in each element of the `variations` array. The clause ID is the `_id` field of each element of the `clauses` array within the `rules` array within each environment listed in the `environments` object. #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"USA\", \"Canada\"] }] }] } ``` #### addPrerequisite Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag in the path parameter. ##### Parameters - `key`: Flag key of the prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addPrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addRule Adds a new targeting rule to the flag. The rule may contain `clauses` and serve the variation that `variationId` indicates, or serve a percentage rollout that `rolloutWeights`, `rolloutBucketBy`, and `rolloutContextKind` indicate. If you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `beforeRuleId`: (Optional) ID of a flag rule. - Either - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }] }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }], \"rolloutContextKind\": \"organization\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### addTargets Adds context keys to the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Returns an error if this causes the flag to target the same context key in multiple variations. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addUserTargets Adds user keys to the individual user targets for the variation that `variationId` specifies. Returns an error if this causes the flag to target the same user key in multiple variations. If you are working with contexts, use `addTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### addVariation Adds a variation to the flag. ##### Parameters - `value`: The variation value. - `name`: (Optional) The variation name. - `description`: (Optional) A description for the variation. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addVariation\", \"value\": 20, \"name\": \"New variation\" } ] } ``` #### clearTargets Removes all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### clearUserTargets Removes all individual user targets from the variation that `variationId` specifies. If you are working with contexts, use `clearTargets` instead of this instruction. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearUserTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removePrerequisite Removes the prerequisite flag indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removePrerequisite\", \"key\": \"prereq-flag-key-123abc\" } ] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ] } ``` #### removeTargets Removes context keys from the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Does nothing if the flag does not target the context keys. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeUserTargets Removes user keys from the individual user targets for the variation that `variationId` specifies. Does nothing if the flag does not target the user keys. If you are working with contexts, use `removeTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeVariation Removes a variation from the flag. ##### Parameters - `variationId`: ID of a variation of the flag to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### replacePrerequisites Removes all existing prerequisites and replaces them with the list you provide. ##### Parameters - `prerequisites`: A list of prerequisites. Each item in the list must include a flag `key` and `variationId`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"prereq-flag-key-123abc\", \"variationId\": \"10a58772-3121-400f-846b-b8a04e8944ed\" }, { \"key\": \"another-prereq-flag-key-456def\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\" } ] } ] } ``` #### replaceRules Removes all targeting rules for the flag and replaces them with the list you provide. ##### Parameters - `rules`: A list of rules. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"description\": \"My new rule\", \"clauses\": [ { \"contextKind\": \"user\", \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ] } ``` #### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - `targets`: A list of context targeting. Each item in the list includes an optional `contextKind` that defaults to `user`, a required `variationId`, and a required list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceTargets\", \"targets\": [ { \"contextKind\": \"user\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\"] }, { \"contextKind\": \"device\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"device-key-456def\"] } ] } ] } ``` #### replaceUserTargets Removes all existing user targeting and replaces it with the list of targets you provide. In the list of targets, you must include a target for each of the flag\'s variations. If you are working with contexts, use `replaceTargets` instead of this instruction. ##### Parameters - `targets`: A list of user targeting. Each item in the list must include a `variationId` and a list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\", \"user-key-456def\"] }, { \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"user-key-789ghi\"] } ] } ] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateDefaultVariation Updates the default on or off variation of the flag. ##### Parameters - `onVariationValue`: (Optional) The value of the variation of the new on variation. - `offVariationValue`: (Optional) The value of the variation of the new off variation Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ] } ``` #### updateFallthroughVariationOrRollout Updates the default or \"fallthrough\" rule for the flag, which the flag serves when a context matches none of the targeting rules. The rule can serve either the variation that `variationId` indicates, or a percentage rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutContextKind\": \"user\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### updateOffVariation Updates the default off variation to `variationId`. The flag serves the default off variation when the flag\'s targeting is **Off**. ##### Parameters - `variationId`: ID of a variation of the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### updatePrerequisite Changes the prerequisite flag that `key` indicates to use the variation that `variationId` indicates. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updatePrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateRuleDescription Updates the description of the feature flag rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag associated with this rule. ##### Parameters - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleTrackEvents\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"trackEvents\": true }] } ``` #### updateRuleVariationOrRollout Updates what `ruleId` serves when its clauses evaluate to true. The rule can serve either the variation that `variationId` indicates, or a percent rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `ruleId`: ID of a rule in the flag. - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag, for all rules. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ] } ``` #### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the feature flag, for the default rule. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ] } ``` #### updateVariation Updates a variation of the flag. ##### Parameters - `variationId`: The ID of the variation to update. - `name`: (Optional) The updated variation name. - `value`: (Optional) The updated variation value. - `description`: (Optional) The updated variation description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"value\": 20 } ] } ```

Click to expand instructions for updating flag settings These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### addCustomProperties Adds a new custom property to the feature flag. Custom properties are used to associate feature flags with LaunchDarkly integrations. For example, if you create an integration with an issue tracking service, you may want to associate a flag with a list of issues related to a feature\'s development. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### addTags Adds tags to the feature flag. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### makeFlagPermanent Marks the feature flag as permanent. LaunchDarkly does not prompt you to remove permanent flags, even if one variation is rolled out to all your customers. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagPermanent\" } ] } ``` #### makeFlagTemporary Marks the feature flag as temporary. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagTemporary\" } ] } ``` #### removeCustomProperties Removes the associated values from a custom property. If all the associated values are removed, this instruction also removes the custom property. ##### Parameters - `key`: The custom property key. - `values`: A list of the associated values to remove from the custom property. ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### removeMaintainer Removes the flag\'s maintainer. To set a new maintainer, use the `updateMaintainerMember` or `updateMaintainerTeam` instructions. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeMaintainer\" } ] } ``` #### removeTags Removes tags from the feature flag. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### replaceCustomProperties Replaces the existing associated values for a custom property with the new values. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the new associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### turnOffClientSideAvailability Turns off client-side SDK availability for the flag. This is equivalent to unchecking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn off availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOffClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### turnOnClientSideAvailability Turns on client-side SDK availability for the flag. This is equivalent to checking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn on availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOnClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### updateDescription Updates the feature flag description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDescription\", \"value\": \"Updated flag description\" } ] } ``` #### updateMaintainerMember Updates the maintainer of the flag to an existing member and removes the existing maintainer. ##### Parameters - `value`: The ID of the member. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerMember\", \"value\": \"61e9b714fd47591727db558a\" } ] } ``` #### updateMaintainerTeam Updates the maintainer of the flag to an existing team and removes the existing maintainer. ##### Parameters - `value`: The key of the team. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerTeam\", \"value\": \"example-team-key\" } ] } ``` #### updateName Updates the feature flag name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateName\", \"value\": \"Updated flag name\" } ] } ```

Click to expand instructions for updating the flag lifecycle These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### archiveFlag Archives the feature flag. This retires it from LaunchDarkly without deleting it. You cannot archive a flag that is a prerequisite of other flags. ```json { \"instructions\": [ { \"kind\": \"archiveFlag\" } ] } ``` #### deleteFlag Deletes the feature flag and its rules. You cannot restore a deleted flag. If this flag is requested again, the flag value defined in code will be returned for all contexts. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deleteFlag\" } ] } ``` #### deprecateFlag Deprecates the feature flag. This hides it from the live flags list without archiving or deleting it. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deprecateFlag\" } ] } ``` #### restoreDeprecatedFlag Restores the feature flag if it was previously deprecated. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreDeprecatedFlag\" } ] } ``` #### restoreFlag Restores the feature flag if it was previously archived. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreFlag\" } ] } ```
### Using JSON patches on a feature flag If you do not include the semantic patch header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. In the JSON patch representation, use a JSON pointer in the `path` element to describe what field to change. Use the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) endpoint to find the field you want to update. There are a few special cases to keep in mind when determining the value of the `path` element: * To add an individual target to a specific variation if the flag variation already has individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ] ``` * To add an individual target to a specific variation if the flag variation does not already have individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` * To add a flag to a release pipeline, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/releasePipelineKey\", \"value\": \"example-release-pipeline-key\" } ] ``` ### Required approvals If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will require creating an [approval request](https://launchdarkly.com/docs/api/approvals) or a [workflow](https://launchdarkly.com/docs/api/workflows). ### Conflicts If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an `ignoreConflicts` query parameter set to `true`. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response. You can update cohorts by updating `rules`. Default cohort information is included in the `fallthrough` property of a flag\'s response. You can update the default cohort by updating `fallthrough`. When you update the rollout for a cohort or the default cohort through the API, provide a rollout instead of a single `variationId`. To learn more, read [Migration flags](https://launchdarkly.com/docs/home/flags/migration). * @summary Update feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {PatchWithComment} patchWithComment * @param {boolean} [ignoreConflicts] If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFeatureFlag(projectKey: string, featureFlagKey: string, patchWithComment: PatchWithComment, ignoreConflicts?: boolean, options?: any): AxiosPromise; /** * Create a feature flag with the given name, key, and variations.
Click to expand instructions for creating a migration flag ### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration. To create a migration flag, omit the `variations` and `defaults` information. Instead, provide a `purpose` of `migration`, and `migrationSettings`. If you create a migration flag with six stages, `contextKind` is required. Otherwise, it should be omitted. Here\'s an example: ```json { \"key\": \"flag-key-123\", \"purpose\": \"migration\", \"migrationSettings\": { \"stageCount\": 6, \"contextKind\": \"account\" } } ``` To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration).
* @summary Create a feature flag * @param {string} projectKey The project key * @param {FeatureFlagBody} featureFlagBody * @param {string} [clone] The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFeatureFlag(projectKey: string, featureFlagBody: FeatureFlagBody, clone?: string, options?: any): AxiosPromise; /** * Returns the migration safety issues that are associated with the POSTed flag patch. The patch must use the semantic patch format for updating feature flags. * @summary Get migration safety issues * @param {string} projectKey The project key * @param {string} flagKey The migration flag key * @param {string} environmentKey The environment key * @param {FlagSempatch} flagSempatch * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMigrationSafetyIssues(projectKey: string, flagKey: string, environmentKey: string, flagSempatch: FlagSempatch, options?: any): AxiosPromise>; }; /** * FeatureFlagsApi - object-oriented interface * @export * @class FeatureFlagsApi * @extends {BaseAPI} */ export declare class FeatureFlagsApi extends BaseAPI { /** * > ### Copying flag settings is an Enterprise feature > > Copying flag settings is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Copy flag settings from a source environment to a target environment. By default, this operation copies the entire flag configuration. You can use the `includedActions` or `excludedActions` to specify that only part of the flag configuration is copied. If you provide the optional `currentVersion` of a flag, this operation tests to ensure that the current flag version in the environment matches the version you\'ve specified. The operation rejects attempts to copy flag settings if the environment\'s current version of the flag does not match the version you\'ve specified. You can use this to enforce optimistic locking on copy attempts. * @summary Copy feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {FlagCopyConfigPost} flagCopyConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ copyFeatureFlag(projectKey: string, featureFlagKey: string, flagCopyConfigPost: FlagCopyConfigPost, options?: AxiosRequestConfig): Promise>; /** * Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses. * @summary Delete feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ deleteFeatureFlag(projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of context targets on a feature flag that are scheduled for removal. * @summary Get expiring context targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ getExpiringContextTargets(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring context targets for feature flag](https://launchdarkly.com/docs/api/feature-flags/get-expiring-context-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of user targets on a feature flag that are scheduled for removal. * @summary Get expiring user targets for feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ getExpiringUserTargets(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment. > #### Recommended use > > This endpoint can return a large amount of information. Specifying one or multiple environments with the `env` parameter can decrease response time and overall payload size. We recommend using this parameter to return only the environments relevant to your query. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. * @summary Get feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Filter configurations by environment * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ getFeatureFlag(projectKey: string, featureFlagKey: string, env?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get the status for a particular feature flag. * @summary Get feature flag status * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ getFeatureFlagStatus(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * Get the status for a particular feature flag across environments. * @summary Get flag status across environments * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} [env] Optional environment filter * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ getFeatureFlagStatusAcrossEnvironments(projectKey: string, featureFlagKey: string, env?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - `new`: You created the flag fewer than seven days ago and it has never been requested. - `active`: LaunchDarkly is receiving requests for this flag, but there are either multiple variations configured, or it is toggled off, or there have been changes to configuration in the past seven days. - `inactive`: You created the feature flag more than seven days ago, and hasn\'t been requested within the past seven days. - `launched`: LaunchDarkly is receiving requests for this flag, it is toggled on, there is only one variation configured, and there have been no changes to configuration in the past seven days. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-status). * @summary List feature flag statuses * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ getFeatureFlagStatuses(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all feature flags in the given project. You can include information specific to different environments by adding `env` query parameter. For example, setting `env=production` adds configuration details about your production environment to the response. You can also filter feature flags by tag with the `tag` query parameter. > #### Recommended use > > This endpoint can return a large amount of information. We recommend using some or all of these query parameters to decrease response time and overall payload size: `limit`, `env`, `query`, and `filter=creationDate`. ### Filtering flags You can filter on certain fields using the `filter` query parameter. For example, setting `filter=query:dark-mode,tags:beta+test` matches flags with the string `dark-mode` in their key or name, ignoring case, which also have the tags `beta` and `test`. The `filter` query parameter supports the following arguments: | Filter argument | Description | Example | |-----------------------|-------------|----------------------| | `applicationEvaluated` | A string. It filters the list to flags that are evaluated in the application with the given key. | `filter=applicationEvaluated:com.launchdarkly.cafe` | | `archived` | (deprecated) A boolean value. It filters the list to archived flags. | Use `filter=state:archived` instead | | `contextKindsEvaluated` | A `+`-separated list of context kind keys. It filters the list to flags which have been evaluated in the past 30 days for all of the context kinds in the list. | `filter=contextKindsEvaluated:user+application` | | `codeReferences.max` | An integer value. Use `0` to return flags that do not have code references. | `filter=codeReferences.max:0` | | `codeReferences.min` | An integer value. Use `1` to return flags that do have code references. | `filter=codeReferences.min:1` | | `creationDate` | An object with an optional `before` field whose value is Unix time in milliseconds. It filters the list to flags created before the date. | `filter=creationDate:{\"before\":1690527600000}` | | `evaluated` | An object that contains a key of `after` and a value in Unix time in milliseconds. It filters the list to all flags that have been evaluated since the time you specify, in the environment provided. This filter requires the `filterEnv` filter. | `filter=evaluated:{\"after\":1690527600000},filterEnv:production` | | `filterEnv` | A valid environment key. You must use this field for filters that are environment-specific. If there are multiple environment-specific filters, you only need to include this field once. | `filter=evaluated:{\"after\": 1590768455282},filterEnv:production` | | `hasExperiment` | A boolean value. It filters the list to flags that are used in an experiment. | `filter=hasExperiment:true` | | `maintainerId` | A valid member ID. It filters the list to flags that are maintained by this member. | `filter=maintainerId:12ab3c45de678910abc12345` | | `maintainerTeamKey` | A string. It filters the list to flags that are maintained by the team with this key. | `filter=maintainerTeamKey:example-team-key` | | `query` | A string. It filters the list to flags that include the specified string in their key or name. It is not case sensitive. | `filter=query:example` | | `releasePipeline` | A release pipeline key. It filters the list to flags that are either currently active in the release pipeline or have completed the release pipeline. | `filter=releasePipeline:default-release-pipeline` | | `state` | A string, either `live`, `deprecated`, or `archived`. It filters the list to flags in this state. | `filter=state:archived` | | `sdkAvailability` | A string, one of `client`, `mobile`, `anyClient`, `server`. Using `client` filters the list to flags whose client-side SDK availability is set to use the client-side ID. Using `mobile` filters to flags set to use the mobile key. Using `anyClient` filters to flags set to use either the client-side ID or the mobile key. Using `server` filters to flags set to use neither, that is, to flags only available in server-side SDKs. | `filter=sdkAvailability:client` | | `tags` | A `+`-separated list of tags. It filters the list to flags that have all of the tags in the list. | `filter=tags:beta+test` | | `type` | A string, either `temporary` or `permanent`. It filters the list to flags with the specified type. | `filter=type:permanent` | The documented values for the `filter` query are prior to URL encoding. For example, the `+` in `filter=tags:beta+test` must be encoded to `%2B`. By default, this endpoint returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Sorting flags You can sort flags based on the following fields: - `creationDate` sorts by the creation date of the flag. - `key` sorts by the key of the flag. - `maintainerId` sorts by the flag maintainer. - `name` sorts by flag name. - `tags` sorts by tags. - `targetingModifiedDate` sorts by the date that the flag\'s targeting rules were last modified in a given environment. It must be used with `env` parameter and it can not be combined with any other sort. If multiple `env` values are provided, it will perform sort using the first one. For example, `sort=-targetingModifiedDate&env=production&env=staging` returns results sorted by `targetingModifiedDate` for the `production` environment. - `type` sorts by flag type All fields are sorted in ascending order by default. To sort in descending order, prefix the field with a dash ( - ). For example, `sort=-name` sorts the response by flag name in descending order. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `codeReferences` includes code references for the feature flag - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response, and default cohort information is included in the `fallthrough` property of a flag\'s response. To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration). * @summary List feature flags * @param {string} projectKey The project key * @param {string} [env] Filter configurations by environment * @param {string} [tag] Filter feature flags by tag * @param {number} [limit] The number of feature flags to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {boolean} [archived] Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned * @param {boolean} [summary] By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {boolean} [compare] Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. * @param {string} [expand] A comma-separated list of fields to expand in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ getFeatureFlags(projectKey: string, env?: string, tag?: string, limit?: number, offset?: number, archived?: boolean, summary?: boolean, filter?: string, sort?: string, compare?: boolean, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Schedule a context for removal from individual targeting on a feature flag. The flag must already individually target the context. You can add, update, or remove a scheduled removal date. You can only schedule a context for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring targets.
Click to expand instructions for updating expiring targets #### addExpiringTarget Adds a date and time that LaunchDarkly will remove the context from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### updateExpiringTarget Updates the date and time that LaunchDarkly will remove the context from the flag\'s individual targeting ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` * `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"value\": 1754006460000, \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ``` #### removeExpiringTarget Removes the scheduled removal of the context from the flag\'s individual targeting. The context will remain part of the flag\'s individual targeting until you explicitly remove it, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `contextKey`: The context key for the context to remove from individual targeting * `contextKind`: The kind of context represented by the `contextKey` Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\" }] } ```
* @summary Update expiring context targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ patchExpiringTargets(projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: AxiosRequestConfig): Promise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring context targets on feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-expiring-targets) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Schedule a target for removal from individual targeting on a feature flag. The flag must already serve a variation to specific targets based on their key. You can add, update, or remove a scheduled removal date. You can only schedule a target for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting * `version`: (Optional) The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until you explicitly remove them, or until you schedule another removal. ##### Parameters * `variationId`: ID of a variation on the flag * `userKey`: The user key for the user to remove from individual targeting
* @summary Update expiring user targets on feature flag * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {PatchFlagsRequest} patchFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ patchExpiringUserTargets(projectKey: string, environmentKey: string, featureFlagKey: string, patchFlagsRequest: PatchFlagsRequest, options?: AxiosRequestConfig): Promise>; /** * Perform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a feature flag To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating feature flags takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required for some instructions only) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following `kind` instructions for updating feature flags.
Click to expand instructions for turning flags on and off These instructions require the `environmentKey` parameter. #### turnFlagOff Sets the flag\'s targeting state to **Off**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOff\" } ] } ``` #### turnFlagOn Sets the flag\'s targeting state to **On**. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOn\" } ] } ```

Click to expand instructions for working with targeting and variations These instructions require the `environmentKey` parameter. Several of the instructions for working with targeting and variations require flag rule IDs, variation IDs, or clause IDs as parameters. Each of these are returned as part of the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) response. The flag rule ID is the `_id` field of each element in the `rules` array within each environment listed in the `environments` object. The variation ID is the `_id` field in each element of the `variations` array. The clause ID is the `_id` field of each element of the `clauses` array within the `rules` array within each environment listed in the `environments` object. #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"USA\", \"Canada\"] }] }] } ``` #### addPrerequisite Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag in the path parameter. ##### Parameters - `key`: Flag key of the prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addPrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addRule Adds a new targeting rule to the flag. The rule may contain `clauses` and serve the variation that `variationId` indicates, or serve a percentage rollout that `rolloutWeights`, `rolloutBucketBy`, and `rolloutContextKind` indicate. If you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `beforeRuleId`: (Optional) ID of a flag rule. - Either - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }] }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [{ \"contextKind\": \"organization\", \"attribute\": \"located_in\", \"op\": \"in\", \"negate\": false, \"values\": [\"Sweden\", \"Norway\"] }], \"rolloutContextKind\": \"organization\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### addTargets Adds context keys to the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Returns an error if this causes the flag to target the same context key in multiple variations. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addUserTargets Adds user keys to the individual user targets for the variation that `variationId` specifies. Returns an error if this causes the flag to target the same user key in multiple variations. If you are working with contexts, use `addTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### addVariation Adds a variation to the flag. ##### Parameters - `value`: The variation value. - `name`: (Optional) The variation name. - `description`: (Optional) A description for the variation. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addVariation\", \"value\": 20, \"name\": \"New variation\" } ] } ``` #### clearTargets Removes all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### clearUserTargets Removes all individual user targets from the variation that `variationId` specifies. If you are working with contexts, use `clearTargets` instead of this instruction. ##### Parameters - `variationId`: ID of a variation on the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"clearUserTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removePrerequisite Removes the prerequisite flag indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removePrerequisite\", \"key\": \"prereq-flag-key-123abc\" } ] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ] } ``` #### removeTargets Removes context keys from the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Does nothing if the flag does not target the context keys. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeTargets\", \"values\": [\"context-key-123abc\", \"context-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeUserTargets Removes user keys from the individual user targets for the variation that `variationId` specifies. Does nothing if the flag does not target the user keys. If you are working with contexts, use `removeTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. - `variationId`: ID of a flag variation. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeUserTargets\", \"values\": [\"user-key-123abc\", \"user-key-456def\"], \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeVariation Removes a variation from the flag. ##### Parameters - `variationId`: ID of a variation of the flag to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### replacePrerequisites Removes all existing prerequisites and replaces them with the list you provide. ##### Parameters - `prerequisites`: A list of prerequisites. Each item in the list must include a flag `key` and `variationId`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"prereq-flag-key-123abc\", \"variationId\": \"10a58772-3121-400f-846b-b8a04e8944ed\" }, { \"key\": \"another-prereq-flag-key-456def\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\" } ] } ] } ``` #### replaceRules Removes all targeting rules for the flag and replaces them with the list you provide. ##### Parameters - `rules`: A list of rules. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"description\": \"My new rule\", \"clauses\": [ { \"contextKind\": \"user\", \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ] } ``` #### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - `targets`: A list of context targeting. Each item in the list includes an optional `contextKind` that defaults to `user`, a required `variationId`, and a required list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceTargets\", \"targets\": [ { \"contextKind\": \"user\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\"] }, { \"contextKind\": \"device\", \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"device-key-456def\"] } ] } ] } ``` #### replaceUserTargets Removes all existing user targeting and replaces it with the list of targets you provide. In the list of targets, you must include a target for each of the flag\'s variations. If you are working with contexts, use `replaceTargets` instead of this instruction. ##### Parameters - `targets`: A list of user targeting. Each item in the list must include a `variationId` and a list of `values`. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"values\": [\"user-key-123abc\", \"user-key-456def\"] }, { \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\", \"values\": [\"user-key-789ghi\"] } ] } ] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateDefaultVariation Updates the default on or off variation of the flag. ##### Parameters - `onVariationValue`: (Optional) The value of the variation of the new on variation. - `offVariationValue`: (Optional) The value of the variation of the new off variation Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ] } ``` #### updateFallthroughVariationOrRollout Updates the default or \"fallthrough\" rule for the flag, which the flag serves when a context matches none of the targeting rules. The rule can serve either the variation that `variationId` indicates, or a percentage rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example that uses a `variationId`: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` Here\'s an example that uses a percentage rollout: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutContextKind\": \"user\", \"rolloutWeights\": { \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation } }] } ``` #### updateOffVariation Updates the default off variation to `variationId`. The flag serves the default off variation when the flag\'s targeting is **Off**. ##### Parameters - `variationId`: ID of a variation of the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] } ``` #### updatePrerequisite Changes the prerequisite flag that `key` indicates to use the variation that `variationId` indicates. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: Flag key of an existing prerequisite flag. - `variationId`: ID of a variation of the prerequisite flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updatePrerequisite\", \"key\": \"example-prereq-flag-key\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateRuleDescription Updates the description of the feature flag rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag associated with this rule. ##### Parameters - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag. - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleTrackEvents\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"trackEvents\": true }] } ``` #### updateRuleVariationOrRollout Updates what `ruleId` serves when its clauses evaluate to true. The rule can serve either the variation that `variationId` indicates, or a percent rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `ruleId`: ID of a rule in the flag. - `variationId`: ID of a variation of the flag. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [{ \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" }] } ``` #### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag, for all rules. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ] } ``` #### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the feature flag, for the default rule. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here\'s an example: ```json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ] } ``` #### updateVariation Updates a variation of the flag. ##### Parameters - `variationId`: The ID of the variation to update. - `name`: (Optional) The updated variation name. - `value`: (Optional) The updated variation value. - `description`: (Optional) The updated variation description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"value\": 20 } ] } ```

Click to expand instructions for updating flag settings These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### addCustomProperties Adds a new custom property to the feature flag. Custom properties are used to associate feature flags with LaunchDarkly integrations. For example, if you create an integration with an issue tracking service, you may want to associate a flag with a list of issues related to a feature\'s development. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### addTags Adds tags to the feature flag. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### makeFlagPermanent Marks the feature flag as permanent. LaunchDarkly does not prompt you to remove permanent flags, even if one variation is rolled out to all your customers. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagPermanent\" } ] } ``` #### makeFlagTemporary Marks the feature flag as temporary. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"makeFlagTemporary\" } ] } ``` #### removeCustomProperties Removes the associated values from a custom property. If all the associated values are removed, this instruction also removes the custom property. ##### Parameters - `key`: The custom property key. - `values`: A list of the associated values to remove from the custom property. ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### removeMaintainer Removes the flag\'s maintainer. To set a new maintainer, use the `updateMaintainerMember` or `updateMaintainerTeam` instructions. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeMaintainer\" } ] } ``` #### removeTags Removes tags from the feature flag. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] } ] } ``` #### replaceCustomProperties Replaces the existing associated values for a custom property with the new values. ##### Parameters - `key`: The custom property key. - `name`: The custom property name. - `values`: A list of the new associated values for the custom property. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceCustomProperties\", \"key\": \"example-custom-property\", \"name\": \"Example custom property\", \"values\": [\"value1\", \"value2\"] }] } ``` #### turnOffClientSideAvailability Turns off client-side SDK availability for the flag. This is equivalent to unchecking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn off availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOffClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### turnOnClientSideAvailability Turns on client-side SDK availability for the flag. This is equivalent to checking the **SDKs using Mobile key** and/or **SDKs using Client-side ID** boxes for the flag. If you\'re using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - `value`: Use \"usingMobileKey\" to turn on availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"turnOnClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } ``` #### updateDescription Updates the feature flag description. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateDescription\", \"value\": \"Updated flag description\" } ] } ``` #### updateMaintainerMember Updates the maintainer of the flag to an existing member and removes the existing maintainer. ##### Parameters - `value`: The ID of the member. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerMember\", \"value\": \"61e9b714fd47591727db558a\" } ] } ``` #### updateMaintainerTeam Updates the maintainer of the flag to an existing team and removes the existing maintainer. ##### Parameters - `value`: The key of the team. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateMaintainerTeam\", \"value\": \"example-team-key\" } ] } ``` #### updateName Updates the feature flag name. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateName\", \"value\": \"Updated flag name\" } ] } ```

Click to expand instructions for updating the flag lifecycle These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments. #### archiveFlag Archives the feature flag. This retires it from LaunchDarkly without deleting it. You cannot archive a flag that is a prerequisite of other flags. ```json { \"instructions\": [ { \"kind\": \"archiveFlag\" } ] } ``` #### deleteFlag Deletes the feature flag and its rules. You cannot restore a deleted flag. If this flag is requested again, the flag value defined in code will be returned for all contexts. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deleteFlag\" } ] } ``` #### deprecateFlag Deprecates the feature flag. This hides it from the live flags list without archiving or deleting it. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"deprecateFlag\" } ] } ``` #### restoreDeprecatedFlag Restores the feature flag if it was previously deprecated. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreDeprecatedFlag\" } ] } ``` #### restoreFlag Restores the feature flag if it was previously archived. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"restoreFlag\" } ] } ```
### Using JSON patches on a feature flag If you do not include the semantic patch header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. In the JSON patch representation, use a JSON pointer in the `path` element to describe what field to change. Use the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) endpoint to find the field you want to update. There are a few special cases to keep in mind when determining the value of the `path` element: * To add an individual target to a specific variation if the flag variation already has individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ] ``` * To add an individual target to a specific variation if the flag variation does not already have individual targets, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` * To add a flag to a release pipeline, the path for the JSON patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/releasePipelineKey\", \"value\": \"example-release-pipeline-key\" } ] ``` ### Required approvals If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will require creating an [approval request](https://launchdarkly.com/docs/api/approvals) or a [workflow](https://launchdarkly.com/docs/api/workflows). ### Conflicts If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an `ignoreConflicts` query parameter set to `true`. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag\'s response. You can update cohorts by updating `rules`. Default cohort information is included in the `fallthrough` property of a flag\'s response. You can update the default cohort by updating `fallthrough`. When you update the rollout for a cohort or the default cohort through the API, provide a rollout instead of a single `variationId`. To learn more, read [Migration flags](https://launchdarkly.com/docs/home/flags/migration). * @summary Update feature flag * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key. The key identifies the flag in your code. * @param {PatchWithComment} patchWithComment * @param {boolean} [ignoreConflicts] If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ patchFeatureFlag(projectKey: string, featureFlagKey: string, patchWithComment: PatchWithComment, ignoreConflicts?: boolean, options?: AxiosRequestConfig): Promise>; /** * Create a feature flag with the given name, key, and variations.
Click to expand instructions for creating a migration flag ### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration. To create a migration flag, omit the `variations` and `defaults` information. Instead, provide a `purpose` of `migration`, and `migrationSettings`. If you create a migration flag with six stages, `contextKind` is required. Otherwise, it should be omitted. Here\'s an example: ```json { \"key\": \"flag-key-123\", \"purpose\": \"migration\", \"migrationSettings\": { \"stageCount\": 6, \"contextKind\": \"account\" } } ``` To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration).
* @summary Create a feature flag * @param {string} projectKey The project key * @param {FeatureFlagBody} featureFlagBody * @param {string} [clone] The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ postFeatureFlag(projectKey: string, featureFlagBody: FeatureFlagBody, clone?: string, options?: AxiosRequestConfig): Promise>; /** * Returns the migration safety issues that are associated with the POSTed flag patch. The patch must use the semantic patch format for updating feature flags. * @summary Get migration safety issues * @param {string} projectKey The project key * @param {string} flagKey The migration flag key * @param {string} environmentKey The environment key * @param {FlagSempatch} flagSempatch * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsApi */ postMigrationSafetyIssues(projectKey: string, flagKey: string, environmentKey: string, flagSempatch: FlagSempatch, options?: AxiosRequestConfig): Promise>; } /** * FeatureFlagsBetaApi - axios parameter creator * @export */ export declare const FeatureFlagsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDependentFlags: (projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDependentFlagsByEnv: (projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; }; /** * FeatureFlagsBetaApi - functional programming interface * @export */ export declare const FeatureFlagsBetaApiFp: (configuration?: Configuration) => { /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDependentFlags(projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDependentFlagsByEnv(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FeatureFlagsBetaApi - factory interface * @export */ export declare const FeatureFlagsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDependentFlags(projectKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDependentFlagsByEnv(projectKey: string, environmentKey: string, featureFlagKey: string, options?: any): AxiosPromise; }; /** * FeatureFlagsBetaApi - object-oriented interface * @export * @class FeatureFlagsBetaApi * @extends {BaseAPI} */ export declare class FeatureFlagsBetaApi extends BaseAPI { /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsBetaApi */ getDependentFlags(projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * > ### Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read [Flag prerequisites](https://launchdarkly.com/docs/home/flags/prereqs). * @summary List dependent feature flags by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeatureFlagsBetaApi */ getDependentFlagsByEnv(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; } /** * FlagImportConfigurationsBetaApi - axios parameter creator * @export */ export declare const FlagImportConfigurationsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. The `config` object in the request body schema is described by the global integration settings, as specified by the formVariables in the manifest.json for this integration. It varies slightly based on the `integrationKey`. * @summary Create a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {FlagImportConfigurationPost} flagImportConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFlagImportConfiguration: (projectKey: string, integrationKey: string, flagImportConfigurationPost: FlagImportConfigurationPost, options?: AxiosRequestConfig) => Promise; /** * Delete a flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Delete a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagImportConfiguration: (projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig) => Promise; /** * Get a single flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Get a single flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key, for example, `split` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagImportConfiguration: (projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig) => Promise; /** * List all flag import configurations. * @summary List all flag import configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagImportConfigurations: (options?: AxiosRequestConfig) => Promise; /** * Updating a flag import configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the import configuration fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array.

You can update the `config`, `tags`, and `name` of the flag import configuration. * @summary Update a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagImportConfiguration: (projectKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Trigger a single flag import run for an existing flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Trigger a single flag import run * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerFlagImportJob: (projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig) => Promise; }; /** * FlagImportConfigurationsBetaApi - functional programming interface * @export */ export declare const FlagImportConfigurationsBetaApiFp: (configuration?: Configuration) => { /** * Create a new flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. The `config` object in the request body schema is described by the global integration settings, as specified by the formVariables in the manifest.json for this integration. It varies slightly based on the `integrationKey`. * @summary Create a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {FlagImportConfigurationPost} flagImportConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFlagImportConfiguration(projectKey: string, integrationKey: string, flagImportConfigurationPost: FlagImportConfigurationPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Delete a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Get a single flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key, for example, `split` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all flag import configurations. * @summary List all flag import configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagImportConfigurations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updating a flag import configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the import configuration fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array.

You can update the `config`, `tags`, and `name` of the flag import configuration. * @summary Update a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Trigger a single flag import run for an existing flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Trigger a single flag import run * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerFlagImportJob(projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FlagImportConfigurationsBetaApi - factory interface * @export */ export declare const FlagImportConfigurationsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. The `config` object in the request body schema is described by the global integration settings, as specified by the formVariables in the manifest.json for this integration. It varies slightly based on the `integrationKey`. * @summary Create a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {FlagImportConfigurationPost} flagImportConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFlagImportConfiguration(projectKey: string, integrationKey: string, flagImportConfigurationPost: FlagImportConfigurationPost, options?: any): AxiosPromise; /** * Delete a flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Delete a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, options?: any): AxiosPromise; /** * Get a single flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Get a single flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key, for example, `split` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, options?: any): AxiosPromise; /** * List all flag import configurations. * @summary List all flag import configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagImportConfigurations(options?: any): AxiosPromise; /** * Updating a flag import configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the import configuration fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array.

You can update the `config`, `tags`, and `name` of the flag import configuration. * @summary Update a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: any): AxiosPromise; /** * Trigger a single flag import run for an existing flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Trigger a single flag import run * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ triggerFlagImportJob(projectKey: string, integrationKey: string, integrationId: string, options?: any): AxiosPromise; }; /** * FlagImportConfigurationsBetaApi - object-oriented interface * @export * @class FlagImportConfigurationsBetaApi * @extends {BaseAPI} */ export declare class FlagImportConfigurationsBetaApi extends BaseAPI { /** * Create a new flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. The `config` object in the request body schema is described by the global integration settings, as specified by the formVariables in the manifest.json for this integration. It varies slightly based on the `integrationKey`. * @summary Create a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {FlagImportConfigurationPost} flagImportConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagImportConfigurationsBetaApi */ createFlagImportConfiguration(projectKey: string, integrationKey: string, flagImportConfigurationPost: FlagImportConfigurationPost, options?: AxiosRequestConfig): Promise>; /** * Delete a flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Delete a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagImportConfigurationsBetaApi */ deleteFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise>; /** * Get a single flag import configuration by ID. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Get a single flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key, for example, `split` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagImportConfigurationsBetaApi */ getFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise>; /** * List all flag import configurations. * @summary List all flag import configurations * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagImportConfigurationsBetaApi */ getFlagImportConfigurations(options?: AxiosRequestConfig): Promise>; /** * Updating a flag import configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the import configuration fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array.

You can update the `config`, `tags`, and `name` of the flag import configuration. * @summary Update a flag import configuration * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagImportConfigurationsBetaApi */ patchFlagImportConfiguration(projectKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Trigger a single flag import run for an existing flag import configuration. The `integrationKey` path parameter identifies the feature management system from which the import occurs, for example, `split`. * @summary Trigger a single flag import run * @param {string} projectKey The project key * @param {string} integrationKey The integration key * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagImportConfigurationsBetaApi */ triggerFlagImportJob(projectKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise>; } /** * FlagLinksBetaApi - axios parameter creator * @export */ export declare const FlagLinksBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new flag link. Flag links let you reference external resources and associate them with your flags. * @summary Create flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {FlagLinkPost} flagLinkPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFlagLink: (projectKey: string, featureFlagKey: string, flagLinkPost: FlagLinkPost, options?: AxiosRequestConfig) => Promise; /** * Delete a flag link by ID or key. * @summary Delete flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID or Key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagLink: (projectKey: string, featureFlagKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all flag links. * @summary List flag links * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagLinks: (projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * Update a flag link. Updating a flag link uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFlagLink: (projectKey: string, featureFlagKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * FlagLinksBetaApi - functional programming interface * @export */ export declare const FlagLinksBetaApiFp: (configuration?: Configuration) => { /** * Create a new flag link. Flag links let you reference external resources and associate them with your flags. * @summary Create flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {FlagLinkPost} flagLinkPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFlagLink(projectKey: string, featureFlagKey: string, flagLinkPost: FlagLinkPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a flag link by ID or key. * @summary Delete flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID or Key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagLink(projectKey: string, featureFlagKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all flag links. * @summary List flag links * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagLinks(projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a flag link. Updating a flag link uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFlagLink(projectKey: string, featureFlagKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FlagLinksBetaApi - factory interface * @export */ export declare const FlagLinksBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new flag link. Flag links let you reference external resources and associate them with your flags. * @summary Create flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {FlagLinkPost} flagLinkPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFlagLink(projectKey: string, featureFlagKey: string, flagLinkPost: FlagLinkPost, options?: any): AxiosPromise; /** * Delete a flag link by ID or key. * @summary Delete flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID or Key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagLink(projectKey: string, featureFlagKey: string, id: string, options?: any): AxiosPromise; /** * Get a list of all flag links. * @summary List flag links * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagLinks(projectKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * Update a flag link. Updating a flag link uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFlagLink(projectKey: string, featureFlagKey: string, id: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * FlagLinksBetaApi - object-oriented interface * @export * @class FlagLinksBetaApi * @extends {BaseAPI} */ export declare class FlagLinksBetaApi extends BaseAPI { /** * Create a new flag link. Flag links let you reference external resources and associate them with your flags. * @summary Create flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {FlagLinkPost} flagLinkPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagLinksBetaApi */ createFlagLink(projectKey: string, featureFlagKey: string, flagLinkPost: FlagLinkPost, options?: AxiosRequestConfig): Promise>; /** * Delete a flag link by ID or key. * @summary Delete flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID or Key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagLinksBetaApi */ deleteFlagLink(projectKey: string, featureFlagKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all flag links. * @summary List flag links * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagLinksBetaApi */ getFlagLinks(projectKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * Update a flag link. Updating a flag link uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag link * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag link ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagLinksBetaApi */ updateFlagLink(projectKey: string, featureFlagKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * FlagTriggersApi - axios parameter creator * @export */ export declare const FlagTriggersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new flag trigger. * @summary Create flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {TriggerPost} triggerPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTriggerWorkflow: (projectKey: string, environmentKey: string, featureFlagKey: string, triggerPost: TriggerPost, options?: AxiosRequestConfig) => Promise; /** * Delete a flag trigger by ID. * @summary Delete flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTriggerWorkflow: (projectKey: string, environmentKey: string, featureFlagKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a flag trigger by ID. * @summary Get flag trigger by ID * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTriggerWorkflowById: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all flag triggers. * @summary List flag triggers * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTriggerWorkflows: (projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * Update a flag trigger. Updating a flag trigger uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating flag triggers.
Click to expand instructions for updating flag triggers #### replaceTriggerActionInstructions Removes the existing trigger action and replaces it with the new instructions. ##### Parameters - `value`: An array of the new `kind`s of actions to perform when triggering. Supported flag actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the existing action with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceTriggerActionInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### cycleTriggerUrl Generates a new URL for this trigger. You must update any clients using the trigger to use this new URL. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"cycleTriggerUrl\" }] } ``` #### disableTrigger Disables the trigger. This saves the trigger configuration, but the trigger stops running. To re-enable, use `enableTrigger`. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"disableTrigger\" }] } ``` #### enableTrigger Enables the trigger. If you previously disabled the trigger, it begins running again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"enableTrigger\" }] } ```
* @summary Update flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {FlagTriggerInput} flagTriggerInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTriggerWorkflow: (projectKey: string, environmentKey: string, featureFlagKey: string, id: string, flagTriggerInput: FlagTriggerInput, options?: AxiosRequestConfig) => Promise; }; /** * FlagTriggersApi - functional programming interface * @export */ export declare const FlagTriggersApiFp: (configuration?: Configuration) => { /** * Create a new flag trigger. * @summary Create flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {TriggerPost} triggerPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, triggerPost: TriggerPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a flag trigger by ID. * @summary Delete flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a flag trigger by ID. * @summary Get flag trigger by ID * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTriggerWorkflowById(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all flag triggers. * @summary List flag triggers * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTriggerWorkflows(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a flag trigger. Updating a flag trigger uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating flag triggers.
Click to expand instructions for updating flag triggers #### replaceTriggerActionInstructions Removes the existing trigger action and replaces it with the new instructions. ##### Parameters - `value`: An array of the new `kind`s of actions to perform when triggering. Supported flag actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the existing action with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceTriggerActionInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### cycleTriggerUrl Generates a new URL for this trigger. You must update any clients using the trigger to use this new URL. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"cycleTriggerUrl\" }] } ``` #### disableTrigger Disables the trigger. This saves the trigger configuration, but the trigger stops running. To re-enable, use `enableTrigger`. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"disableTrigger\" }] } ``` #### enableTrigger Enables the trigger. If you previously disabled the trigger, it begins running again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"enableTrigger\" }] } ```
* @summary Update flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {FlagTriggerInput} flagTriggerInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, id: string, flagTriggerInput: FlagTriggerInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FlagTriggersApi - factory interface * @export */ export declare const FlagTriggersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new flag trigger. * @summary Create flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {TriggerPost} triggerPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, triggerPost: TriggerPost, options?: any): AxiosPromise; /** * Delete a flag trigger by ID. * @summary Delete flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, id: string, options?: any): AxiosPromise; /** * Get a flag trigger by ID. * @summary Get flag trigger by ID * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTriggerWorkflowById(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Get a list of all flag triggers. * @summary List flag triggers * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTriggerWorkflows(projectKey: string, environmentKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * Update a flag trigger. Updating a flag trigger uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating flag triggers.
Click to expand instructions for updating flag triggers #### replaceTriggerActionInstructions Removes the existing trigger action and replaces it with the new instructions. ##### Parameters - `value`: An array of the new `kind`s of actions to perform when triggering. Supported flag actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the existing action with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceTriggerActionInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### cycleTriggerUrl Generates a new URL for this trigger. You must update any clients using the trigger to use this new URL. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"cycleTriggerUrl\" }] } ``` #### disableTrigger Disables the trigger. This saves the trigger configuration, but the trigger stops running. To re-enable, use `enableTrigger`. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"disableTrigger\" }] } ``` #### enableTrigger Enables the trigger. If you previously disabled the trigger, it begins running again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"enableTrigger\" }] } ```
* @summary Update flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {FlagTriggerInput} flagTriggerInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, id: string, flagTriggerInput: FlagTriggerInput, options?: any): AxiosPromise; }; /** * FlagTriggersApi - object-oriented interface * @export * @class FlagTriggersApi * @extends {BaseAPI} */ export declare class FlagTriggersApi extends BaseAPI { /** * Create a new flag trigger. * @summary Create flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {TriggerPost} triggerPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagTriggersApi */ createTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, triggerPost: TriggerPost, options?: AxiosRequestConfig): Promise>; /** * Delete a flag trigger by ID. * @summary Delete flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagTriggersApi */ deleteTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a flag trigger by ID. * @summary Get flag trigger by ID * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The flag trigger ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagTriggersApi */ getTriggerWorkflowById(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all flag triggers. * @summary List flag triggers * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagTriggersApi */ getTriggerWorkflows(projectKey: string, environmentKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * Update a flag trigger. Updating a flag trigger uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating flag triggers.
Click to expand instructions for updating flag triggers #### replaceTriggerActionInstructions Removes the existing trigger action and replaces it with the new instructions. ##### Parameters - `value`: An array of the new `kind`s of actions to perform when triggering. Supported flag actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the existing action with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceTriggerActionInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### cycleTriggerUrl Generates a new URL for this trigger. You must update any clients using the trigger to use this new URL. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"cycleTriggerUrl\" }] } ``` #### disableTrigger Disables the trigger. This saves the trigger configuration, but the trigger stops running. To re-enable, use `enableTrigger`. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"disableTrigger\" }] } ``` #### enableTrigger Enables the trigger. If you previously disabled the trigger, it begins running again. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"enableTrigger\" }] } ```
* @summary Update flag trigger * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} featureFlagKey The feature flag key * @param {string} id The flag trigger ID * @param {FlagTriggerInput} flagTriggerInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlagTriggersApi */ patchTriggerWorkflow(projectKey: string, environmentKey: string, featureFlagKey: string, id: string, flagTriggerInput: FlagTriggerInput, options?: AxiosRequestConfig): Promise>; } /** * FollowFlagsApi - axios parameter creator * @export */ export declare const FollowFlagsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Remove a member as a follower to a flag in a project and environment * @summary Remove a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to remove as a follower of the flag. Reader roles can only remove themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagFollower: (projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of members following a flag in a project and environment * @summary Get followers of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagFollowers: (projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Get followers of all flags in a given environment and project * @summary Get followers of all flags in a given project and environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFollowersByProjEnv: (projectKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Add a member as a follower to a flag in a project and environment * @summary Add a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to add as a follower of the flag. Reader roles can only add themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} */ putFlagFollower: (projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: AxiosRequestConfig) => Promise; }; /** * FollowFlagsApi - functional programming interface * @export */ export declare const FollowFlagsApiFp: (configuration?: Configuration) => { /** * Remove a member as a follower to a flag in a project and environment * @summary Remove a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to remove as a follower of the flag. Reader roles can only remove themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagFollower(projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of members following a flag in a project and environment * @summary Get followers of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagFollowers(projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get followers of all flags in a given environment and project * @summary Get followers of all flags in a given project and environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFollowersByProjEnv(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add a member as a follower to a flag in a project and environment * @summary Add a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to add as a follower of the flag. Reader roles can only add themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} */ putFlagFollower(projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FollowFlagsApi - factory interface * @export */ export declare const FollowFlagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Remove a member as a follower to a flag in a project and environment * @summary Remove a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to remove as a follower of the flag. Reader roles can only remove themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagFollower(projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: any): AxiosPromise; /** * Get a list of members following a flag in a project and environment * @summary Get followers of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagFollowers(projectKey: string, featureFlagKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Get followers of all flags in a given environment and project * @summary Get followers of all flags in a given project and environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFollowersByProjEnv(projectKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Add a member as a follower to a flag in a project and environment * @summary Add a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to add as a follower of the flag. Reader roles can only add themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} */ putFlagFollower(projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: any): AxiosPromise; }; /** * FollowFlagsApi - object-oriented interface * @export * @class FollowFlagsApi * @extends {BaseAPI} */ export declare class FollowFlagsApi extends BaseAPI { /** * Remove a member as a follower to a flag in a project and environment * @summary Remove a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to remove as a follower of the flag. Reader roles can only remove themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FollowFlagsApi */ deleteFlagFollower(projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of members following a flag in a project and environment * @summary Get followers of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FollowFlagsApi */ getFlagFollowers(projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Get followers of all flags in a given environment and project * @summary Get followers of all flags in a given project and environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FollowFlagsApi */ getFollowersByProjEnv(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Add a member as a follower to a flag in a project and environment * @summary Add a member as a follower of a flag in a project and environment * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} memberId The memberId of the member to add as a follower of the flag. Reader roles can only add themselves. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FollowFlagsApi */ putFlagFollower(projectKey: string, featureFlagKey: string, environmentKey: string, memberId: string, options?: AxiosRequestConfig): Promise>; } /** * HoldoutsBetaApi - axios parameter creator * @export */ export declare const HoldoutsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get all holdouts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of holdouts to return in the response. Defaults to 20 * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an `offset` of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllHoldouts: (projectKey: string, environmentKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Get details about a holdout. ### Expanding the holdout response LaunchDarkly supports the following fields for expanding the \"Get holdout\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `draftIteration` includes the iteration which has not been started yet, if any, for this holdout. - `previousIterations` includes all iterations prior to the current iteration, for this holdout. By default only the current iteration is included in the response. - `rel-draftIteration` includes the iteration which has not been started yet, if any, for the experiments related to this holdout. - `rel-metrics` includes metrics for experiments related to this holdout. - `rel-previousIterations` includes all iterations prior to the current iteration, for the experiments related to this holdout. - `rel-secondaryMetrics` includes secondary metrics for experiments related to this holdout. - `rel-treatments` includes all treatment and parameter details for experiments related to this holdout. - `secondaryMetrics` includes secondary metrics for this holdout. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details for this holdout. By default treatment data is not included in the response. For example, `expand=draftIteration,rel-draftIteration` includes the `draftIteration` and `rel-draftIteration` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. Holdout experiment expansion fields have no prefix. Related experiment expansion fields have `rel-` as a prefix. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHoldout: (projectKey: string, environmentKey: string, holdoutKey: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * * @summary Get Holdout by Id * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutId The holdout experiment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHoldoutById: (projectKey: string, environmentKey: string, holdoutId: string, options?: AxiosRequestConfig) => Promise; /** * Updates an existing holdout, and returns the updated holdout. Updating holdouts uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating holdouts.
Click to expand instructions for updating holdouts #### endHoldout Ends a holdout. ##### Parameters None. Here\'s an example: ```json { \"comment\": \"Optional comment describing why the holdout is ending\", \"instructions\": [{ \"kind\": \"endHoldout\" }] } ``` #### removeExperiment Removes an experiment from a holdout. ##### Parameters - `value`: The key of the experiment to remove Here\'s an example: ```json { \"comment\": \"Optional comment describing the change\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"value\": \"experiment-key\" }] } ``` #### updateDescription Updates the description of the holdout. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated holdout description\" }] } ``` #### updateName Updates the name of the holdout. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated holdout name\" }] } ```
* @summary Patch holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout key * @param {HoldoutPatchInput} holdoutPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchHoldout: (projectKey: string, environmentKey: string, holdoutKey: string, holdoutPatchInput: HoldoutPatchInput, options?: AxiosRequestConfig) => Promise; /** * Create a new holdout in the specified project. * @summary Create holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {HoldoutPostRequest} holdoutPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postHoldout: (projectKey: string, environmentKey: string, holdoutPostRequest: HoldoutPostRequest, options?: AxiosRequestConfig) => Promise; }; /** * HoldoutsBetaApi - functional programming interface * @export */ export declare const HoldoutsBetaApiFp: (configuration?: Configuration) => { /** * * @summary Get all holdouts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of holdouts to return in the response. Defaults to 20 * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an `offset` of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllHoldouts(projectKey: string, environmentKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get details about a holdout. ### Expanding the holdout response LaunchDarkly supports the following fields for expanding the \"Get holdout\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `draftIteration` includes the iteration which has not been started yet, if any, for this holdout. - `previousIterations` includes all iterations prior to the current iteration, for this holdout. By default only the current iteration is included in the response. - `rel-draftIteration` includes the iteration which has not been started yet, if any, for the experiments related to this holdout. - `rel-metrics` includes metrics for experiments related to this holdout. - `rel-previousIterations` includes all iterations prior to the current iteration, for the experiments related to this holdout. - `rel-secondaryMetrics` includes secondary metrics for experiments related to this holdout. - `rel-treatments` includes all treatment and parameter details for experiments related to this holdout. - `secondaryMetrics` includes secondary metrics for this holdout. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details for this holdout. By default treatment data is not included in the response. For example, `expand=draftIteration,rel-draftIteration` includes the `draftIteration` and `rel-draftIteration` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. Holdout experiment expansion fields have no prefix. Related experiment expansion fields have `rel-` as a prefix. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHoldout(projectKey: string, environmentKey: string, holdoutKey: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get Holdout by Id * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutId The holdout experiment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHoldoutById(projectKey: string, environmentKey: string, holdoutId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing holdout, and returns the updated holdout. Updating holdouts uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating holdouts.
Click to expand instructions for updating holdouts #### endHoldout Ends a holdout. ##### Parameters None. Here\'s an example: ```json { \"comment\": \"Optional comment describing why the holdout is ending\", \"instructions\": [{ \"kind\": \"endHoldout\" }] } ``` #### removeExperiment Removes an experiment from a holdout. ##### Parameters - `value`: The key of the experiment to remove Here\'s an example: ```json { \"comment\": \"Optional comment describing the change\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"value\": \"experiment-key\" }] } ``` #### updateDescription Updates the description of the holdout. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated holdout description\" }] } ``` #### updateName Updates the name of the holdout. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated holdout name\" }] } ```
* @summary Patch holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout key * @param {HoldoutPatchInput} holdoutPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchHoldout(projectKey: string, environmentKey: string, holdoutKey: string, holdoutPatchInput: HoldoutPatchInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new holdout in the specified project. * @summary Create holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {HoldoutPostRequest} holdoutPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postHoldout(projectKey: string, environmentKey: string, holdoutPostRequest: HoldoutPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * HoldoutsBetaApi - factory interface * @export */ export declare const HoldoutsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get all holdouts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of holdouts to return in the response. Defaults to 20 * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an `offset` of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllHoldouts(projectKey: string, environmentKey: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Get details about a holdout. ### Expanding the holdout response LaunchDarkly supports the following fields for expanding the \"Get holdout\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `draftIteration` includes the iteration which has not been started yet, if any, for this holdout. - `previousIterations` includes all iterations prior to the current iteration, for this holdout. By default only the current iteration is included in the response. - `rel-draftIteration` includes the iteration which has not been started yet, if any, for the experiments related to this holdout. - `rel-metrics` includes metrics for experiments related to this holdout. - `rel-previousIterations` includes all iterations prior to the current iteration, for the experiments related to this holdout. - `rel-secondaryMetrics` includes secondary metrics for experiments related to this holdout. - `rel-treatments` includes all treatment and parameter details for experiments related to this holdout. - `secondaryMetrics` includes secondary metrics for this holdout. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details for this holdout. By default treatment data is not included in the response. For example, `expand=draftIteration,rel-draftIteration` includes the `draftIteration` and `rel-draftIteration` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. Holdout experiment expansion fields have no prefix. Related experiment expansion fields have `rel-` as a prefix. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHoldout(projectKey: string, environmentKey: string, holdoutKey: string, expand?: string, options?: any): AxiosPromise; /** * * @summary Get Holdout by Id * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutId The holdout experiment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHoldoutById(projectKey: string, environmentKey: string, holdoutId: string, options?: any): AxiosPromise; /** * Updates an existing holdout, and returns the updated holdout. Updating holdouts uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating holdouts.
Click to expand instructions for updating holdouts #### endHoldout Ends a holdout. ##### Parameters None. Here\'s an example: ```json { \"comment\": \"Optional comment describing why the holdout is ending\", \"instructions\": [{ \"kind\": \"endHoldout\" }] } ``` #### removeExperiment Removes an experiment from a holdout. ##### Parameters - `value`: The key of the experiment to remove Here\'s an example: ```json { \"comment\": \"Optional comment describing the change\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"value\": \"experiment-key\" }] } ``` #### updateDescription Updates the description of the holdout. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated holdout description\" }] } ``` #### updateName Updates the name of the holdout. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated holdout name\" }] } ```
* @summary Patch holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout key * @param {HoldoutPatchInput} holdoutPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchHoldout(projectKey: string, environmentKey: string, holdoutKey: string, holdoutPatchInput: HoldoutPatchInput, options?: any): AxiosPromise; /** * Create a new holdout in the specified project. * @summary Create holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {HoldoutPostRequest} holdoutPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postHoldout(projectKey: string, environmentKey: string, holdoutPostRequest: HoldoutPostRequest, options?: any): AxiosPromise; }; /** * HoldoutsBetaApi - object-oriented interface * @export * @class HoldoutsBetaApi * @extends {BaseAPI} */ export declare class HoldoutsBetaApi extends BaseAPI { /** * * @summary Get all holdouts * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of holdouts to return in the response. Defaults to 20 * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an `offset` of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HoldoutsBetaApi */ getAllHoldouts(projectKey: string, environmentKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Get details about a holdout. ### Expanding the holdout response LaunchDarkly supports the following fields for expanding the \"Get holdout\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `draftIteration` includes the iteration which has not been started yet, if any, for this holdout. - `previousIterations` includes all iterations prior to the current iteration, for this holdout. By default only the current iteration is included in the response. - `rel-draftIteration` includes the iteration which has not been started yet, if any, for the experiments related to this holdout. - `rel-metrics` includes metrics for experiments related to this holdout. - `rel-previousIterations` includes all iterations prior to the current iteration, for the experiments related to this holdout. - `rel-secondaryMetrics` includes secondary metrics for experiments related to this holdout. - `rel-treatments` includes all treatment and parameter details for experiments related to this holdout. - `secondaryMetrics` includes secondary metrics for this holdout. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details for this holdout. By default treatment data is not included in the response. For example, `expand=draftIteration,rel-draftIteration` includes the `draftIteration` and `rel-draftIteration` fields in the response. If fields that you request with the `expand` query parameter are empty, they are not included in the response. * @summary Get holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout experiment key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. Holdout experiment expansion fields have no prefix. Related experiment expansion fields have `rel-` as a prefix. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HoldoutsBetaApi */ getHoldout(projectKey: string, environmentKey: string, holdoutKey: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * * @summary Get Holdout by Id * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutId The holdout experiment ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HoldoutsBetaApi */ getHoldoutById(projectKey: string, environmentKey: string, holdoutId: string, options?: AxiosRequestConfig): Promise>; /** * Updates an existing holdout, and returns the updated holdout. Updating holdouts uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating holdouts.
Click to expand instructions for updating holdouts #### endHoldout Ends a holdout. ##### Parameters None. Here\'s an example: ```json { \"comment\": \"Optional comment describing why the holdout is ending\", \"instructions\": [{ \"kind\": \"endHoldout\" }] } ``` #### removeExperiment Removes an experiment from a holdout. ##### Parameters - `value`: The key of the experiment to remove Here\'s an example: ```json { \"comment\": \"Optional comment describing the change\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"value\": \"experiment-key\" }] } ``` #### updateDescription Updates the description of the holdout. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated holdout description\" }] } ``` #### updateName Updates the name of the holdout. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"comment\": \"Optional comment describing the update\", \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated holdout name\" }] } ```
* @summary Patch holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} holdoutKey The holdout key * @param {HoldoutPatchInput} holdoutPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HoldoutsBetaApi */ patchHoldout(projectKey: string, environmentKey: string, holdoutKey: string, holdoutPatchInput: HoldoutPatchInput, options?: AxiosRequestConfig): Promise>; /** * Create a new holdout in the specified project. * @summary Create holdout * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {HoldoutPostRequest} holdoutPostRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HoldoutsBetaApi */ postHoldout(projectKey: string, environmentKey: string, holdoutPostRequest: HoldoutPostRequest, options?: AxiosRequestConfig): Promise>; } /** * InsightsChartsBetaApi - axios parameter creator * @export */ export declare const InsightsChartsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get deployment frequency chart data. Engineering insights displays deployment frequency data in the [deployment frequency metric view](https://launchdarkly.com/docs/home/observability/deployments). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to deployment frequency For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get deployment frequency chart data * @param {string} [projectKey] The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `kind` * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeploymentFrequencyChart: (projectKey?: string, environmentKey?: string, applicationKey?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get flag status chart data. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-health#flag-statuses). * @summary Get flag status chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagStatusChart: (projectKey: string, environmentKey: string, applicationKey?: string, options?: AxiosRequestConfig) => Promise; /** * Get lead time chart data. The engineering insights UI displays lead time data in the [lead time metric view](https://launchdarkly.com/docs/home/observability/lead-time). * @summary Get lead time chart data * @param {string} projectKey The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `stage`. Default: `stage`. * @param {string} [expand] Options: `metrics`, `percentiles`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeadTimeChart: (projectKey: string, environmentKey?: string, applicationKey?: string, from?: number, to?: number, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](https://launchdarkly.com/docs/home/observability/releases). * @summary Get release frequency chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [groupBy] Property to group results by. Options: `impact` * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleaseFrequencyChart: (projectKey: string, environmentKey: string, applicationKey?: string, hasExperiments?: boolean, global?: string, groupBy?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get stale flags chart data. Engineering insights displays stale flags data in the [flag health metric view](https://launchdarkly.com/docs/home/observability/flag-health). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to stale flags For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get stale flags chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [groupBy] Property to group results by. Options: `maintainer` * @param {string} [maintainerId] Comma-separated list of individual maintainers to filter results. * @param {string} [maintainerTeamKey] Comma-separated list of team maintainer keys to filter results. * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStaleFlagsChart: (projectKey: string, environmentKey: string, applicationKey?: string, groupBy?: string, maintainerId?: string, maintainerTeamKey?: string, expand?: string, options?: AxiosRequestConfig) => Promise; }; /** * InsightsChartsBetaApi - functional programming interface * @export */ export declare const InsightsChartsBetaApiFp: (configuration?: Configuration) => { /** * Get deployment frequency chart data. Engineering insights displays deployment frequency data in the [deployment frequency metric view](https://launchdarkly.com/docs/home/observability/deployments). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to deployment frequency For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get deployment frequency chart data * @param {string} [projectKey] The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `kind` * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeploymentFrequencyChart(projectKey?: string, environmentKey?: string, applicationKey?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get flag status chart data. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-health#flag-statuses). * @summary Get flag status chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagStatusChart(projectKey: string, environmentKey: string, applicationKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get lead time chart data. The engineering insights UI displays lead time data in the [lead time metric view](https://launchdarkly.com/docs/home/observability/lead-time). * @summary Get lead time chart data * @param {string} projectKey The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `stage`. Default: `stage`. * @param {string} [expand] Options: `metrics`, `percentiles`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeadTimeChart(projectKey: string, environmentKey?: string, applicationKey?: string, from?: number, to?: number, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](https://launchdarkly.com/docs/home/observability/releases). * @summary Get release frequency chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [groupBy] Property to group results by. Options: `impact` * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleaseFrequencyChart(projectKey: string, environmentKey: string, applicationKey?: string, hasExperiments?: boolean, global?: string, groupBy?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get stale flags chart data. Engineering insights displays stale flags data in the [flag health metric view](https://launchdarkly.com/docs/home/observability/flag-health). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to stale flags For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get stale flags chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [groupBy] Property to group results by. Options: `maintainer` * @param {string} [maintainerId] Comma-separated list of individual maintainers to filter results. * @param {string} [maintainerTeamKey] Comma-separated list of team maintainer keys to filter results. * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStaleFlagsChart(projectKey: string, environmentKey: string, applicationKey?: string, groupBy?: string, maintainerId?: string, maintainerTeamKey?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InsightsChartsBetaApi - factory interface * @export */ export declare const InsightsChartsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get deployment frequency chart data. Engineering insights displays deployment frequency data in the [deployment frequency metric view](https://launchdarkly.com/docs/home/observability/deployments). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to deployment frequency For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get deployment frequency chart data * @param {string} [projectKey] The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `kind` * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeploymentFrequencyChart(projectKey?: string, environmentKey?: string, applicationKey?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: any): AxiosPromise; /** * Get flag status chart data. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-health#flag-statuses). * @summary Get flag status chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagStatusChart(projectKey: string, environmentKey: string, applicationKey?: string, options?: any): AxiosPromise; /** * Get lead time chart data. The engineering insights UI displays lead time data in the [lead time metric view](https://launchdarkly.com/docs/home/observability/lead-time). * @summary Get lead time chart data * @param {string} projectKey The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `stage`. Default: `stage`. * @param {string} [expand] Options: `metrics`, `percentiles`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeadTimeChart(projectKey: string, environmentKey?: string, applicationKey?: string, from?: number, to?: number, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: any): AxiosPromise; /** * Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](https://launchdarkly.com/docs/home/observability/releases). * @summary Get release frequency chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [groupBy] Property to group results by. Options: `impact` * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleaseFrequencyChart(projectKey: string, environmentKey: string, applicationKey?: string, hasExperiments?: boolean, global?: string, groupBy?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, expand?: string, options?: any): AxiosPromise; /** * Get stale flags chart data. Engineering insights displays stale flags data in the [flag health metric view](https://launchdarkly.com/docs/home/observability/flag-health). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to stale flags For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get stale flags chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [groupBy] Property to group results by. Options: `maintainer` * @param {string} [maintainerId] Comma-separated list of individual maintainers to filter results. * @param {string} [maintainerTeamKey] Comma-separated list of team maintainer keys to filter results. * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStaleFlagsChart(projectKey: string, environmentKey: string, applicationKey?: string, groupBy?: string, maintainerId?: string, maintainerTeamKey?: string, expand?: string, options?: any): AxiosPromise; }; /** * InsightsChartsBetaApi - object-oriented interface * @export * @class InsightsChartsBetaApi * @extends {BaseAPI} */ export declare class InsightsChartsBetaApi extends BaseAPI { /** * Get deployment frequency chart data. Engineering insights displays deployment frequency data in the [deployment frequency metric view](https://launchdarkly.com/docs/home/observability/deployments). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to deployment frequency For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get deployment frequency chart data * @param {string} [projectKey] The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `kind` * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsChartsBetaApi */ getDeploymentFrequencyChart(projectKey?: string, environmentKey?: string, applicationKey?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get flag status chart data. To learn more, read [Flag statuses](https://launchdarkly.com/docs/home/observability/flag-health#flag-statuses). * @summary Get flag status chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsChartsBetaApi */ getFlagStatusChart(projectKey: string, environmentKey: string, applicationKey?: string, options?: AxiosRequestConfig): Promise>; /** * Get lead time chart data. The engineering insights UI displays lead time data in the [lead time metric view](https://launchdarkly.com/docs/home/observability/lead-time). * @summary Get lead time chart data * @param {string} projectKey The project key * @param {string} [environmentKey] The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [groupBy] Options: `application`, `stage`. Default: `stage`. * @param {string} [expand] Options: `metrics`, `percentiles`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsChartsBetaApi */ getLeadTimeChart(projectKey: string, environmentKey?: string, applicationKey?: string, from?: number, to?: number, bucketType?: string, bucketMs?: number, groupBy?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](https://launchdarkly.com/docs/home/observability/releases). * @summary Get release frequency chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [groupBy] Property to group results by. Options: `impact` * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [bucketType] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. * @param {number} [bucketMs] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsChartsBetaApi */ getReleaseFrequencyChart(projectKey: string, environmentKey: string, applicationKey?: string, hasExperiments?: boolean, global?: string, groupBy?: string, from?: string, to?: string, bucketType?: string, bucketMs?: number, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get stale flags chart data. Engineering insights displays stale flags data in the [flag health metric view](https://launchdarkly.com/docs/home/observability/flag-health). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `metrics` includes details on the metrics related to stale flags For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is **not** included in the response. * @summary Get stale flags chart data * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [groupBy] Property to group results by. Options: `maintainer` * @param {string} [maintainerId] Comma-separated list of individual maintainers to filter results. * @param {string} [maintainerTeamKey] Comma-separated list of team maintainer keys to filter results. * @param {string} [expand] Options: `metrics` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsChartsBetaApi */ getStaleFlagsChart(projectKey: string, environmentKey: string, applicationKey?: string, groupBy?: string, maintainerId?: string, maintainerTeamKey?: string, expand?: string, options?: AxiosRequestConfig): Promise>; } /** * InsightsDeploymentsBetaApi - axios parameter creator * @export */ export declare const InsightsDeploymentsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create deployment event * @summary Create deployment event * @param {PostDeploymentEventInput} postDeploymentEventInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDeploymentEvent: (postDeploymentEventInput: PostDeploymentEventInput, options?: AxiosRequestConfig) => Promise; /** * Get a deployment by ID. The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary Get deployment * @param {string} deploymentID The deployment ID * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeployment: (deploymentID: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary List deployments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {string} [kind] The deployment kind * @param {string} [status] The deployment status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeployments: (projectKey: string, environmentKey: string, applicationKey?: string, limit?: number, expand?: string, from?: number, to?: number, after?: string, before?: string, kind?: string, status?: string, options?: AxiosRequestConfig) => Promise; /** * Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. * @summary Update deployment * @param {string} deploymentID The deployment ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDeployment: (deploymentID: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * InsightsDeploymentsBetaApi - functional programming interface * @export */ export declare const InsightsDeploymentsBetaApiFp: (configuration?: Configuration) => { /** * Create deployment event * @summary Create deployment event * @param {PostDeploymentEventInput} postDeploymentEventInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDeploymentEvent(postDeploymentEventInput: PostDeploymentEventInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a deployment by ID. The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary Get deployment * @param {string} deploymentID The deployment ID * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeployment(deploymentID: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary List deployments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {string} [kind] The deployment kind * @param {string} [status] The deployment status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeployments(projectKey: string, environmentKey: string, applicationKey?: string, limit?: number, expand?: string, from?: number, to?: number, after?: string, before?: string, kind?: string, status?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. * @summary Update deployment * @param {string} deploymentID The deployment ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDeployment(deploymentID: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InsightsDeploymentsBetaApi - factory interface * @export */ export declare const InsightsDeploymentsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create deployment event * @summary Create deployment event * @param {PostDeploymentEventInput} postDeploymentEventInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDeploymentEvent(postDeploymentEventInput: PostDeploymentEventInput, options?: any): AxiosPromise; /** * Get a deployment by ID. The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary Get deployment * @param {string} deploymentID The deployment ID * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeployment(deploymentID: string, expand?: string, options?: any): AxiosPromise; /** * Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary List deployments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {string} [kind] The deployment kind * @param {string} [status] The deployment status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeployments(projectKey: string, environmentKey: string, applicationKey?: string, limit?: number, expand?: string, from?: number, to?: number, after?: string, before?: string, kind?: string, status?: string, options?: any): AxiosPromise; /** * Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. * @summary Update deployment * @param {string} deploymentID The deployment ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDeployment(deploymentID: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * InsightsDeploymentsBetaApi - object-oriented interface * @export * @class InsightsDeploymentsBetaApi * @extends {BaseAPI} */ export declare class InsightsDeploymentsBetaApi extends BaseAPI { /** * Create deployment event * @summary Create deployment event * @param {PostDeploymentEventInput} postDeploymentEventInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsDeploymentsBetaApi */ createDeploymentEvent(postDeploymentEventInput: PostDeploymentEventInput, options?: AxiosRequestConfig): Promise>; /** * Get a deployment by ID. The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary Get deployment * @param {string} deploymentID The deployment ID * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsDeploymentsBetaApi */ getDeployment(deploymentID: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is **not** included in the response. * @summary List deployments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `pullRequests`, `flagReferences` * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {string} [kind] The deployment kind * @param {string} [status] The deployment status * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsDeploymentsBetaApi */ getDeployments(projectKey: string, environmentKey: string, applicationKey?: string, limit?: number, expand?: string, from?: number, to?: number, after?: string, before?: string, kind?: string, status?: string, options?: AxiosRequestConfig): Promise>; /** * Update a deployment by ID. Updating a deployment uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

The deployment ID is returned as part of the [List deployments](https://launchdarkly.com/docs/api/insights-deployments-beta/get-deployments) response. It is the `id` field of each element in the `items` array. * @summary Update deployment * @param {string} deploymentID The deployment ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsDeploymentsBetaApi */ updateDeployment(deploymentID: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * InsightsFlagEventsBetaApi - axios parameter creator * @export */ export declare const InsightsFlagEventsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `experiments` includes details on all of the experiments run on each flag For example, use `?expand=experiments` to include the `experiments` field in the response. By default, this field is **not** included in the response. * @summary List flag events * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [query] Filter events by flag key * @param {string} [impactSize] Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [expand] Expand properties in response. Options: `experiments` * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagEvents: (projectKey: string, environmentKey: string, applicationKey?: string, query?: string, impactSize?: string, hasExperiments?: boolean, global?: string, expand?: string, limit?: number, from?: number, to?: number, after?: string, before?: string, options?: AxiosRequestConfig) => Promise; }; /** * InsightsFlagEventsBetaApi - functional programming interface * @export */ export declare const InsightsFlagEventsBetaApiFp: (configuration?: Configuration) => { /** * Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `experiments` includes details on all of the experiments run on each flag For example, use `?expand=experiments` to include the `experiments` field in the response. By default, this field is **not** included in the response. * @summary List flag events * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [query] Filter events by flag key * @param {string} [impactSize] Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [expand] Expand properties in response. Options: `experiments` * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagEvents(projectKey: string, environmentKey: string, applicationKey?: string, query?: string, impactSize?: string, hasExperiments?: boolean, global?: string, expand?: string, limit?: number, from?: number, to?: number, after?: string, before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InsightsFlagEventsBetaApi - factory interface * @export */ export declare const InsightsFlagEventsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `experiments` includes details on all of the experiments run on each flag For example, use `?expand=experiments` to include the `experiments` field in the response. By default, this field is **not** included in the response. * @summary List flag events * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [query] Filter events by flag key * @param {string} [impactSize] Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [expand] Expand properties in response. Options: `experiments` * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagEvents(projectKey: string, environmentKey: string, applicationKey?: string, query?: string, impactSize?: string, hasExperiments?: boolean, global?: string, expand?: string, limit?: number, from?: number, to?: number, after?: string, before?: string, options?: any): AxiosPromise; }; /** * InsightsFlagEventsBetaApi - object-oriented interface * @export * @class InsightsFlagEventsBetaApi * @extends {BaseAPI} */ export declare class InsightsFlagEventsBetaApi extends BaseAPI { /** * Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `experiments` includes details on all of the experiments run on each flag For example, use `?expand=experiments` to include the `experiments` field in the response. By default, this field is **not** included in the response. * @summary List flag events * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {string} [query] Filter events by flag key * @param {string} [impactSize] Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` * @param {boolean} [hasExperiments] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) * @param {string} [global] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` * @param {string} [expand] Expand properties in response. Options: `experiments` * @param {number} [limit] The number of deployments to return. Default is 20. Maximum allowed is 100. * @param {number} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {number} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsFlagEventsBetaApi */ getFlagEvents(projectKey: string, environmentKey: string, applicationKey?: string, query?: string, impactSize?: string, hasExperiments?: boolean, global?: string, expand?: string, limit?: number, from?: number, to?: number, after?: string, before?: string, options?: AxiosRequestConfig): Promise>; } /** * InsightsPullRequestsBetaApi - axios parameter creator * @export */ export declare const InsightsPullRequestsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response. * @summary List pull requests * @param {string} projectKey The project key * @param {string} [environmentKey] Required if you are using the <code>sort</code> parameter\'s <code>leadTime</code> option to sort pull requests. * @param {string} [applicationKey] Filter the results to pull requests deployed to a comma separated list of applications * @param {string} [status] Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. * @param {string} [query] Filter list of pull requests by title or author * @param {number} [limit] The number of pull requests to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. * @param {string} [sort] Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPullRequests: (projectKey: string, environmentKey?: string, applicationKey?: string, status?: string, query?: string, limit?: number, expand?: string, sort?: string, from?: string, to?: string, after?: string, before?: string, options?: AxiosRequestConfig) => Promise; }; /** * InsightsPullRequestsBetaApi - functional programming interface * @export */ export declare const InsightsPullRequestsBetaApiFp: (configuration?: Configuration) => { /** * Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response. * @summary List pull requests * @param {string} projectKey The project key * @param {string} [environmentKey] Required if you are using the <code>sort</code> parameter\'s <code>leadTime</code> option to sort pull requests. * @param {string} [applicationKey] Filter the results to pull requests deployed to a comma separated list of applications * @param {string} [status] Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. * @param {string} [query] Filter list of pull requests by title or author * @param {number} [limit] The number of pull requests to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. * @param {string} [sort] Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPullRequests(projectKey: string, environmentKey?: string, applicationKey?: string, status?: string, query?: string, limit?: number, expand?: string, sort?: string, from?: string, to?: string, after?: string, before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InsightsPullRequestsBetaApi - factory interface * @export */ export declare const InsightsPullRequestsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response. * @summary List pull requests * @param {string} projectKey The project key * @param {string} [environmentKey] Required if you are using the <code>sort</code> parameter\'s <code>leadTime</code> option to sort pull requests. * @param {string} [applicationKey] Filter the results to pull requests deployed to a comma separated list of applications * @param {string} [status] Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. * @param {string} [query] Filter list of pull requests by title or author * @param {number} [limit] The number of pull requests to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. * @param {string} [sort] Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPullRequests(projectKey: string, environmentKey?: string, applicationKey?: string, status?: string, query?: string, limit?: number, expand?: string, sort?: string, from?: string, to?: string, after?: string, before?: string, options?: any): AxiosPromise; }; /** * InsightsPullRequestsBetaApi - object-oriented interface * @export * @class InsightsPullRequestsBetaApi * @extends {BaseAPI} */ export declare class InsightsPullRequestsBetaApi extends BaseAPI { /** * Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response. * @summary List pull requests * @param {string} projectKey The project key * @param {string} [environmentKey] Required if you are using the <code>sort</code> parameter\'s <code>leadTime</code> option to sort pull requests. * @param {string} [applicationKey] Filter the results to pull requests deployed to a comma separated list of applications * @param {string} [status] Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`. * @param {string} [query] Filter list of pull requests by title or author * @param {number} [limit] The number of pull requests to return. Default is 20. Maximum allowed is 100. * @param {string} [expand] Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`. * @param {string} [sort] Sort results. Requires the `environmentKey` to be set. Options: `leadTime` (asc) and `-leadTime` (desc). When query option is excluded, default sort is by created or merged date. * @param {string} [from] Unix timestamp in milliseconds. Default value is 7 days ago. * @param {string} [to] Unix timestamp in milliseconds. Default value is now. * @param {string} [after] Identifier used for pagination * @param {string} [before] Identifier used for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsPullRequestsBetaApi */ getPullRequests(projectKey: string, environmentKey?: string, applicationKey?: string, status?: string, query?: string, limit?: number, expand?: string, sort?: string, from?: string, to?: string, after?: string, before?: string, options?: AxiosRequestConfig): Promise>; } /** * InsightsRepositoriesBetaApi - axios parameter creator * @export */ export declare const InsightsRepositoriesBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Associate repositories with projects * @summary Associate repositories with projects * @param {InsightsRepositoryProjectMappings} insightsRepositoryProjectMappings * @param {*} [options] Override http request option. * @throws {RequiredError} */ associateRepositoriesAndProjects: (insightsRepositoryProjectMappings: InsightsRepositoryProjectMappings, options?: AxiosRequestConfig) => Promise; /** * Remove repository project association * @summary Remove repository project association * @param {string} repositoryKey The repository key * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRepositoryProject: (repositoryKey: string, projectKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of repositories ### Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `projects` includes details on all of the LaunchDarkly projects associated with each repository For example, use `?expand=projects` to include the `projects` field in the response. By default, this field is **not** included in the response. * @summary List repositories * @param {string} [expand] Expand properties in response. Options: `projects` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightsRepositories: (expand?: string, options?: AxiosRequestConfig) => Promise; }; /** * InsightsRepositoriesBetaApi - functional programming interface * @export */ export declare const InsightsRepositoriesBetaApiFp: (configuration?: Configuration) => { /** * Associate repositories with projects * @summary Associate repositories with projects * @param {InsightsRepositoryProjectMappings} insightsRepositoryProjectMappings * @param {*} [options] Override http request option. * @throws {RequiredError} */ associateRepositoriesAndProjects(insightsRepositoryProjectMappings: InsightsRepositoryProjectMappings, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove repository project association * @summary Remove repository project association * @param {string} repositoryKey The repository key * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRepositoryProject(repositoryKey: string, projectKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of repositories ### Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `projects` includes details on all of the LaunchDarkly projects associated with each repository For example, use `?expand=projects` to include the `projects` field in the response. By default, this field is **not** included in the response. * @summary List repositories * @param {string} [expand] Expand properties in response. Options: `projects` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightsRepositories(expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InsightsRepositoriesBetaApi - factory interface * @export */ export declare const InsightsRepositoriesBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Associate repositories with projects * @summary Associate repositories with projects * @param {InsightsRepositoryProjectMappings} insightsRepositoryProjectMappings * @param {*} [options] Override http request option. * @throws {RequiredError} */ associateRepositoriesAndProjects(insightsRepositoryProjectMappings: InsightsRepositoryProjectMappings, options?: any): AxiosPromise; /** * Remove repository project association * @summary Remove repository project association * @param {string} repositoryKey The repository key * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRepositoryProject(repositoryKey: string, projectKey: string, options?: any): AxiosPromise; /** * Get a list of repositories ### Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `projects` includes details on all of the LaunchDarkly projects associated with each repository For example, use `?expand=projects` to include the `projects` field in the response. By default, this field is **not** included in the response. * @summary List repositories * @param {string} [expand] Expand properties in response. Options: `projects` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightsRepositories(expand?: string, options?: any): AxiosPromise; }; /** * InsightsRepositoriesBetaApi - object-oriented interface * @export * @class InsightsRepositoriesBetaApi * @extends {BaseAPI} */ export declare class InsightsRepositoriesBetaApi extends BaseAPI { /** * Associate repositories with projects * @summary Associate repositories with projects * @param {InsightsRepositoryProjectMappings} insightsRepositoryProjectMappings * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsRepositoriesBetaApi */ associateRepositoriesAndProjects(insightsRepositoryProjectMappings: InsightsRepositoryProjectMappings, options?: AxiosRequestConfig): Promise>; /** * Remove repository project association * @summary Remove repository project association * @param {string} repositoryKey The repository key * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsRepositoriesBetaApi */ deleteRepositoryProject(repositoryKey: string, projectKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of repositories ### Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `projects` includes details on all of the LaunchDarkly projects associated with each repository For example, use `?expand=projects` to include the `projects` field in the response. By default, this field is **not** included in the response. * @summary List repositories * @param {string} [expand] Expand properties in response. Options: `projects` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsRepositoriesBetaApi */ getInsightsRepositories(expand?: string, options?: AxiosRequestConfig): Promise>; } /** * InsightsScoresBetaApi - axios parameter creator * @export */ export declare const InsightsScoresBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create insight group * @summary Create insight group * @param {PostInsightGroupParams} postInsightGroupParams * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInsightGroup: (postInsightGroupParams: PostInsightGroupParams, options?: AxiosRequestConfig) => Promise; /** * Delete insight group * @summary Delete insight group * @param {string} insightGroupKey The insight group key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInsightGroup: (insightGroupKey: string, options?: AxiosRequestConfig) => Promise; /** * Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary Get insight group * @param {string} insightGroupKey The insight group key * @param {string} [expand] Options: `scores`, `environment` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightGroup: (insightGroupKey: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * List groups for which you are collecting insights ### Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for each group * `environment` includes details on each environment associated with each group * `metadata` includes counts of the number of insight groups with particular indicators, such as \"excellent,\" \"good,\" \"fair,\" and so on. For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary List insight groups * @param {number} [limit] The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name * @param {string} [query] Filter list of insights groups by name. * @param {string} [expand] Options: `scores`, `environment`, `metadata` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightGroups: (limit?: number, offset?: number, sort?: string, query?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views. * @summary Get insight scores * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightsScores: (projectKey: string, environmentKey: string, applicationKey?: string, options?: AxiosRequestConfig) => Promise; /** * Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch insight group * @param {string} insightGroupKey The insight group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchInsightGroup: (insightGroupKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * InsightsScoresBetaApi - functional programming interface * @export */ export declare const InsightsScoresBetaApiFp: (configuration?: Configuration) => { /** * Create insight group * @summary Create insight group * @param {PostInsightGroupParams} postInsightGroupParams * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInsightGroup(postInsightGroupParams: PostInsightGroupParams, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete insight group * @summary Delete insight group * @param {string} insightGroupKey The insight group key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInsightGroup(insightGroupKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary Get insight group * @param {string} insightGroupKey The insight group key * @param {string} [expand] Options: `scores`, `environment` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightGroup(insightGroupKey: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List groups for which you are collecting insights ### Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for each group * `environment` includes details on each environment associated with each group * `metadata` includes counts of the number of insight groups with particular indicators, such as \"excellent,\" \"good,\" \"fair,\" and so on. For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary List insight groups * @param {number} [limit] The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name * @param {string} [query] Filter list of insights groups by name. * @param {string} [expand] Options: `scores`, `environment`, `metadata` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightGroups(limit?: number, offset?: number, sort?: string, query?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views. * @summary Get insight scores * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightsScores(projectKey: string, environmentKey: string, applicationKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch insight group * @param {string} insightGroupKey The insight group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchInsightGroup(insightGroupKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InsightsScoresBetaApi - factory interface * @export */ export declare const InsightsScoresBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create insight group * @summary Create insight group * @param {PostInsightGroupParams} postInsightGroupParams * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInsightGroup(postInsightGroupParams: PostInsightGroupParams, options?: any): AxiosPromise; /** * Delete insight group * @summary Delete insight group * @param {string} insightGroupKey The insight group key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInsightGroup(insightGroupKey: string, options?: any): AxiosPromise; /** * Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary Get insight group * @param {string} insightGroupKey The insight group key * @param {string} [expand] Options: `scores`, `environment` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightGroup(insightGroupKey: string, expand?: string, options?: any): AxiosPromise; /** * List groups for which you are collecting insights ### Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for each group * `environment` includes details on each environment associated with each group * `metadata` includes counts of the number of insight groups with particular indicators, such as \"excellent,\" \"good,\" \"fair,\" and so on. For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary List insight groups * @param {number} [limit] The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name * @param {string} [query] Filter list of insights groups by name. * @param {string} [expand] Options: `scores`, `environment`, `metadata` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightGroups(limit?: number, offset?: number, sort?: string, query?: string, expand?: string, options?: any): AxiosPromise; /** * Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views. * @summary Get insight scores * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsightsScores(projectKey: string, environmentKey: string, applicationKey?: string, options?: any): AxiosPromise; /** * Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch insight group * @param {string} insightGroupKey The insight group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchInsightGroup(insightGroupKey: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * InsightsScoresBetaApi - object-oriented interface * @export * @class InsightsScoresBetaApi * @extends {BaseAPI} */ export declare class InsightsScoresBetaApi extends BaseAPI { /** * Create insight group * @summary Create insight group * @param {PostInsightGroupParams} postInsightGroupParams * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsScoresBetaApi */ createInsightGroup(postInsightGroupParams: PostInsightGroupParams, options?: AxiosRequestConfig): Promise>; /** * Delete insight group * @summary Delete insight group * @param {string} insightGroupKey The insight group key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsScoresBetaApi */ deleteInsightGroup(insightGroupKey: string, options?: AxiosRequestConfig): Promise>; /** * Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary Get insight group * @param {string} insightGroupKey The insight group key * @param {string} [expand] Options: `scores`, `environment` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsScoresBetaApi */ getInsightGroup(insightGroupKey: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * List groups for which you are collecting insights ### Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for each group * `environment` includes details on each environment associated with each group * `metadata` includes counts of the number of insight groups with particular indicators, such as \"excellent,\" \"good,\" \"fair,\" and so on. For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response. * @summary List insight groups * @param {number} [limit] The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name * @param {string} [query] Filter list of insights groups by name. * @param {string} [expand] Options: `scores`, `environment`, `metadata` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsScoresBetaApi */ getInsightGroups(limit?: number, offset?: number, sort?: string, query?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views. * @summary Get insight scores * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [applicationKey] Comma separated list of application keys * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsScoresBetaApi */ getInsightsScores(projectKey: string, environmentKey: string, applicationKey?: string, options?: AxiosRequestConfig): Promise>; /** * Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Patch insight group * @param {string} insightGroupKey The insight group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InsightsScoresBetaApi */ patchInsightGroup(insightGroupKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * IntegrationAuditLogSubscriptionsApi - axios parameter creator * @export */ export declare const IntegrationAuditLogSubscriptionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create an audit log subscription.

For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read [Custom role concepts](https://launchdarkly.com/docs/home/account/role-concepts). * @summary Create audit log subscription * @param {string} integrationKey The integration key * @param {SubscriptionPost} subscriptionPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscription: (integrationKey: string, subscriptionPost: SubscriptionPost, options?: AxiosRequestConfig) => Promise; /** * Delete an audit log subscription. * @summary Delete audit log subscription * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscription: (integrationKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get an audit log subscription by ID. * @summary Get audit log subscription by ID * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionByID: (integrationKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get all audit log subscriptions associated with a given integration. * @summary Get audit log subscriptions by integration * @param {string} integrationKey The integration key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptions: (integrationKey: string, options?: AxiosRequestConfig) => Promise; /** * Update an audit log subscription configuration. Updating an audit log subscription uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update audit log subscription * @param {string} integrationKey The integration key * @param {string} id The ID of the audit log subscription * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubscription: (integrationKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * IntegrationAuditLogSubscriptionsApi - functional programming interface * @export */ export declare const IntegrationAuditLogSubscriptionsApiFp: (configuration?: Configuration) => { /** * Create an audit log subscription.

For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read [Custom role concepts](https://launchdarkly.com/docs/home/account/role-concepts). * @summary Create audit log subscription * @param {string} integrationKey The integration key * @param {SubscriptionPost} subscriptionPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscription(integrationKey: string, subscriptionPost: SubscriptionPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an audit log subscription. * @summary Delete audit log subscription * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscription(integrationKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get an audit log subscription by ID. * @summary Get audit log subscription by ID * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionByID(integrationKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all audit log subscriptions associated with a given integration. * @summary Get audit log subscriptions by integration * @param {string} integrationKey The integration key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptions(integrationKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an audit log subscription configuration. Updating an audit log subscription uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update audit log subscription * @param {string} integrationKey The integration key * @param {string} id The ID of the audit log subscription * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubscription(integrationKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IntegrationAuditLogSubscriptionsApi - factory interface * @export */ export declare const IntegrationAuditLogSubscriptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create an audit log subscription.

For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read [Custom role concepts](https://launchdarkly.com/docs/home/account/role-concepts). * @summary Create audit log subscription * @param {string} integrationKey The integration key * @param {SubscriptionPost} subscriptionPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscription(integrationKey: string, subscriptionPost: SubscriptionPost, options?: any): AxiosPromise; /** * Delete an audit log subscription. * @summary Delete audit log subscription * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscription(integrationKey: string, id: string, options?: any): AxiosPromise; /** * Get an audit log subscription by ID. * @summary Get audit log subscription by ID * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionByID(integrationKey: string, id: string, options?: any): AxiosPromise; /** * Get all audit log subscriptions associated with a given integration. * @summary Get audit log subscriptions by integration * @param {string} integrationKey The integration key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptions(integrationKey: string, options?: any): AxiosPromise; /** * Update an audit log subscription configuration. Updating an audit log subscription uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update audit log subscription * @param {string} integrationKey The integration key * @param {string} id The ID of the audit log subscription * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubscription(integrationKey: string, id: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * IntegrationAuditLogSubscriptionsApi - object-oriented interface * @export * @class IntegrationAuditLogSubscriptionsApi * @extends {BaseAPI} */ export declare class IntegrationAuditLogSubscriptionsApi extends BaseAPI { /** * Create an audit log subscription.

For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read [Custom role concepts](https://launchdarkly.com/docs/home/account/role-concepts). * @summary Create audit log subscription * @param {string} integrationKey The integration key * @param {SubscriptionPost} subscriptionPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationAuditLogSubscriptionsApi */ createSubscription(integrationKey: string, subscriptionPost: SubscriptionPost, options?: AxiosRequestConfig): Promise>; /** * Delete an audit log subscription. * @summary Delete audit log subscription * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationAuditLogSubscriptionsApi */ deleteSubscription(integrationKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get an audit log subscription by ID. * @summary Get audit log subscription by ID * @param {string} integrationKey The integration key * @param {string} id The subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationAuditLogSubscriptionsApi */ getSubscriptionByID(integrationKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get all audit log subscriptions associated with a given integration. * @summary Get audit log subscriptions by integration * @param {string} integrationKey The integration key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationAuditLogSubscriptionsApi */ getSubscriptions(integrationKey: string, options?: AxiosRequestConfig): Promise>; /** * Update an audit log subscription configuration. Updating an audit log subscription uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update audit log subscription * @param {string} integrationKey The integration key * @param {string} id The ID of the audit log subscription * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationAuditLogSubscriptionsApi */ updateSubscription(integrationKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * IntegrationDeliveryConfigurationsBetaApi - axios parameter creator * @export */ export declare const IntegrationDeliveryConfigurationsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a delivery configuration. * @summary Create delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIntegrationDeliveryConfiguration: (projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: AxiosRequestConfig) => Promise; /** * Delete a delivery configuration. * @summary Delete delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteIntegrationDeliveryConfiguration: (projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get delivery configurations by environment. * @summary Get delivery configurations by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurationByEnvironment: (projectKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Get delivery configuration by ID. * @summary Get delivery configuration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurationById: (projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * List all delivery configurations. * @summary List all delivery configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurations: (options?: AxiosRequestConfig) => Promise; /** * Update an integration delivery configuration. Updating an integration delivery configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchIntegrationDeliveryConfiguration: (projectKey: string, environmentKey: string, integrationKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Validate the saved delivery configuration, using the `validationRequest` in the integration\'s `manifest.json` file. * @summary Validate delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateIntegrationDeliveryConfiguration: (projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig) => Promise; }; /** * IntegrationDeliveryConfigurationsBetaApi - functional programming interface * @export */ export declare const IntegrationDeliveryConfigurationsBetaApiFp: (configuration?: Configuration) => { /** * Create a delivery configuration. * @summary Create delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a delivery configuration. * @summary Delete delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get delivery configurations by environment. * @summary Get delivery configurations by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurationByEnvironment(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get delivery configuration by ID. * @summary Get delivery configuration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurationById(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all delivery configurations. * @summary List all delivery configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an integration delivery configuration. Updating an integration delivery configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Validate the saved delivery configuration, using the `validationRequest` in the integration\'s `manifest.json` file. * @summary Validate delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IntegrationDeliveryConfigurationsBetaApi - factory interface * @export */ export declare const IntegrationDeliveryConfigurationsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a delivery configuration. * @summary Create delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: any): AxiosPromise; /** * Delete a delivery configuration. * @summary Delete delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: any): AxiosPromise; /** * Get delivery configurations by environment. * @summary Get delivery configurations by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurationByEnvironment(projectKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Get delivery configuration by ID. * @summary Get delivery configuration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurationById(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: any): AxiosPromise; /** * List all delivery configurations. * @summary List all delivery configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationDeliveryConfigurations(options?: any): AxiosPromise; /** * Update an integration delivery configuration. Updating an integration delivery configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, patchOperation: Array, options?: any): AxiosPromise; /** * Validate the saved delivery configuration, using the `validationRequest` in the integration\'s `manifest.json` file. * @summary Validate delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: any): AxiosPromise; }; /** * IntegrationDeliveryConfigurationsBetaApi - object-oriented interface * @export * @class IntegrationDeliveryConfigurationsBetaApi * @extends {BaseAPI} */ export declare class IntegrationDeliveryConfigurationsBetaApi extends BaseAPI { /** * Create a delivery configuration. * @summary Create delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationDeliveryConfigurationsBetaApi */ createIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: AxiosRequestConfig): Promise>; /** * Delete a delivery configuration. * @summary Delete delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationDeliveryConfigurationsBetaApi */ deleteIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get delivery configurations by environment. * @summary Get delivery configurations by environment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationDeliveryConfigurationsBetaApi */ getIntegrationDeliveryConfigurationByEnvironment(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Get delivery configuration by ID. * @summary Get delivery configuration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationDeliveryConfigurationsBetaApi */ getIntegrationDeliveryConfigurationById(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * List all delivery configurations. * @summary List all delivery configurations * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationDeliveryConfigurationsBetaApi */ getIntegrationDeliveryConfigurations(options?: AxiosRequestConfig): Promise>; /** * Update an integration delivery configuration. Updating an integration delivery configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationDeliveryConfigurationsBetaApi */ patchIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Validate the saved delivery configuration, using the `validationRequest` in the integration\'s `manifest.json` file. * @summary Validate delivery configuration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key * @param {string} id The configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationDeliveryConfigurationsBetaApi */ validateIntegrationDeliveryConfiguration(projectKey: string, environmentKey: string, integrationKey: string, id: string, options?: AxiosRequestConfig): Promise>; } /** * IntegrationsBetaApi - axios parameter creator * @export */ export declare const IntegrationsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new integration configuration. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Create integration configuration * @param {string} integrationKey The integration key * @param {IntegrationConfigurationPost} integrationConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIntegrationConfiguration: (integrationKey: string, integrationConfigurationPost: IntegrationConfigurationPost, options?: AxiosRequestConfig) => Promise; /** * Delete an integration configuration by ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Delete integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteIntegrationConfiguration: (integrationConfigurationId: string, options?: AxiosRequestConfig) => Promise; /** * Get all integration configurations with the specified integration key. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).). * @summary Get all configurations for the integration * @param {string} integrationKey Integration key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllIntegrationConfigurations: (integrationKey: string, options?: AxiosRequestConfig) => Promise; /** * Get integration configuration with the specified ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Get an integration configuration * @param {string} integrationConfigurationId Integration configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationConfiguration: (integrationConfigurationId: string, options?: AxiosRequestConfig) => Promise; /** * Update an integration configuration. Updating an integration configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIntegrationConfiguration: (integrationConfigurationId: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * IntegrationsBetaApi - functional programming interface * @export */ export declare const IntegrationsBetaApiFp: (configuration?: Configuration) => { /** * Create a new integration configuration. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Create integration configuration * @param {string} integrationKey The integration key * @param {IntegrationConfigurationPost} integrationConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIntegrationConfiguration(integrationKey: string, integrationConfigurationPost: IntegrationConfigurationPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an integration configuration by ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Delete integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteIntegrationConfiguration(integrationConfigurationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all integration configurations with the specified integration key. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).). * @summary Get all configurations for the integration * @param {string} integrationKey Integration key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllIntegrationConfigurations(integrationKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get integration configuration with the specified ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Get an integration configuration * @param {string} integrationConfigurationId Integration configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationConfiguration(integrationConfigurationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an integration configuration. Updating an integration configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIntegrationConfiguration(integrationConfigurationId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IntegrationsBetaApi - factory interface * @export */ export declare const IntegrationsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new integration configuration. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Create integration configuration * @param {string} integrationKey The integration key * @param {IntegrationConfigurationPost} integrationConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createIntegrationConfiguration(integrationKey: string, integrationConfigurationPost: IntegrationConfigurationPost, options?: any): AxiosPromise; /** * Delete an integration configuration by ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Delete integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteIntegrationConfiguration(integrationConfigurationId: string, options?: any): AxiosPromise; /** * Get all integration configurations with the specified integration key. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).). * @summary Get all configurations for the integration * @param {string} integrationKey Integration key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllIntegrationConfigurations(integrationKey: string, options?: any): AxiosPromise; /** * Get integration configuration with the specified ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Get an integration configuration * @param {string} integrationConfigurationId Integration configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIntegrationConfiguration(integrationConfigurationId: string, options?: any): AxiosPromise; /** * Update an integration configuration. Updating an integration configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateIntegrationConfiguration(integrationConfigurationId: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * IntegrationsBetaApi - object-oriented interface * @export * @class IntegrationsBetaApi * @extends {BaseAPI} */ export declare class IntegrationsBetaApi extends BaseAPI { /** * Create a new integration configuration. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Create integration configuration * @param {string} integrationKey The integration key * @param {IntegrationConfigurationPost} integrationConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationsBetaApi */ createIntegrationConfiguration(integrationKey: string, integrationConfigurationPost: IntegrationConfigurationPost, options?: AxiosRequestConfig): Promise>; /** * Delete an integration configuration by ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Delete integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationsBetaApi */ deleteIntegrationConfiguration(integrationConfigurationId: string, options?: AxiosRequestConfig): Promise>; /** * Get all integration configurations with the specified integration key. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).). * @summary Get all configurations for the integration * @param {string} integrationKey Integration key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationsBetaApi */ getAllIntegrationConfigurations(integrationKey: string, options?: AxiosRequestConfig): Promise>; /** * Get integration configuration with the specified ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).) * @summary Get an integration configuration * @param {string} integrationConfigurationId Integration configuration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationsBetaApi */ getIntegrationConfiguration(integrationConfigurationId: string, options?: AxiosRequestConfig): Promise>; /** * Update an integration configuration. Updating an integration configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update integration configuration * @param {string} integrationConfigurationId The ID of the integration configuration * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationsBetaApi */ updateIntegrationConfiguration(integrationConfigurationId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * LayersApi - axios parameter creator * @export */ export declare const LayersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a layer. Experiments running in the same layer are granted mutually-exclusive traffic. * @summary Create layer * @param {string} projectKey The project key * @param {LayerPost} layerPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLayer: (projectKey: string, layerPost: LayerPost, options?: AxiosRequestConfig) => Promise; /** * Get a collection of all layers for a project * @summary Get layers * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. This endpoint only accepts filtering by `experimentKey`. The filter returns layers which include that experiment for the selected environment(s). For example: `filter=reservations.experimentKey contains expKey`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLayers: (projectKey: string, filter?: string, options?: AxiosRequestConfig) => Promise; /** * Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating layers.
Click to expand instructions for updating layers #### updateName Updates the layer name. ##### Parameters - `name`: The new layer name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"name\": \"New name\" }] } ``` #### updateDescription Updates the layer description. ##### Parameters - `description`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"description\": \"New description\" }] } ``` #### updateExperimentReservation Adds or updates a traffic reservation for an experiment in a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you are adding to or updating in the layer. - `reservationPercent`: The amount of traffic in the layer to reserve. Must be an integer. Zero is allowed until iteration start. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"updateExperimentReservation\", \"experimentKey\": \"exp-key\", \"reservationPercent\": 10 }] } ``` #### removeExperiment Removes a traffic reservation for an experiment from a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you want to remove from the layer. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"experimentKey\": \"exp-key\" }] } ```
* @summary Update layer * @param {string} projectKey The project key * @param {string} layerKey The layer key * @param {LayerPatchInput} layerPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLayer: (projectKey: string, layerKey: string, layerPatchInput: LayerPatchInput, options?: AxiosRequestConfig) => Promise; }; /** * LayersApi - functional programming interface * @export */ export declare const LayersApiFp: (configuration?: Configuration) => { /** * Create a layer. Experiments running in the same layer are granted mutually-exclusive traffic. * @summary Create layer * @param {string} projectKey The project key * @param {LayerPost} layerPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLayer(projectKey: string, layerPost: LayerPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a collection of all layers for a project * @summary Get layers * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. This endpoint only accepts filtering by `experimentKey`. The filter returns layers which include that experiment for the selected environment(s). For example: `filter=reservations.experimentKey contains expKey`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLayers(projectKey: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating layers.
Click to expand instructions for updating layers #### updateName Updates the layer name. ##### Parameters - `name`: The new layer name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"name\": \"New name\" }] } ``` #### updateDescription Updates the layer description. ##### Parameters - `description`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"description\": \"New description\" }] } ``` #### updateExperimentReservation Adds or updates a traffic reservation for an experiment in a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you are adding to or updating in the layer. - `reservationPercent`: The amount of traffic in the layer to reserve. Must be an integer. Zero is allowed until iteration start. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"updateExperimentReservation\", \"experimentKey\": \"exp-key\", \"reservationPercent\": 10 }] } ``` #### removeExperiment Removes a traffic reservation for an experiment from a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you want to remove from the layer. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"experimentKey\": \"exp-key\" }] } ```
* @summary Update layer * @param {string} projectKey The project key * @param {string} layerKey The layer key * @param {LayerPatchInput} layerPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLayer(projectKey: string, layerKey: string, layerPatchInput: LayerPatchInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LayersApi - factory interface * @export */ export declare const LayersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a layer. Experiments running in the same layer are granted mutually-exclusive traffic. * @summary Create layer * @param {string} projectKey The project key * @param {LayerPost} layerPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLayer(projectKey: string, layerPost: LayerPost, options?: any): AxiosPromise; /** * Get a collection of all layers for a project * @summary Get layers * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. This endpoint only accepts filtering by `experimentKey`. The filter returns layers which include that experiment for the selected environment(s). For example: `filter=reservations.experimentKey contains expKey`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLayers(projectKey: string, filter?: string, options?: any): AxiosPromise; /** * Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating layers.
Click to expand instructions for updating layers #### updateName Updates the layer name. ##### Parameters - `name`: The new layer name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"name\": \"New name\" }] } ``` #### updateDescription Updates the layer description. ##### Parameters - `description`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"description\": \"New description\" }] } ``` #### updateExperimentReservation Adds or updates a traffic reservation for an experiment in a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you are adding to or updating in the layer. - `reservationPercent`: The amount of traffic in the layer to reserve. Must be an integer. Zero is allowed until iteration start. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"updateExperimentReservation\", \"experimentKey\": \"exp-key\", \"reservationPercent\": 10 }] } ``` #### removeExperiment Removes a traffic reservation for an experiment from a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you want to remove from the layer. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"experimentKey\": \"exp-key\" }] } ```
* @summary Update layer * @param {string} projectKey The project key * @param {string} layerKey The layer key * @param {LayerPatchInput} layerPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLayer(projectKey: string, layerKey: string, layerPatchInput: LayerPatchInput, options?: any): AxiosPromise; }; /** * LayersApi - object-oriented interface * @export * @class LayersApi * @extends {BaseAPI} */ export declare class LayersApi extends BaseAPI { /** * Create a layer. Experiments running in the same layer are granted mutually-exclusive traffic. * @summary Create layer * @param {string} projectKey The project key * @param {LayerPost} layerPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LayersApi */ createLayer(projectKey: string, layerPost: LayerPost, options?: AxiosRequestConfig): Promise>; /** * Get a collection of all layers for a project * @summary Get layers * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. This endpoint only accepts filtering by `experimentKey`. The filter returns layers which include that experiment for the selected environment(s). For example: `filter=reservations.experimentKey contains expKey`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LayersApi */ getLayers(projectKey: string, filter?: string, options?: AxiosRequestConfig): Promise>; /** * Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating layers.
Click to expand instructions for updating layers #### updateName Updates the layer name. ##### Parameters - `name`: The new layer name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"name\": \"New name\" }] } ``` #### updateDescription Updates the layer description. ##### Parameters - `description`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"description\": \"New description\" }] } ``` #### updateExperimentReservation Adds or updates a traffic reservation for an experiment in a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you are adding to or updating in the layer. - `reservationPercent`: The amount of traffic in the layer to reserve. Must be an integer. Zero is allowed until iteration start. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"updateExperimentReservation\", \"experimentKey\": \"exp-key\", \"reservationPercent\": 10 }] } ``` #### removeExperiment Removes a traffic reservation for an experiment from a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you want to remove from the layer. Here\'s an example: ```json { \"environmentKey\": \"production\", \"instructions\": [{ \"kind\": \"removeExperiment\", \"experimentKey\": \"exp-key\" }] } ```
* @summary Update layer * @param {string} projectKey The project key * @param {string} layerKey The layer key * @param {LayerPatchInput} layerPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LayersApi */ updateLayer(projectKey: string, layerKey: string, layerPatchInput: LayerPatchInput, options?: AxiosRequestConfig): Promise>; } /** * MetricsApi - axios parameter creator * @export */ export declare const MetricsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a metric by key. * @summary Delete metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMetric: (projectKey: string, metricKey: string, options?: AxiosRequestConfig) => Promise; /** * Get information for a single metric from the specific project. ### Expanding the metric response LaunchDarkly supports four fields for expanding the \"Get metric\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `experiments` includes all experiments from the specific project that use the metric - `experimentCount` includes the number of experiments from the specific project that use the metric - `metricGroups` includes all metric groups from the specific project that use the metric - `metricGroupCount` includes the number of metric groups from the specific project that use the metric For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [versionId] The specific version ID of the metric * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetric: (projectKey: string, metricKey: string, expand?: string, versionId?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric\'s unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response. * @summary List metrics * @param {string} projectKey The project key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metrics to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `createdAt` or `name`. * @param {string} [filter] A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, \'eventKind\', \'isNumeric\', \'unitAggregationType`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. To learn more about the filter syntax, read the \'Filtering metrics\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetrics: (projectKey: string, expand?: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig) => Promise; /** * Patch a metric by key. Updating a metric uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMetric: (projectKey: string, metricKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property. * @summary Create metric * @param {string} projectKey The project key * @param {MetricPost} metricPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMetric: (projectKey: string, metricPost: MetricPost, options?: AxiosRequestConfig) => Promise; }; /** * MetricsApi - functional programming interface * @export */ export declare const MetricsApiFp: (configuration?: Configuration) => { /** * Delete a metric by key. * @summary Delete metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMetric(projectKey: string, metricKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get information for a single metric from the specific project. ### Expanding the metric response LaunchDarkly supports four fields for expanding the \"Get metric\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `experiments` includes all experiments from the specific project that use the metric - `experimentCount` includes the number of experiments from the specific project that use the metric - `metricGroups` includes all metric groups from the specific project that use the metric - `metricGroupCount` includes the number of metric groups from the specific project that use the metric For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [versionId] The specific version ID of the metric * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetric(projectKey: string, metricKey: string, expand?: string, versionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric\'s unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response. * @summary List metrics * @param {string} projectKey The project key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metrics to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `createdAt` or `name`. * @param {string} [filter] A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, \'eventKind\', \'isNumeric\', \'unitAggregationType`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. To learn more about the filter syntax, read the \'Filtering metrics\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetrics(projectKey: string, expand?: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Patch a metric by key. Updating a metric uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMetric(projectKey: string, metricKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property. * @summary Create metric * @param {string} projectKey The project key * @param {MetricPost} metricPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMetric(projectKey: string, metricPost: MetricPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MetricsApi - factory interface * @export */ export declare const MetricsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a metric by key. * @summary Delete metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMetric(projectKey: string, metricKey: string, options?: any): AxiosPromise; /** * Get information for a single metric from the specific project. ### Expanding the metric response LaunchDarkly supports four fields for expanding the \"Get metric\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `experiments` includes all experiments from the specific project that use the metric - `experimentCount` includes the number of experiments from the specific project that use the metric - `metricGroups` includes all metric groups from the specific project that use the metric - `metricGroupCount` includes the number of metric groups from the specific project that use the metric For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [versionId] The specific version ID of the metric * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetric(projectKey: string, metricKey: string, expand?: string, versionId?: string, options?: any): AxiosPromise; /** * Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric\'s unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response. * @summary List metrics * @param {string} projectKey The project key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metrics to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `createdAt` or `name`. * @param {string} [filter] A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, \'eventKind\', \'isNumeric\', \'unitAggregationType`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. To learn more about the filter syntax, read the \'Filtering metrics\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetrics(projectKey: string, expand?: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: any): AxiosPromise; /** * Patch a metric by key. Updating a metric uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMetric(projectKey: string, metricKey: string, patchOperation: Array, options?: any): AxiosPromise; /** * Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property. * @summary Create metric * @param {string} projectKey The project key * @param {MetricPost} metricPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMetric(projectKey: string, metricPost: MetricPost, options?: any): AxiosPromise; }; /** * MetricsApi - object-oriented interface * @export * @class MetricsApi * @extends {BaseAPI} */ export declare class MetricsApi extends BaseAPI { /** * Delete a metric by key. * @summary Delete metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsApi */ deleteMetric(projectKey: string, metricKey: string, options?: AxiosRequestConfig): Promise>; /** * Get information for a single metric from the specific project. ### Expanding the metric response LaunchDarkly supports four fields for expanding the \"Get metric\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: - `experiments` includes all experiments from the specific project that use the metric - `experimentCount` includes the number of experiments from the specific project that use the metric - `metricGroups` includes all metric groups from the specific project that use the metric - `metricGroupCount` includes the number of metric groups from the specific project that use the metric For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {string} [versionId] The specific version ID of the metric * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsApi */ getMetric(projectKey: string, metricKey: string, expand?: string, versionId?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric\'s unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response. * @summary List metrics * @param {string} projectKey The project key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metrics to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `createdAt` or `name`. * @param {string} [filter] A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, \'eventKind\', \'isNumeric\', \'unitAggregationType`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. To learn more about the filter syntax, read the \'Filtering metrics\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsApi */ getMetrics(projectKey: string, expand?: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig): Promise>; /** * Patch a metric by key. Updating a metric uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update metric * @param {string} projectKey The project key * @param {string} metricKey The metric key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsApi */ patchMetric(projectKey: string, metricKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property. * @summary Create metric * @param {string} projectKey The project key * @param {MetricPost} metricPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsApi */ postMetric(projectKey: string, metricPost: MetricPost, options?: AxiosRequestConfig): Promise>; } /** * MetricsBetaApi - axios parameter creator * @export */ export declare const MetricsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new metric group in the specified project * @summary Create metric group * @param {string} projectKey The project key * @param {MetricGroupPost} metricGroupPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetricGroup: (projectKey: string, metricGroupPost: MetricGroupPost, options?: AxiosRequestConfig) => Promise; /** * Delete a metric group by key. * @summary Delete metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMetricGroup: (projectKey: string, metricGroupKey: string, options?: AxiosRequestConfig) => Promise; /** * Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the \"Get metric group\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with either or both of the following fields: - `experiments` includes all experiments from the specific project that use the metric group - `experimentCount` includes the number of experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetricGroup: (projectKey: string, metricGroupKey: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \"Get metric groups\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the following field: - `experiments` includes all experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment\'s status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals \'not_started\' and query equals \'metric name\'` * @summary List metric groups * @param {string} projectKey The project key * @param {string} [filter] Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals \'running\' and query equals \'test\'`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetricGroups: (projectKey: string, filter?: string, sort?: string, expand?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Patch a metric group by key. Updating a metric group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. * @summary Patch metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMetricGroup: (projectKey: string, metricGroupKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * MetricsBetaApi - functional programming interface * @export */ export declare const MetricsBetaApiFp: (configuration?: Configuration) => { /** * Create a new metric group in the specified project * @summary Create metric group * @param {string} projectKey The project key * @param {MetricGroupPost} metricGroupPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetricGroup(projectKey: string, metricGroupPost: MetricGroupPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a metric group by key. * @summary Delete metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMetricGroup(projectKey: string, metricGroupKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the \"Get metric group\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with either or both of the following fields: - `experiments` includes all experiments from the specific project that use the metric group - `experimentCount` includes the number of experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetricGroup(projectKey: string, metricGroupKey: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \"Get metric groups\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the following field: - `experiments` includes all experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment\'s status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals \'not_started\' and query equals \'metric name\'` * @summary List metric groups * @param {string} projectKey The project key * @param {string} [filter] Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals \'running\' and query equals \'test\'`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetricGroups(projectKey: string, filter?: string, sort?: string, expand?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Patch a metric group by key. Updating a metric group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. * @summary Patch metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMetricGroup(projectKey: string, metricGroupKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MetricsBetaApi - factory interface * @export */ export declare const MetricsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new metric group in the specified project * @summary Create metric group * @param {string} projectKey The project key * @param {MetricGroupPost} metricGroupPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetricGroup(projectKey: string, metricGroupPost: MetricGroupPost, options?: any): AxiosPromise; /** * Delete a metric group by key. * @summary Delete metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMetricGroup(projectKey: string, metricGroupKey: string, options?: any): AxiosPromise; /** * Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the \"Get metric group\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with either or both of the following fields: - `experiments` includes all experiments from the specific project that use the metric group - `experimentCount` includes the number of experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetricGroup(projectKey: string, metricGroupKey: string, expand?: string, options?: any): AxiosPromise; /** * Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \"Get metric groups\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the following field: - `experiments` includes all experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment\'s status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals \'not_started\' and query equals \'metric name\'` * @summary List metric groups * @param {string} projectKey The project key * @param {string} [filter] Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals \'running\' and query equals \'test\'`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetricGroups(projectKey: string, filter?: string, sort?: string, expand?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Patch a metric group by key. Updating a metric group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. * @summary Patch metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMetricGroup(projectKey: string, metricGroupKey: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * MetricsBetaApi - object-oriented interface * @export * @class MetricsBetaApi * @extends {BaseAPI} */ export declare class MetricsBetaApi extends BaseAPI { /** * Create a new metric group in the specified project * @summary Create metric group * @param {string} projectKey The project key * @param {MetricGroupPost} metricGroupPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsBetaApi */ createMetricGroup(projectKey: string, metricGroupPost: MetricGroupPost, options?: AxiosRequestConfig): Promise>; /** * Delete a metric group by key. * @summary Delete metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsBetaApi */ deleteMetricGroup(projectKey: string, metricGroupKey: string, options?: AxiosRequestConfig): Promise>; /** * Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the \"Get metric group\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with either or both of the following fields: - `experiments` includes all experiments from the specific project that use the metric group - `experimentCount` includes the number of experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. * @summary Get metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsBetaApi */ getMetricGroup(projectKey: string, metricGroupKey: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \"Get metric groups\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the following field: - `experiments` includes all experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment\'s status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals \'not_started\' and query equals \'metric name\'` * @summary List metric groups * @param {string} projectKey The project key * @param {string} [filter] Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals \'running\' and query equals \'test\'`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {number} [limit] The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsBetaApi */ getMetricGroups(projectKey: string, filter?: string, sort?: string, expand?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Patch a metric group by key. Updating a metric group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. * @summary Patch metric group * @param {string} projectKey The project key * @param {string} metricGroupKey The metric group key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsBetaApi */ patchMetricGroup(projectKey: string, metricGroupKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * OAuth2ClientsApi - axios parameter creator * @export */ export declare const OAuth2ClientsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider. * @summary Create a LaunchDarkly OAuth 2.0 client * @param {OauthClientPost} oauthClientPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOAuth2Client: (oauthClientPost: OauthClientPost, options?: AxiosRequestConfig) => Promise; /** * Delete an existing OAuth 2.0 client by unique client ID. * @summary Delete OAuth 2.0 client * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOAuthClient: (clientId: string, options?: AxiosRequestConfig) => Promise; /** * Get a registered OAuth 2.0 client by unique client ID. * @summary Get client by ID * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuthClientById: (clientId: string, options?: AxiosRequestConfig) => Promise; /** * Get all OAuth 2.0 clients registered by your account. * @summary Get clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuthClients: (options?: AxiosRequestConfig) => Promise; /** * Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). Only `name`, `description`, and `redirectUri` may be patched. * @summary Patch client by ID * @param {string} clientId The client ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchOAuthClient: (clientId: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * OAuth2ClientsApi - functional programming interface * @export */ export declare const OAuth2ClientsApiFp: (configuration?: Configuration) => { /** * Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider. * @summary Create a LaunchDarkly OAuth 2.0 client * @param {OauthClientPost} oauthClientPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOAuth2Client(oauthClientPost: OauthClientPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an existing OAuth 2.0 client by unique client ID. * @summary Delete OAuth 2.0 client * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOAuthClient(clientId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a registered OAuth 2.0 client by unique client ID. * @summary Get client by ID * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuthClientById(clientId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all OAuth 2.0 clients registered by your account. * @summary Get clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuthClients(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). Only `name`, `description`, and `redirectUri` may be patched. * @summary Patch client by ID * @param {string} clientId The client ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchOAuthClient(clientId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OAuth2ClientsApi - factory interface * @export */ export declare const OAuth2ClientsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider. * @summary Create a LaunchDarkly OAuth 2.0 client * @param {OauthClientPost} oauthClientPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOAuth2Client(oauthClientPost: OauthClientPost, options?: any): AxiosPromise; /** * Delete an existing OAuth 2.0 client by unique client ID. * @summary Delete OAuth 2.0 client * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOAuthClient(clientId: string, options?: any): AxiosPromise; /** * Get a registered OAuth 2.0 client by unique client ID. * @summary Get client by ID * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuthClientById(clientId: string, options?: any): AxiosPromise; /** * Get all OAuth 2.0 clients registered by your account. * @summary Get clients * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuthClients(options?: any): AxiosPromise; /** * Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). Only `name`, `description`, and `redirectUri` may be patched. * @summary Patch client by ID * @param {string} clientId The client ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchOAuthClient(clientId: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * OAuth2ClientsApi - object-oriented interface * @export * @class OAuth2ClientsApi * @extends {BaseAPI} */ export declare class OAuth2ClientsApi extends BaseAPI { /** * Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider. * @summary Create a LaunchDarkly OAuth 2.0 client * @param {OauthClientPost} oauthClientPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OAuth2ClientsApi */ createOAuth2Client(oauthClientPost: OauthClientPost, options?: AxiosRequestConfig): Promise>; /** * Delete an existing OAuth 2.0 client by unique client ID. * @summary Delete OAuth 2.0 client * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OAuth2ClientsApi */ deleteOAuthClient(clientId: string, options?: AxiosRequestConfig): Promise>; /** * Get a registered OAuth 2.0 client by unique client ID. * @summary Get client by ID * @param {string} clientId The client ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OAuth2ClientsApi */ getOAuthClientById(clientId: string, options?: AxiosRequestConfig): Promise>; /** * Get all OAuth 2.0 clients registered by your account. * @summary Get clients * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OAuth2ClientsApi */ getOAuthClients(options?: AxiosRequestConfig): Promise>; /** * Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). Only `name`, `description`, and `redirectUri` may be patched. * @summary Patch client by ID * @param {string} clientId The client ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OAuth2ClientsApi */ patchOAuthClient(clientId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * OtherApi - axios parameter creator * @export */ export declare const OtherApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get basic information about the identity used (session cookie, API token, SDK keys, etc.) to call the API * @summary Identify the caller * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCallerIdentity: (options?: AxiosRequestConfig) => Promise; /** * Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall. We post upcoming changes to this list in advance on our [status page](https://status.launchdarkly.com/).

In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the public IP list * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIps: (options?: AxiosRequestConfig) => Promise; /** * Get the latest version of the OpenAPI specification for LaunchDarkly\'s API in JSON format. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the OpenAPI spec in json * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenapiSpec: (options?: AxiosRequestConfig) => Promise; /** * Get all of the resource categories the API supports. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Root resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoot: (options?: AxiosRequestConfig) => Promise; /** * Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format. * @summary Get version information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVersions: (options?: AxiosRequestConfig) => Promise; }; /** * OtherApi - functional programming interface * @export */ export declare const OtherApiFp: (configuration?: Configuration) => { /** * Get basic information about the identity used (session cookie, API token, SDK keys, etc.) to call the API * @summary Identify the caller * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCallerIdentity(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall. We post upcoming changes to this list in advance on our [status page](https://status.launchdarkly.com/).

In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the public IP list * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIps(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the latest version of the OpenAPI specification for LaunchDarkly\'s API in JSON format. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the OpenAPI spec in json * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenapiSpec(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all of the resource categories the API supports. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Root resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoot(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format. * @summary Get version information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVersions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OtherApi - factory interface * @export */ export declare const OtherApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get basic information about the identity used (session cookie, API token, SDK keys, etc.) to call the API * @summary Identify the caller * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCallerIdentity(options?: any): AxiosPromise; /** * Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall. We post upcoming changes to this list in advance on our [status page](https://status.launchdarkly.com/).

In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the public IP list * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIps(options?: any): AxiosPromise; /** * Get the latest version of the OpenAPI specification for LaunchDarkly\'s API in JSON format. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the OpenAPI spec in json * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenapiSpec(options?: any): AxiosPromise; /** * Get all of the resource categories the API supports. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Root resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoot(options?: any): AxiosPromise; /** * Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format. * @summary Get version information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVersions(options?: any): AxiosPromise; }; /** * OtherApi - object-oriented interface * @export * @class OtherApi * @extends {BaseAPI} */ export declare class OtherApi extends BaseAPI { /** * Get basic information about the identity used (session cookie, API token, SDK keys, etc.) to call the API * @summary Identify the caller * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OtherApi */ getCallerIdentity(options?: AxiosRequestConfig): Promise>; /** * Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall. We post upcoming changes to this list in advance on our [status page](https://status.launchdarkly.com/).

In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the public IP list * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OtherApi */ getIps(options?: AxiosRequestConfig): Promise>; /** * Get the latest version of the OpenAPI specification for LaunchDarkly\'s API in JSON format. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Gets the OpenAPI spec in json * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OtherApi */ getOpenapiSpec(options?: AxiosRequestConfig): Promise>; /** * Get all of the resource categories the API supports. In the sandbox, click \'Play\' and enter any string in the \'Authorization\' field to test this endpoint. * @summary Root resource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OtherApi */ getRoot(options?: AxiosRequestConfig): Promise>; /** * Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format. * @summary Get version information * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OtherApi */ getVersions(options?: AxiosRequestConfig): Promise>; } /** * PersistentStoreIntegrationsBetaApi - axios parameter creator * @export */ export declare const PersistentStoreIntegrationsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a persistent store integration. If you are using server-side SDKs, segments synced from external tools and larger list-based segments require a persistent store within your infrastructure. LaunchDarkly keeps the persistent store up to date and consults it during flag evaluation. You can use either Redis or DynamoDB as your persistent store. When you create a persistent store integration, the fields in the `config` object in the request vary depending on which persistent store you use. If you are using Redis to create your persistent store integration, you will need to know: * Your Redis host * Your Redis port * Your Redis username * Your Redis password * Whether or not LaunchDarkly should connect using TLS If you are using DynamoDB to create your persistent store integration, you will need to know: * Your DynamoDB table name. The table must have the following schema: * Partition key: `namespace` (string) * Sort key: `key` (string) * Your DynamoDB Amazon Web Services (AWS) region. * Your AWS role Amazon Resource Name (ARN). This is the role that LaunchDarkly will assume to manage your DynamoDB table. * The External ID you specified when creating your Amazon Resource Name (ARN). To learn more, read [Segment configuration](https://launchdarkly.com/docs/home/flags/segment-config). * @summary Create big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentStoreIntegration: (projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: AxiosRequestConfig) => Promise; /** * Delete a persistent store integration. Each integration uses either Redis or DynamoDB. * @summary Delete big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBigSegmentStoreIntegration: (projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig) => Promise; /** * Get a big segment store integration by ID. * @summary Get big segment store integration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentStoreIntegration: (projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig) => Promise; /** * List all big segment store integrations. * @summary List all big segment store integrations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentStoreIntegrations: (options?: AxiosRequestConfig) => Promise; /** * Update a big segment store integration. Updating a big segment store requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchBigSegmentStoreIntegration: (projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; }; /** * PersistentStoreIntegrationsBetaApi - functional programming interface * @export */ export declare const PersistentStoreIntegrationsBetaApiFp: (configuration?: Configuration) => { /** * Create a persistent store integration. If you are using server-side SDKs, segments synced from external tools and larger list-based segments require a persistent store within your infrastructure. LaunchDarkly keeps the persistent store up to date and consults it during flag evaluation. You can use either Redis or DynamoDB as your persistent store. When you create a persistent store integration, the fields in the `config` object in the request vary depending on which persistent store you use. If you are using Redis to create your persistent store integration, you will need to know: * Your Redis host * Your Redis port * Your Redis username * Your Redis password * Whether or not LaunchDarkly should connect using TLS If you are using DynamoDB to create your persistent store integration, you will need to know: * Your DynamoDB table name. The table must have the following schema: * Partition key: `namespace` (string) * Sort key: `key` (string) * Your DynamoDB Amazon Web Services (AWS) region. * Your AWS role Amazon Resource Name (ARN). This is the role that LaunchDarkly will assume to manage your DynamoDB table. * The External ID you specified when creating your Amazon Resource Name (ARN). To learn more, read [Segment configuration](https://launchdarkly.com/docs/home/flags/segment-config). * @summary Create big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a persistent store integration. Each integration uses either Redis or DynamoDB. * @summary Delete big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a big segment store integration by ID. * @summary Get big segment store integration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all big segment store integrations. * @summary List all big segment store integrations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentStoreIntegrations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a big segment store integration. Updating a big segment store requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PersistentStoreIntegrationsBetaApi - factory interface * @export */ export declare const PersistentStoreIntegrationsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a persistent store integration. If you are using server-side SDKs, segments synced from external tools and larger list-based segments require a persistent store within your infrastructure. LaunchDarkly keeps the persistent store up to date and consults it during flag evaluation. You can use either Redis or DynamoDB as your persistent store. When you create a persistent store integration, the fields in the `config` object in the request vary depending on which persistent store you use. If you are using Redis to create your persistent store integration, you will need to know: * Your Redis host * Your Redis port * Your Redis username * Your Redis password * Whether or not LaunchDarkly should connect using TLS If you are using DynamoDB to create your persistent store integration, you will need to know: * Your DynamoDB table name. The table must have the following schema: * Partition key: `namespace` (string) * Sort key: `key` (string) * Your DynamoDB Amazon Web Services (AWS) region. * Your AWS role Amazon Resource Name (ARN). This is the role that LaunchDarkly will assume to manage your DynamoDB table. * The External ID you specified when creating your Amazon Resource Name (ARN). To learn more, read [Segment configuration](https://launchdarkly.com/docs/home/flags/segment-config). * @summary Create big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: any): AxiosPromise; /** * Delete a persistent store integration. Each integration uses either Redis or DynamoDB. * @summary Delete big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: any): AxiosPromise; /** * Get a big segment store integration by ID. * @summary Get big segment store integration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: any): AxiosPromise; /** * List all big segment store integrations. * @summary List all big segment store integrations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentStoreIntegrations(options?: any): AxiosPromise; /** * Update a big segment store integration. Updating a big segment store requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: any): AxiosPromise; }; /** * PersistentStoreIntegrationsBetaApi - object-oriented interface * @export * @class PersistentStoreIntegrationsBetaApi * @extends {BaseAPI} */ export declare class PersistentStoreIntegrationsBetaApi extends BaseAPI { /** * Create a persistent store integration. If you are using server-side SDKs, segments synced from external tools and larger list-based segments require a persistent store within your infrastructure. LaunchDarkly keeps the persistent store up to date and consults it during flag evaluation. You can use either Redis or DynamoDB as your persistent store. When you create a persistent store integration, the fields in the `config` object in the request vary depending on which persistent store you use. If you are using Redis to create your persistent store integration, you will need to know: * Your Redis host * Your Redis port * Your Redis username * Your Redis password * Whether or not LaunchDarkly should connect using TLS If you are using DynamoDB to create your persistent store integration, you will need to know: * Your DynamoDB table name. The table must have the following schema: * Partition key: `namespace` (string) * Sort key: `key` (string) * Your DynamoDB Amazon Web Services (AWS) region. * Your AWS role Amazon Resource Name (ARN). This is the role that LaunchDarkly will assume to manage your DynamoDB table. * The External ID you specified when creating your Amazon Resource Name (ARN). To learn more, read [Segment configuration](https://launchdarkly.com/docs/home/flags/segment-config). * @summary Create big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {IntegrationDeliveryConfigurationPost} integrationDeliveryConfigurationPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PersistentStoreIntegrationsBetaApi */ createBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationDeliveryConfigurationPost: IntegrationDeliveryConfigurationPost, options?: AxiosRequestConfig): Promise>; /** * Delete a persistent store integration. Each integration uses either Redis or DynamoDB. * @summary Delete big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PersistentStoreIntegrationsBetaApi */ deleteBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise>; /** * Get a big segment store integration by ID. * @summary Get big segment store integration by ID * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PersistentStoreIntegrationsBetaApi */ getBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, options?: AxiosRequestConfig): Promise>; /** * List all big segment store integrations. * @summary List all big segment store integrations * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PersistentStoreIntegrationsBetaApi */ getBigSegmentStoreIntegrations(options?: AxiosRequestConfig): Promise>; /** * Update a big segment store integration. Updating a big segment store requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update big segment store integration * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} integrationKey The integration key, either `redis` or `dynamodb` * @param {string} integrationId The integration ID * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PersistentStoreIntegrationsBetaApi */ patchBigSegmentStoreIntegration(projectKey: string, environmentKey: string, integrationKey: string, integrationId: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; } /** * ProjectsApi - axios parameter creator * @export */ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account. * @summary Delete project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject: (projectKey: string, options?: AxiosRequestConfig) => Promise; /** * Get the flag defaults for a specific project. * @summary Get flag defaults for project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagDefaultsByProject: (projectKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a single project by key. ### Expanding the project response LaunchDarkly supports one field for expanding the \"Get project\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for the project in the response. * @summary Get project * @param {string} projectKey The project key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject: (projectKey: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Return a list of projects. By default, this returns the first 20 projects. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering projects LaunchDarkly supports three fields for filters: - `query` is a string that matches against the projects\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of project tags. It filters the list of projects that have all of the tags in the list. - `keys` is a `|` separated list of project keys. It filters the list to projects that have any of the keys in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches projects with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting projects LaunchDarkly supports two fields for sorting: - `name` sorts by project name. - `createdOn` sorts by the creation date of the project. For example, `sort=name` sorts the response by project name in ascending order. ### Expanding the projects response LaunchDarkly supports one field for expanding the \"List projects\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the `environments` field. * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for each project in the response. * @summary List projects * @param {number} [limit] The number of projects to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects: (limit?: number, offset?: number, filter?: string, sort?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Update a flag default. Updating a flag default uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag default for project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagDefaultsByProject: (projectKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Update a project. Updating a project uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the project fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchProject: (projectKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Create a new project with the given key and name. Project keys must be unique within an account. * @summary Create project * @param {ProjectPost} projectPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postProject: (projectPost: ProjectPost, options?: AxiosRequestConfig) => Promise; /** * Create or update flag defaults for a project. * @summary Create or update flag defaults for project * @param {string} projectKey The project key * @param {UpsertFlagDefaultsPayload} upsertFlagDefaultsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ putFlagDefaultsByProject: (projectKey: string, upsertFlagDefaultsPayload: UpsertFlagDefaultsPayload, options?: AxiosRequestConfig) => Promise; }; /** * ProjectsApi - functional programming interface * @export */ export declare const ProjectsApiFp: (configuration?: Configuration) => { /** * Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account. * @summary Delete project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject(projectKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the flag defaults for a specific project. * @summary Get flag defaults for project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagDefaultsByProject(projectKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single project by key. ### Expanding the project response LaunchDarkly supports one field for expanding the \"Get project\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for the project in the response. * @summary Get project * @param {string} projectKey The project key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject(projectKey: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return a list of projects. By default, this returns the first 20 projects. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering projects LaunchDarkly supports three fields for filters: - `query` is a string that matches against the projects\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of project tags. It filters the list of projects that have all of the tags in the list. - `keys` is a `|` separated list of project keys. It filters the list to projects that have any of the keys in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches projects with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting projects LaunchDarkly supports two fields for sorting: - `name` sorts by project name. - `createdOn` sorts by the creation date of the project. For example, `sort=name` sorts the response by project name in ascending order. ### Expanding the projects response LaunchDarkly supports one field for expanding the \"List projects\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the `environments` field. * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for each project in the response. * @summary List projects * @param {number} [limit] The number of projects to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects(limit?: number, offset?: number, filter?: string, sort?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a flag default. Updating a flag default uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag default for project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagDefaultsByProject(projectKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a project. Updating a project uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the project fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchProject(projectKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new project with the given key and name. Project keys must be unique within an account. * @summary Create project * @param {ProjectPost} projectPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postProject(projectPost: ProjectPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create or update flag defaults for a project. * @summary Create or update flag defaults for project * @param {string} projectKey The project key * @param {UpsertFlagDefaultsPayload} upsertFlagDefaultsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ putFlagDefaultsByProject(projectKey: string, upsertFlagDefaultsPayload: UpsertFlagDefaultsPayload, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProjectsApi - factory interface * @export */ export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account. * @summary Delete project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProject(projectKey: string, options?: any): AxiosPromise; /** * Get the flag defaults for a specific project. * @summary Get flag defaults for project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagDefaultsByProject(projectKey: string, options?: any): AxiosPromise; /** * Get a single project by key. ### Expanding the project response LaunchDarkly supports one field for expanding the \"Get project\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for the project in the response. * @summary Get project * @param {string} projectKey The project key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProject(projectKey: string, expand?: string, options?: any): AxiosPromise; /** * Return a list of projects. By default, this returns the first 20 projects. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering projects LaunchDarkly supports three fields for filters: - `query` is a string that matches against the projects\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of project tags. It filters the list of projects that have all of the tags in the list. - `keys` is a `|` separated list of project keys. It filters the list to projects that have any of the keys in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches projects with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting projects LaunchDarkly supports two fields for sorting: - `name` sorts by project name. - `createdOn` sorts by the creation date of the project. For example, `sort=name` sorts the response by project name in ascending order. ### Expanding the projects response LaunchDarkly supports one field for expanding the \"List projects\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the `environments` field. * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for each project in the response. * @summary List projects * @param {number} [limit] The number of projects to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProjects(limit?: number, offset?: number, filter?: string, sort?: string, expand?: string, options?: any): AxiosPromise; /** * Update a flag default. Updating a flag default uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag default for project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagDefaultsByProject(projectKey: string, patchOperation: Array, options?: any): AxiosPromise; /** * Update a project. Updating a project uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the project fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchProject(projectKey: string, patchOperation: Array, options?: any): AxiosPromise; /** * Create a new project with the given key and name. Project keys must be unique within an account. * @summary Create project * @param {ProjectPost} projectPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postProject(projectPost: ProjectPost, options?: any): AxiosPromise; /** * Create or update flag defaults for a project. * @summary Create or update flag defaults for project * @param {string} projectKey The project key * @param {UpsertFlagDefaultsPayload} upsertFlagDefaultsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} */ putFlagDefaultsByProject(projectKey: string, upsertFlagDefaultsPayload: UpsertFlagDefaultsPayload, options?: any): AxiosPromise; }; /** * ProjectsApi - object-oriented interface * @export * @class ProjectsApi * @extends {BaseAPI} */ export declare class ProjectsApi extends BaseAPI { /** * Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account. * @summary Delete project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ deleteProject(projectKey: string, options?: AxiosRequestConfig): Promise>; /** * Get the flag defaults for a specific project. * @summary Get flag defaults for project * @param {string} projectKey The project key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getFlagDefaultsByProject(projectKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a single project by key. ### Expanding the project response LaunchDarkly supports one field for expanding the \"Get project\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for the project in the response. * @summary Get project * @param {string} projectKey The project key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProject(projectKey: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Return a list of projects. By default, this returns the first 20 projects. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering projects LaunchDarkly supports three fields for filters: - `query` is a string that matches against the projects\' names and keys. It is not case sensitive. - `tags` is a `+`-separated list of project tags. It filters the list of projects that have all of the tags in the list. - `keys` is a `|` separated list of project keys. It filters the list to projects that have any of the keys in the list. For example, the filter `filter=query:abc,tags:tag-1+tag-2` matches projects with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. The documented values for `filter` query parameters are prior to URL encoding. For example, the `+` in `filter=tags:tag-1+tag-2` must be encoded to `%2B`. ### Sorting projects LaunchDarkly supports two fields for sorting: - `name` sorts by project name. - `createdOn` sorts by the creation date of the project. For example, `sort=name` sorts the response by project name in ascending order. ### Expanding the projects response LaunchDarkly supports one field for expanding the \"List projects\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the `environments` field. * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for each project in the response. * @summary List projects * @param {number} [limit] The number of projects to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [sort] A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ getProjects(limit?: number, offset?: number, filter?: string, sort?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Update a flag default. Updating a flag default uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update flag default for project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ patchFlagDefaultsByProject(projectKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Update a project. Updating a project uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

To add an element to the project fields that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. * @summary Update project * @param {string} projectKey The project key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ patchProject(projectKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Create a new project with the given key and name. Project keys must be unique within an account. * @summary Create project * @param {ProjectPost} projectPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ postProject(projectPost: ProjectPost, options?: AxiosRequestConfig): Promise>; /** * Create or update flag defaults for a project. * @summary Create or update flag defaults for project * @param {string} projectKey The project key * @param {UpsertFlagDefaultsPayload} upsertFlagDefaultsPayload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ putFlagDefaultsByProject(projectKey: string, upsertFlagDefaultsPayload: UpsertFlagDefaultsPayload, options?: AxiosRequestConfig): Promise>; } /** * RelayProxyConfigurationsApi - axios parameter creator * @export */ export declare const RelayProxyConfigurationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a Relay Proxy config. * @summary Delete Relay Proxy config by ID * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelayAutoConfig: (id: string, options?: AxiosRequestConfig) => Promise; /** * Get a single Relay Proxy auto config by ID. * @summary Get Relay Proxy config * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelayProxyConfig: (id: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of Relay Proxy configurations in the account. * @summary List Relay Proxy configs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelayProxyConfigs: (options?: AxiosRequestConfig) => Promise; /** * Update a Relay Proxy configuration. Updating a configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update a Relay Proxy config * @param {string} id The relay auto config id * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchRelayAutoConfig: (id: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig) => Promise; /** * Create a Relay Proxy config. * @summary Create a new Relay Proxy config * @param {RelayAutoConfigPost} relayAutoConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postRelayAutoConfig: (relayAutoConfigPost: RelayAutoConfigPost, options?: AxiosRequestConfig) => Promise; /** * Reset a Relay Proxy configuration\'s secret key with an optional expiry time for the old key. * @summary Reset Relay Proxy configuration key * @param {string} id The Relay Proxy configuration ID * @param {number} [expiry] An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetRelayAutoConfig: (id: string, expiry?: number, options?: AxiosRequestConfig) => Promise; }; /** * RelayProxyConfigurationsApi - functional programming interface * @export */ export declare const RelayProxyConfigurationsApiFp: (configuration?: Configuration) => { /** * Delete a Relay Proxy config. * @summary Delete Relay Proxy config by ID * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelayAutoConfig(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single Relay Proxy auto config by ID. * @summary Get Relay Proxy config * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelayProxyConfig(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of Relay Proxy configurations in the account. * @summary List Relay Proxy configs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelayProxyConfigs(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a Relay Proxy configuration. Updating a configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update a Relay Proxy config * @param {string} id The relay auto config id * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchRelayAutoConfig(id: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a Relay Proxy config. * @summary Create a new Relay Proxy config * @param {RelayAutoConfigPost} relayAutoConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postRelayAutoConfig(relayAutoConfigPost: RelayAutoConfigPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Reset a Relay Proxy configuration\'s secret key with an optional expiry time for the old key. * @summary Reset Relay Proxy configuration key * @param {string} id The Relay Proxy configuration ID * @param {number} [expiry] An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetRelayAutoConfig(id: string, expiry?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RelayProxyConfigurationsApi - factory interface * @export */ export declare const RelayProxyConfigurationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a Relay Proxy config. * @summary Delete Relay Proxy config by ID * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRelayAutoConfig(id: string, options?: any): AxiosPromise; /** * Get a single Relay Proxy auto config by ID. * @summary Get Relay Proxy config * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelayProxyConfig(id: string, options?: any): AxiosPromise; /** * Get a list of Relay Proxy configurations in the account. * @summary List Relay Proxy configs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelayProxyConfigs(options?: any): AxiosPromise; /** * Update a Relay Proxy configuration. Updating a configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update a Relay Proxy config * @param {string} id The relay auto config id * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchRelayAutoConfig(id: string, patchWithComment: PatchWithComment, options?: any): AxiosPromise; /** * Create a Relay Proxy config. * @summary Create a new Relay Proxy config * @param {RelayAutoConfigPost} relayAutoConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postRelayAutoConfig(relayAutoConfigPost: RelayAutoConfigPost, options?: any): AxiosPromise; /** * Reset a Relay Proxy configuration\'s secret key with an optional expiry time for the old key. * @summary Reset Relay Proxy configuration key * @param {string} id The Relay Proxy configuration ID * @param {number} [expiry] An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetRelayAutoConfig(id: string, expiry?: number, options?: any): AxiosPromise; }; /** * RelayProxyConfigurationsApi - object-oriented interface * @export * @class RelayProxyConfigurationsApi * @extends {BaseAPI} */ export declare class RelayProxyConfigurationsApi extends BaseAPI { /** * Delete a Relay Proxy config. * @summary Delete Relay Proxy config by ID * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RelayProxyConfigurationsApi */ deleteRelayAutoConfig(id: string, options?: AxiosRequestConfig): Promise>; /** * Get a single Relay Proxy auto config by ID. * @summary Get Relay Proxy config * @param {string} id The relay auto config id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RelayProxyConfigurationsApi */ getRelayProxyConfig(id: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of Relay Proxy configurations in the account. * @summary List Relay Proxy configs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RelayProxyConfigurationsApi */ getRelayProxyConfigs(options?: AxiosRequestConfig): Promise>; /** * Update a Relay Proxy configuration. Updating a configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update a Relay Proxy config * @param {string} id The relay auto config id * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RelayProxyConfigurationsApi */ patchRelayAutoConfig(id: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig): Promise>; /** * Create a Relay Proxy config. * @summary Create a new Relay Proxy config * @param {RelayAutoConfigPost} relayAutoConfigPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RelayProxyConfigurationsApi */ postRelayAutoConfig(relayAutoConfigPost: RelayAutoConfigPost, options?: AxiosRequestConfig): Promise>; /** * Reset a Relay Proxy configuration\'s secret key with an optional expiry time for the old key. * @summary Reset Relay Proxy configuration key * @param {string} id The Relay Proxy configuration ID * @param {number} [expiry] An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RelayProxyConfigurationsApi */ resetRelayAutoConfig(id: string, expiry?: number, options?: AxiosRequestConfig): Promise>; } /** * ReleasePipelinesBetaApi - axios parameter creator * @export */ export declare const ReleasePipelinesBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. * @summary Delete release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteReleasePipeline: (projectKey: string, pipelineKey: string, options?: AxiosRequestConfig) => Promise; /** * Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`. - `env` is a string that matches an environment key. For example: `?filter=env:production`. * @summary Get all release pipelines * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllReleasePipelines: (projectKey: string, filter?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Get details on the progression of all releases, across all flags, for a release pipeline * @summary Get release progressions for release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The pipeline key * @param {string} [filter] Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllReleaseProgressionsForReleasePipeline: (projectKey: string, pipelineKey: string, filter?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Get a release pipeline by key * @summary Get release pipeline by key * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleasePipelineByKey: (projectKey: string, pipelineKey: string, options?: AxiosRequestConfig) => Promise; /** * Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project. * @summary Create a release pipeline * @param {string} projectKey The project key * @param {CreateReleasePipelineInput} createReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ postReleasePipeline: (projectKey: string, createReleasePipelineInput: CreateReleasePipelineInput, options?: AxiosRequestConfig) => Promise; /** * Updates a release pipeline. * @summary Update a release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {UpdateReleasePipelineInput} updateReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ putReleasePipeline: (projectKey: string, pipelineKey: string, updateReleasePipelineInput: UpdateReleasePipelineInput, options?: AxiosRequestConfig) => Promise; }; /** * ReleasePipelinesBetaApi - functional programming interface * @export */ export declare const ReleasePipelinesBetaApiFp: (configuration?: Configuration) => { /** * Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. * @summary Delete release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteReleasePipeline(projectKey: string, pipelineKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`. - `env` is a string that matches an environment key. For example: `?filter=env:production`. * @summary Get all release pipelines * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllReleasePipelines(projectKey: string, filter?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get details on the progression of all releases, across all flags, for a release pipeline * @summary Get release progressions for release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The pipeline key * @param {string} [filter] Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllReleaseProgressionsForReleasePipeline(projectKey: string, pipelineKey: string, filter?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a release pipeline by key * @summary Get release pipeline by key * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleasePipelineByKey(projectKey: string, pipelineKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project. * @summary Create a release pipeline * @param {string} projectKey The project key * @param {CreateReleasePipelineInput} createReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ postReleasePipeline(projectKey: string, createReleasePipelineInput: CreateReleasePipelineInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a release pipeline. * @summary Update a release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {UpdateReleasePipelineInput} updateReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ putReleasePipeline(projectKey: string, pipelineKey: string, updateReleasePipelineInput: UpdateReleasePipelineInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReleasePipelinesBetaApi - factory interface * @export */ export declare const ReleasePipelinesBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. * @summary Delete release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteReleasePipeline(projectKey: string, pipelineKey: string, options?: any): AxiosPromise; /** * Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`. - `env` is a string that matches an environment key. For example: `?filter=env:production`. * @summary Get all release pipelines * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllReleasePipelines(projectKey: string, filter?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Get details on the progression of all releases, across all flags, for a release pipeline * @summary Get release progressions for release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The pipeline key * @param {string} [filter] Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllReleaseProgressionsForReleasePipeline(projectKey: string, pipelineKey: string, filter?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Get a release pipeline by key * @summary Get release pipeline by key * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleasePipelineByKey(projectKey: string, pipelineKey: string, options?: any): AxiosPromise; /** * Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project. * @summary Create a release pipeline * @param {string} projectKey The project key * @param {CreateReleasePipelineInput} createReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ postReleasePipeline(projectKey: string, createReleasePipelineInput: CreateReleasePipelineInput, options?: any): AxiosPromise; /** * Updates a release pipeline. * @summary Update a release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {UpdateReleasePipelineInput} updateReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ putReleasePipeline(projectKey: string, pipelineKey: string, updateReleasePipelineInput: UpdateReleasePipelineInput, options?: any): AxiosPromise; }; /** * ReleasePipelinesBetaApi - object-oriented interface * @export * @class ReleasePipelinesBetaApi * @extends {BaseAPI} */ export declare class ReleasePipelinesBetaApi extends BaseAPI { /** * Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. * @summary Delete release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasePipelinesBetaApi */ deleteReleasePipeline(projectKey: string, pipelineKey: string, options?: AxiosRequestConfig): Promise>; /** * Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`. - `env` is a string that matches an environment key. For example: `?filter=env:production`. * @summary Get all release pipelines * @param {string} projectKey The project key * @param {string} [filter] A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasePipelinesBetaApi */ getAllReleasePipelines(projectKey: string, filter?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Get details on the progression of all releases, across all flags, for a release pipeline * @summary Get release progressions for release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The pipeline key * @param {string} [filter] Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. * @param {number} [limit] The maximum number of items to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasePipelinesBetaApi */ getAllReleaseProgressionsForReleasePipeline(projectKey: string, pipelineKey: string, filter?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Get a release pipeline by key * @summary Get release pipeline by key * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasePipelinesBetaApi */ getReleasePipelineByKey(projectKey: string, pipelineKey: string, options?: AxiosRequestConfig): Promise>; /** * Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/ld-docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project. * @summary Create a release pipeline * @param {string} projectKey The project key * @param {CreateReleasePipelineInput} createReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasePipelinesBetaApi */ postReleasePipeline(projectKey: string, createReleasePipelineInput: CreateReleasePipelineInput, options?: AxiosRequestConfig): Promise>; /** * Updates a release pipeline. * @summary Update a release pipeline * @param {string} projectKey The project key * @param {string} pipelineKey The release pipeline key * @param {UpdateReleasePipelineInput} updateReleasePipelineInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasePipelinesBetaApi */ putReleasePipeline(projectKey: string, pipelineKey: string, updateReleasePipelineInput: UpdateReleasePipelineInput, options?: AxiosRequestConfig): Promise>; } /** * ReleasesBetaApi - axios parameter creator * @export */ export declare const ReleasesBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a release by adding a flag to a release pipeline * @summary Create a new release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {CreateReleaseInput} createReleaseInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReleaseForFlag: (projectKey: string, flagKey: string, createReleaseInput: CreateReleaseInput, options?: AxiosRequestConfig) => Promise; /** * Deletes a release from a flag * @summary Delete a release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteReleaseByFlagKey: (projectKey: string, flagKey: string, options?: AxiosRequestConfig) => Promise; /** * Get currently active release for a flag * @summary Get release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleaseByFlagKey: (projectKey: string, flagKey: string, options?: AxiosRequestConfig) => Promise; /** * This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the [Update phase status for release](https://launchdarkly.com/docs/api/releases-beta/update-phase-status) endpoint. To learn more about migrating from legacy release pipelines to fully automated release pipelines, read the [Release pipeline migration guide](https://launchdarkly.com/docs/guides/flags/release-pipeline-migration). Update currently active release for a flag. Updating releases requires the [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) format. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the `path`. For example, to mark the first phase of a release as complete, use the following request body: ``` [ { \"op\": \"replace\", \"path\": \"/phase/0/complete\", \"value\": true } ] ``` * @summary Patch release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchReleaseByFlagKey: (projectKey: string, flagKey: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Updates the execution status of a phase of a release * @summary Update phase status for release * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {string} phaseId The phase ID * @param {UpdatePhaseStatusInput} updatePhaseStatusInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhaseStatus: (projectKey: string, flagKey: string, phaseId: string, updatePhaseStatusInput: UpdatePhaseStatusInput, options?: AxiosRequestConfig) => Promise; }; /** * ReleasesBetaApi - functional programming interface * @export */ export declare const ReleasesBetaApiFp: (configuration?: Configuration) => { /** * Creates a release by adding a flag to a release pipeline * @summary Create a new release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {CreateReleaseInput} createReleaseInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReleaseForFlag(projectKey: string, flagKey: string, createReleaseInput: CreateReleaseInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a release from a flag * @summary Delete a release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteReleaseByFlagKey(projectKey: string, flagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get currently active release for a flag * @summary Get release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleaseByFlagKey(projectKey: string, flagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the [Update phase status for release](https://launchdarkly.com/docs/api/releases-beta/update-phase-status) endpoint. To learn more about migrating from legacy release pipelines to fully automated release pipelines, read the [Release pipeline migration guide](https://launchdarkly.com/docs/guides/flags/release-pipeline-migration). Update currently active release for a flag. Updating releases requires the [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) format. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the `path`. For example, to mark the first phase of a release as complete, use the following request body: ``` [ { \"op\": \"replace\", \"path\": \"/phase/0/complete\", \"value\": true } ] ``` * @summary Patch release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchReleaseByFlagKey(projectKey: string, flagKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the execution status of a phase of a release * @summary Update phase status for release * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {string} phaseId The phase ID * @param {UpdatePhaseStatusInput} updatePhaseStatusInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhaseStatus(projectKey: string, flagKey: string, phaseId: string, updatePhaseStatusInput: UpdatePhaseStatusInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReleasesBetaApi - factory interface * @export */ export declare const ReleasesBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a release by adding a flag to a release pipeline * @summary Create a new release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {CreateReleaseInput} createReleaseInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReleaseForFlag(projectKey: string, flagKey: string, createReleaseInput: CreateReleaseInput, options?: any): AxiosPromise; /** * Deletes a release from a flag * @summary Delete a release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteReleaseByFlagKey(projectKey: string, flagKey: string, options?: any): AxiosPromise; /** * Get currently active release for a flag * @summary Get release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReleaseByFlagKey(projectKey: string, flagKey: string, options?: any): AxiosPromise; /** * This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the [Update phase status for release](https://launchdarkly.com/docs/api/releases-beta/update-phase-status) endpoint. To learn more about migrating from legacy release pipelines to fully automated release pipelines, read the [Release pipeline migration guide](https://launchdarkly.com/docs/guides/flags/release-pipeline-migration). Update currently active release for a flag. Updating releases requires the [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) format. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the `path`. For example, to mark the first phase of a release as complete, use the following request body: ``` [ { \"op\": \"replace\", \"path\": \"/phase/0/complete\", \"value\": true } ] ``` * @summary Patch release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchReleaseByFlagKey(projectKey: string, flagKey: string, patchOperation: Array, options?: any): AxiosPromise; /** * Updates the execution status of a phase of a release * @summary Update phase status for release * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {string} phaseId The phase ID * @param {UpdatePhaseStatusInput} updatePhaseStatusInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhaseStatus(projectKey: string, flagKey: string, phaseId: string, updatePhaseStatusInput: UpdatePhaseStatusInput, options?: any): AxiosPromise; }; /** * ReleasesBetaApi - object-oriented interface * @export * @class ReleasesBetaApi * @extends {BaseAPI} */ export declare class ReleasesBetaApi extends BaseAPI { /** * Creates a release by adding a flag to a release pipeline * @summary Create a new release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {CreateReleaseInput} createReleaseInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasesBetaApi */ createReleaseForFlag(projectKey: string, flagKey: string, createReleaseInput: CreateReleaseInput, options?: AxiosRequestConfig): Promise>; /** * Deletes a release from a flag * @summary Delete a release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasesBetaApi */ deleteReleaseByFlagKey(projectKey: string, flagKey: string, options?: AxiosRequestConfig): Promise>; /** * Get currently active release for a flag * @summary Get release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasesBetaApi */ getReleaseByFlagKey(projectKey: string, flagKey: string, options?: AxiosRequestConfig): Promise>; /** * This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the [Update phase status for release](https://launchdarkly.com/docs/api/releases-beta/update-phase-status) endpoint. To learn more about migrating from legacy release pipelines to fully automated release pipelines, read the [Release pipeline migration guide](https://launchdarkly.com/docs/guides/flags/release-pipeline-migration). Update currently active release for a flag. Updating releases requires the [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) format. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the `path`. For example, to mark the first phase of a release as complete, use the following request body: ``` [ { \"op\": \"replace\", \"path\": \"/phase/0/complete\", \"value\": true } ] ``` * @summary Patch release for flag * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasesBetaApi */ patchReleaseByFlagKey(projectKey: string, flagKey: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Updates the execution status of a phase of a release * @summary Update phase status for release * @param {string} projectKey The project key * @param {string} flagKey The flag key * @param {string} phaseId The phase ID * @param {UpdatePhaseStatusInput} updatePhaseStatusInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReleasesBetaApi */ updatePhaseStatus(projectKey: string, flagKey: string, phaseId: string, updatePhaseStatusInput: UpdatePhaseStatusInput, options?: AxiosRequestConfig): Promise>; } /** * ScheduledChangesApi - axios parameter creator * @export */ export declare const ScheduledChangesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a scheduled changes workflow. * @summary Delete scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagConfigScheduledChanges: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a scheduled change that will be applied to the feature flag by ID. * @summary Get a scheduled change * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagScheduledChange: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of scheduled changes that will be applied to the feature flag. * @summary List scheduled changes * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagConfigScheduledChanges: (projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating scheduled changes.
Click to expand instructions for updating scheduled changes #### deleteScheduledChange Removes the scheduled change. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"deleteScheduledChange\" }] } ``` #### replaceScheduledChangesInstructions Removes the existing scheduled changes and replaces them with the new instructions. ##### Parameters - `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the scheduled changes with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### updateScheduledChangesExecutionDate Updates the execution date for the scheduled changes. ##### Parameters - `value`: the new execution date, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateScheduledChangesExecutionDate\", \"value\": 1754092860000 } ] } ```
* @summary Update scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change ID * @param {FlagScheduledChangesInput} flagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagConfigScheduledChange: (projectKey: string, featureFlagKey: string, environmentKey: string, id: string, flagScheduledChangesInput: FlagScheduledChangesInput, ignoreConflicts?: boolean, options?: AxiosRequestConfig) => Promise; /** * Create scheduled changes for a feature flag. If the `ignoreConficts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed. * @summary Create scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {PostFlagScheduledChangesInput} postFlagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFlagConfigScheduledChanges: (projectKey: string, featureFlagKey: string, environmentKey: string, postFlagScheduledChangesInput: PostFlagScheduledChangesInput, ignoreConflicts?: boolean, options?: AxiosRequestConfig) => Promise; }; /** * ScheduledChangesApi - functional programming interface * @export */ export declare const ScheduledChangesApiFp: (configuration?: Configuration) => { /** * Delete a scheduled changes workflow. * @summary Delete scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a scheduled change that will be applied to the feature flag by ID. * @summary Get a scheduled change * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagScheduledChange(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of scheduled changes that will be applied to the feature flag. * @summary List scheduled changes * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating scheduled changes.
Click to expand instructions for updating scheduled changes #### deleteScheduledChange Removes the scheduled change. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"deleteScheduledChange\" }] } ``` #### replaceScheduledChangesInstructions Removes the existing scheduled changes and replaces them with the new instructions. ##### Parameters - `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the scheduled changes with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### updateScheduledChangesExecutionDate Updates the execution date for the scheduled changes. ##### Parameters - `value`: the new execution date, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateScheduledChangesExecutionDate\", \"value\": 1754092860000 } ] } ```
* @summary Update scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change ID * @param {FlagScheduledChangesInput} flagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagConfigScheduledChange(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, flagScheduledChangesInput: FlagScheduledChangesInput, ignoreConflicts?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create scheduled changes for a feature flag. If the `ignoreConficts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed. * @summary Create scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {PostFlagScheduledChangesInput} postFlagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, postFlagScheduledChangesInput: PostFlagScheduledChangesInput, ignoreConflicts?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ScheduledChangesApi - factory interface * @export */ export declare const ScheduledChangesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a scheduled changes workflow. * @summary Delete scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Get a scheduled change that will be applied to the feature flag by ID. * @summary Get a scheduled change * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureFlagScheduledChange(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: any): AxiosPromise; /** * Get a list of scheduled changes that will be applied to the feature flag. * @summary List scheduled changes * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating scheduled changes.
Click to expand instructions for updating scheduled changes #### deleteScheduledChange Removes the scheduled change. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"deleteScheduledChange\" }] } ``` #### replaceScheduledChangesInstructions Removes the existing scheduled changes and replaces them with the new instructions. ##### Parameters - `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the scheduled changes with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### updateScheduledChangesExecutionDate Updates the execution date for the scheduled changes. ##### Parameters - `value`: the new execution date, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateScheduledChangesExecutionDate\", \"value\": 1754092860000 } ] } ```
* @summary Update scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change ID * @param {FlagScheduledChangesInput} flagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchFlagConfigScheduledChange(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, flagScheduledChangesInput: FlagScheduledChangesInput, ignoreConflicts?: boolean, options?: any): AxiosPromise; /** * Create scheduled changes for a feature flag. If the `ignoreConficts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed. * @summary Create scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {PostFlagScheduledChangesInput} postFlagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, postFlagScheduledChangesInput: PostFlagScheduledChangesInput, ignoreConflicts?: boolean, options?: any): AxiosPromise; }; /** * ScheduledChangesApi - object-oriented interface * @export * @class ScheduledChangesApi * @extends {BaseAPI} */ export declare class ScheduledChangesApi extends BaseAPI { /** * Delete a scheduled changes workflow. * @summary Delete scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ScheduledChangesApi */ deleteFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a scheduled change that will be applied to the feature flag by ID. * @summary Get a scheduled change * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ScheduledChangesApi */ getFeatureFlagScheduledChange(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of scheduled changes that will be applied to the feature flag. * @summary List scheduled changes * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ScheduledChangesApi */ getFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating scheduled changes.
Click to expand instructions for updating scheduled changes #### deleteScheduledChange Removes the scheduled change. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"deleteScheduledChange\" }] } ``` #### replaceScheduledChangesInstructions Removes the existing scheduled changes and replaces them with the new instructions. ##### Parameters - `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`. Here\'s an example that replaces the scheduled changes with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### updateScheduledChangesExecutionDate Updates the execution date for the scheduled changes. ##### Parameters - `value`: the new execution date, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateScheduledChangesExecutionDate\", \"value\": 1754092860000 } ] } ```
* @summary Update scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} id The scheduled change ID * @param {FlagScheduledChangesInput} flagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ScheduledChangesApi */ patchFlagConfigScheduledChange(projectKey: string, featureFlagKey: string, environmentKey: string, id: string, flagScheduledChangesInput: FlagScheduledChangesInput, ignoreConflicts?: boolean, options?: AxiosRequestConfig): Promise>; /** * Create scheduled changes for a feature flag. If the `ignoreConficts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed. * @summary Create scheduled changes workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {PostFlagScheduledChangesInput} postFlagScheduledChangesInput * @param {boolean} [ignoreConflicts] Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ScheduledChangesApi */ postFlagConfigScheduledChanges(projectKey: string, featureFlagKey: string, environmentKey: string, postFlagScheduledChangesInput: PostFlagScheduledChangesInput, ignoreConflicts?: boolean, options?: AxiosRequestConfig): Promise>; } /** * SegmentsApi - axios parameter creator * @export */ export declare const SegmentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Starts a new export process for a big segment. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Create big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentExport: (projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Start a new import process for a big segment. This is an import for a list-based segment that can include more than 15,000 entries. * @summary Create big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {any} [file] CSV file containing keys * @param {string} [mode] Import mode. Use either `merge` or `replace` * @param {boolean} [waitOnApprovals] Whether to wait for approvals before processing the import * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentImport: (projectKey: string, environmentKey: string, segmentKey: string, file?: any, mode?: string, waitOnApprovals?: boolean, options?: AxiosRequestConfig) => Promise; /** * Delete a segment. * @summary Delete segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSegment: (projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Returns information about a big segment export process. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Get big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} exportID The export ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentExport: (projectKey: string, environmentKey: string, segmentKey: string, exportID: string, options?: AxiosRequestConfig) => Promise; /** * Returns information about a big segment import process. This is the import of a list-based segment that can include more than 15,000 entries. * @summary Get big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} importID The import ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentImport: (projectKey: string, environmentKey: string, segmentKey: string, importID: string, options?: AxiosRequestConfig) => Promise; /** * For a given context instance with attributes, get membership details for all segments. In the request body, pass in the context instance. * @summary List segment memberships for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextInstanceSegmentsMembershipByEnv: (projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, options?: AxiosRequestConfig) => Promise; /** * Get a list of a segment\'s context targets that are scheduled for removal. * @summary Get expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringTargetsForSegment: (projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig) => Promise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of a segment\'s user targets that are scheduled for removal. * @summary Get expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringUserTargetsForSegment: (projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a single segment by key.

Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. * @summary Get segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegment: (projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Get the membership status (included/excluded) for a given context in this big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Get big segment membership for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} contextKey The context key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentMembershipForContext: (projectKey: string, environmentKey: string, segmentKey: string, contextKey: string, options?: AxiosRequestConfig) => Promise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get the membership status (included/excluded) for a given user in this big segment. This operation does not support standard segments. * @summary Get big segment membership for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentMembershipForUser: (projectKey: string, environmentKey: string, segmentKey: string, userKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a list of all segments in the given project. Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. ### Filtering segments The `filter` parameter supports the following operators: `equals`, `anyOf`, and `exists`. You can also combine filters in the following ways: - Use a comma (`,`) as an AND operator - Use a vertical bar (`|`) as an OR operator - Use parentheses (`()`) to group filters #### Supported fields and operators You can only filter certain fields in segments when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for segments, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `excludedKeys` | The segment keys of segments to exclude from the results. | `anyOf` | | `external` | Whether the segment is a synced segment. | `exists` | | `includedKeys` | The segment keys of segments to include in the results. | `anyOf` | | `query` | A \"fuzzy\" search across segment key, name, and description. Supply a string or list of strings to the operator. | `equals` | | `tags` | The segment tags. | `anyOf` | | `unbounded` | Whether the segment is a standard segment (`false`) or a big segment (`true`). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. | `equals` | Here are a few examples: * The filter `?filter=tags anyOf [\"enterprise\", \"beta\"],query equals \"toggle\"` matches segments with \"toggle\" in their key, name, or description that also have \"enterprise\" or \"beta\" as a tag. * The filter `?filter=excludedKeys anyOf [\"segmentKey1\", \"segmentKey2\"]` excludes the segments with those keys from the results. * The filter `?filter=unbounded equals true` matches larger list-based segments and synced segments. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags anyOf [\"enterprise\", \"beta\"]` must be encoded to `%5B`. * @summary List segments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of segments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are \'creationDate\', \'name\', \'lastModified\'. Example: `sort=name` sort by names ascending or `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [filter] Accepts filter by `excludedKeys`, `external`, `includedKeys`, `query`, `tags`, `unbounded`. To learn more about the filter syntax, read the \'Filtering segments\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegments: (projectKey: string, environmentKey: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig) => Promise; /** * Update expiring context targets for a segment. Updating a context target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring context targets.
Click to expand instructions for updating expiring context targets #### addExpiringTarget Schedules a date and time when LaunchDarkly will remove a context from segment targeting. The segment must already have the context as an individual target. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The date when the context should expire from the segment targeting, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754092860000 }] } ``` #### updateExpiringTarget Updates the date and time when LaunchDarkly will remove a context from segment targeting. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The new date when the context should expire from the segment targeting, in Unix milliseconds. - `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754179260000 }] } ``` #### removeExpiringTarget Removes the scheduled expiration for the context in the segment. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", }] } ```
* @summary Update expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentExpiringTargetInputRep} patchSegmentExpiringTargetInputRep * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringTargetsForSegment: (projectKey: string, environmentKey: string, segmentKey: string, patchSegmentExpiringTargetInputRep: PatchSegmentExpiringTargetInputRep, options?: AxiosRequestConfig) => Promise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/patch-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Update expiring user targets for a segment. Updating a user target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Schedules a date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The date when the user should expire from the segment targeting, in Unix milliseconds. #### updateExpireUserTargetDate Updates the date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The new date when the user should expire from the segment targeting, in Unix milliseconds. - `version`: The segment version. #### removeExpireUserTargetDate Removes the scheduled expiration for the user in the segment. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key.
* @summary Update expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentRequest} patchSegmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringUserTargetsForSegment: (projectKey: string, environmentKey: string, segmentKey: string, patchSegmentRequest: PatchSegmentRequest, options?: AxiosRequestConfig) => Promise; /** * Update a segment. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a segment To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating segments requires an `environmentKey` in addition to `instructions` and an optional `comment`. The body of the request takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. ### Instructions Semantic patch requests support the following `kind` instructions for updating segments.
Click to expand instructions for updating segment details and settings #### addTags Adds tags to the segment. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### removeTags Removes tags from the segment. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### updateName Updates the name of the segment. ##### Parameters - `value`: Name of the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated segment name\" }] } ```
Click to expand instructions for updating segment individual targets #### addExcludedTargets Adds context keys to the individual context targets excluded from the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addExcludedUsers Adds user keys to the individual user targets excluded from the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### addIncludedTargets Adds context keys to the individual context targets included in the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addIncludedUsers Adds user keys to the individual user targets included in the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeExcludedTargets Removes context keys from the individual context targets excluded from the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeExcludedUsers Removes user keys from the individual user targets excluded from the segment. If you are working with contexts, use `removeExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeIncludedTargets Removes context keys from the individual context targets included in the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeIncludedUsers Removes user keys from the individual user targets included in the segment. If you are working with contexts, use `removeIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ```
Click to expand instructions for updating segment targeting rules #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addClauses\", \"clauses\": [ { \"attribute\": \"email\", \"negate\": false, \"op\": \"contains\", \"values\": [\"value1\"] } ], \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", }] } ``` #### addRule Adds a new targeting rule to the segment. The rule may contain `clauses`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `description`: A description of the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"contains\", \"negate\": false, \"values\": [\"@launchdarkly.com\"] } ], \"description\": \"Targeting rule for LaunchDarkly employees\", }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules in the segment. ##### Parameters - `ruleIds`: Array of IDs of all targeting rules in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateRuleDescription Updates the description of the segment targeting rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleRolloutAndContextKind For a rule that includes a percentage of targets, updates the percentage and the context kind of the targets to include. ##### Parameters - `ruleId`: The ID of a targeting rule in the segment that includes a percentage of targets. - `weight`: The weight, in thousandths of a percent (0-100000). - `contextKind`: The context kind. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"weight\": \"20000\", \"contextKind\": \"device\" }] } ```
Click to expand instructions for working with Big Segments A \"big segment\" is a segment that is either a synced segment, or a list-based segment with more than 15,000 entries that includes only one targeted context kind. LaunchDarkly uses different implementations for different types of segments so that all of your segments have good performance. The following semantic patch instructions apply only to these [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments). #### addBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets excluded from the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets included in the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### processBigSegmentImport For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Processes a segment import. ##### Parameters - `importId`: The ID of the import. The import ID is returned in the `Location` header as part of the [Create big segment import](https://launchdarkly.com/docs/api/segments/create-big-segment-import) request. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"processBigSegmentImport\", \"importId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets excluded from the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets included in the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ```
### Using JSON patches on a segment If you do not include the header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. For example, to update the description for a segment with a JSON patch, use the following request body: ```json { \"patch\": [ { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"new description\" } ] } ``` To update fields in the segment that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add the new entry to the beginning of the array. Use `/-` to add the new entry to the end of the array. For example, to add a rule to a segment, use the following request body: ```json { \"patch\":[ { \"op\": \"add\", \"path\": \"/rules/0\", \"value\": { \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"email\", \"op\": \"endsWith\", \"values\": [\".edu\"], \"negate\": false }] } } ] } ``` To add or remove targets from segments, we recommend using semantic patch. Semantic patch for segments includes specific instructions for adding and removing both included and excluded targets. * @summary Patch segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchSegment: (projectKey: string, environmentKey: string, segmentKey: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig) => Promise; /** * Create a new segment. * @summary Create segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {SegmentBody} segmentBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSegment: (projectKey: string, environmentKey: string, segmentBody: SegmentBody, options?: AxiosRequestConfig) => Promise; /** * Update context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateBigSegmentContextTargets: (projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: AxiosRequestConfig) => Promise; /** * Update user context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update user context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateBigSegmentTargets: (projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: AxiosRequestConfig) => Promise; }; /** * SegmentsApi - functional programming interface * @export */ export declare const SegmentsApiFp: (configuration?: Configuration) => { /** * Starts a new export process for a big segment. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Create big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentExport(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Start a new import process for a big segment. This is an import for a list-based segment that can include more than 15,000 entries. * @summary Create big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {any} [file] CSV file containing keys * @param {string} [mode] Import mode. Use either `merge` or `replace` * @param {boolean} [waitOnApprovals] Whether to wait for approvals before processing the import * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentImport(projectKey: string, environmentKey: string, segmentKey: string, file?: any, mode?: string, waitOnApprovals?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a segment. * @summary Delete segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about a big segment export process. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Get big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} exportID The export ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentExport(projectKey: string, environmentKey: string, segmentKey: string, exportID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about a big segment import process. This is the import of a list-based segment that can include more than 15,000 entries. * @summary Get big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} importID The import ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentImport(projectKey: string, environmentKey: string, segmentKey: string, importID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * For a given context instance with attributes, get membership details for all segments. In the request body, pass in the context instance. * @summary List segment memberships for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextInstanceSegmentsMembershipByEnv(projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of a segment\'s context targets that are scheduled for removal. * @summary Get expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of a segment\'s user targets that are scheduled for removal. * @summary Get expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringUserTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single segment by key.

Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. * @summary Get segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the membership status (included/excluded) for a given context in this big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Get big segment membership for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} contextKey The context key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentMembershipForContext(projectKey: string, environmentKey: string, segmentKey: string, contextKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get the membership status (included/excluded) for a given user in this big segment. This operation does not support standard segments. * @summary Get big segment membership for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentMembershipForUser(projectKey: string, environmentKey: string, segmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all segments in the given project. Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. ### Filtering segments The `filter` parameter supports the following operators: `equals`, `anyOf`, and `exists`. You can also combine filters in the following ways: - Use a comma (`,`) as an AND operator - Use a vertical bar (`|`) as an OR operator - Use parentheses (`()`) to group filters #### Supported fields and operators You can only filter certain fields in segments when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for segments, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `excludedKeys` | The segment keys of segments to exclude from the results. | `anyOf` | | `external` | Whether the segment is a synced segment. | `exists` | | `includedKeys` | The segment keys of segments to include in the results. | `anyOf` | | `query` | A \"fuzzy\" search across segment key, name, and description. Supply a string or list of strings to the operator. | `equals` | | `tags` | The segment tags. | `anyOf` | | `unbounded` | Whether the segment is a standard segment (`false`) or a big segment (`true`). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. | `equals` | Here are a few examples: * The filter `?filter=tags anyOf [\"enterprise\", \"beta\"],query equals \"toggle\"` matches segments with \"toggle\" in their key, name, or description that also have \"enterprise\" or \"beta\" as a tag. * The filter `?filter=excludedKeys anyOf [\"segmentKey1\", \"segmentKey2\"]` excludes the segments with those keys from the results. * The filter `?filter=unbounded equals true` matches larger list-based segments and synced segments. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags anyOf [\"enterprise\", \"beta\"]` must be encoded to `%5B`. * @summary List segments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of segments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are \'creationDate\', \'name\', \'lastModified\'. Example: `sort=name` sort by names ascending or `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [filter] Accepts filter by `excludedKeys`, `external`, `includedKeys`, `query`, `tags`, `unbounded`. To learn more about the filter syntax, read the \'Filtering segments\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegments(projectKey: string, environmentKey: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update expiring context targets for a segment. Updating a context target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring context targets.
Click to expand instructions for updating expiring context targets #### addExpiringTarget Schedules a date and time when LaunchDarkly will remove a context from segment targeting. The segment must already have the context as an individual target. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The date when the context should expire from the segment targeting, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754092860000 }] } ``` #### updateExpiringTarget Updates the date and time when LaunchDarkly will remove a context from segment targeting. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The new date when the context should expire from the segment targeting, in Unix milliseconds. - `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754179260000 }] } ``` #### removeExpiringTarget Removes the scheduled expiration for the context in the segment. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", }] } ```
* @summary Update expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentExpiringTargetInputRep} patchSegmentExpiringTargetInputRep * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, patchSegmentExpiringTargetInputRep: PatchSegmentExpiringTargetInputRep, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/patch-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Update expiring user targets for a segment. Updating a user target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Schedules a date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The date when the user should expire from the segment targeting, in Unix milliseconds. #### updateExpireUserTargetDate Updates the date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The new date when the user should expire from the segment targeting, in Unix milliseconds. - `version`: The segment version. #### removeExpireUserTargetDate Removes the scheduled expiration for the user in the segment. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key.
* @summary Update expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentRequest} patchSegmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringUserTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, patchSegmentRequest: PatchSegmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a segment. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a segment To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating segments requires an `environmentKey` in addition to `instructions` and an optional `comment`. The body of the request takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. ### Instructions Semantic patch requests support the following `kind` instructions for updating segments.
Click to expand instructions for updating segment details and settings #### addTags Adds tags to the segment. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### removeTags Removes tags from the segment. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### updateName Updates the name of the segment. ##### Parameters - `value`: Name of the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated segment name\" }] } ```
Click to expand instructions for updating segment individual targets #### addExcludedTargets Adds context keys to the individual context targets excluded from the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addExcludedUsers Adds user keys to the individual user targets excluded from the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### addIncludedTargets Adds context keys to the individual context targets included in the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addIncludedUsers Adds user keys to the individual user targets included in the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeExcludedTargets Removes context keys from the individual context targets excluded from the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeExcludedUsers Removes user keys from the individual user targets excluded from the segment. If you are working with contexts, use `removeExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeIncludedTargets Removes context keys from the individual context targets included in the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeIncludedUsers Removes user keys from the individual user targets included in the segment. If you are working with contexts, use `removeIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ```
Click to expand instructions for updating segment targeting rules #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addClauses\", \"clauses\": [ { \"attribute\": \"email\", \"negate\": false, \"op\": \"contains\", \"values\": [\"value1\"] } ], \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", }] } ``` #### addRule Adds a new targeting rule to the segment. The rule may contain `clauses`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `description`: A description of the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"contains\", \"negate\": false, \"values\": [\"@launchdarkly.com\"] } ], \"description\": \"Targeting rule for LaunchDarkly employees\", }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules in the segment. ##### Parameters - `ruleIds`: Array of IDs of all targeting rules in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateRuleDescription Updates the description of the segment targeting rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleRolloutAndContextKind For a rule that includes a percentage of targets, updates the percentage and the context kind of the targets to include. ##### Parameters - `ruleId`: The ID of a targeting rule in the segment that includes a percentage of targets. - `weight`: The weight, in thousandths of a percent (0-100000). - `contextKind`: The context kind. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"weight\": \"20000\", \"contextKind\": \"device\" }] } ```
Click to expand instructions for working with Big Segments A \"big segment\" is a segment that is either a synced segment, or a list-based segment with more than 15,000 entries that includes only one targeted context kind. LaunchDarkly uses different implementations for different types of segments so that all of your segments have good performance. The following semantic patch instructions apply only to these [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments). #### addBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets excluded from the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets included in the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### processBigSegmentImport For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Processes a segment import. ##### Parameters - `importId`: The ID of the import. The import ID is returned in the `Location` header as part of the [Create big segment import](https://launchdarkly.com/docs/api/segments/create-big-segment-import) request. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"processBigSegmentImport\", \"importId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets excluded from the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets included in the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ```
### Using JSON patches on a segment If you do not include the header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. For example, to update the description for a segment with a JSON patch, use the following request body: ```json { \"patch\": [ { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"new description\" } ] } ``` To update fields in the segment that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add the new entry to the beginning of the array. Use `/-` to add the new entry to the end of the array. For example, to add a rule to a segment, use the following request body: ```json { \"patch\":[ { \"op\": \"add\", \"path\": \"/rules/0\", \"value\": { \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"email\", \"op\": \"endsWith\", \"values\": [\".edu\"], \"negate\": false }] } } ] } ``` To add or remove targets from segments, we recommend using semantic patch. Semantic patch for segments includes specific instructions for adding and removing both included and excluded targets. * @summary Patch segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchSegment(projectKey: string, environmentKey: string, segmentKey: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new segment. * @summary Create segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {SegmentBody} segmentBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSegment(projectKey: string, environmentKey: string, segmentBody: SegmentBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateBigSegmentContextTargets(projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update user context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update user context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateBigSegmentTargets(projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SegmentsApi - factory interface * @export */ export declare const SegmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Starts a new export process for a big segment. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Create big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentExport(projectKey: string, environmentKey: string, segmentKey: string, options?: any): AxiosPromise; /** * Start a new import process for a big segment. This is an import for a list-based segment that can include more than 15,000 entries. * @summary Create big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {any} [file] CSV file containing keys * @param {string} [mode] Import mode. Use either `merge` or `replace` * @param {boolean} [waitOnApprovals] Whether to wait for approvals before processing the import * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBigSegmentImport(projectKey: string, environmentKey: string, segmentKey: string, file?: any, mode?: string, waitOnApprovals?: boolean, options?: any): AxiosPromise; /** * Delete a segment. * @summary Delete segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: any): AxiosPromise; /** * Returns information about a big segment export process. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Get big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} exportID The export ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentExport(projectKey: string, environmentKey: string, segmentKey: string, exportID: string, options?: any): AxiosPromise; /** * Returns information about a big segment import process. This is the import of a list-based segment that can include more than 15,000 entries. * @summary Get big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} importID The import ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBigSegmentImport(projectKey: string, environmentKey: string, segmentKey: string, importID: string, options?: any): AxiosPromise; /** * For a given context instance with attributes, get membership details for all segments. In the request body, pass in the context instance. * @summary List segment memberships for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContextInstanceSegmentsMembershipByEnv(projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, options?: any): AxiosPromise; /** * Get a list of a segment\'s context targets that are scheduled for removal. * @summary Get expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: any): AxiosPromise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of a segment\'s user targets that are scheduled for removal. * @summary Get expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExpiringUserTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: any): AxiosPromise; /** * Get a single segment by key.

Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. * @summary Get segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: any): AxiosPromise; /** * Get the membership status (included/excluded) for a given context in this big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Get big segment membership for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} contextKey The context key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentMembershipForContext(projectKey: string, environmentKey: string, segmentKey: string, contextKey: string, options?: any): AxiosPromise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get the membership status (included/excluded) for a given user in this big segment. This operation does not support standard segments. * @summary Get big segment membership for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentMembershipForUser(projectKey: string, environmentKey: string, segmentKey: string, userKey: string, options?: any): AxiosPromise; /** * Get a list of all segments in the given project. Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. ### Filtering segments The `filter` parameter supports the following operators: `equals`, `anyOf`, and `exists`. You can also combine filters in the following ways: - Use a comma (`,`) as an AND operator - Use a vertical bar (`|`) as an OR operator - Use parentheses (`()`) to group filters #### Supported fields and operators You can only filter certain fields in segments when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for segments, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `excludedKeys` | The segment keys of segments to exclude from the results. | `anyOf` | | `external` | Whether the segment is a synced segment. | `exists` | | `includedKeys` | The segment keys of segments to include in the results. | `anyOf` | | `query` | A \"fuzzy\" search across segment key, name, and description. Supply a string or list of strings to the operator. | `equals` | | `tags` | The segment tags. | `anyOf` | | `unbounded` | Whether the segment is a standard segment (`false`) or a big segment (`true`). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. | `equals` | Here are a few examples: * The filter `?filter=tags anyOf [\"enterprise\", \"beta\"],query equals \"toggle\"` matches segments with \"toggle\" in their key, name, or description that also have \"enterprise\" or \"beta\" as a tag. * The filter `?filter=excludedKeys anyOf [\"segmentKey1\", \"segmentKey2\"]` excludes the segments with those keys from the results. * The filter `?filter=unbounded equals true` matches larger list-based segments and synced segments. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags anyOf [\"enterprise\", \"beta\"]` must be encoded to `%5B`. * @summary List segments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of segments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are \'creationDate\', \'name\', \'lastModified\'. Example: `sort=name` sort by names ascending or `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [filter] Accepts filter by `excludedKeys`, `external`, `includedKeys`, `query`, `tags`, `unbounded`. To learn more about the filter syntax, read the \'Filtering segments\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegments(projectKey: string, environmentKey: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: any): AxiosPromise; /** * Update expiring context targets for a segment. Updating a context target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring context targets.
Click to expand instructions for updating expiring context targets #### addExpiringTarget Schedules a date and time when LaunchDarkly will remove a context from segment targeting. The segment must already have the context as an individual target. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The date when the context should expire from the segment targeting, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754092860000 }] } ``` #### updateExpiringTarget Updates the date and time when LaunchDarkly will remove a context from segment targeting. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The new date when the context should expire from the segment targeting, in Unix milliseconds. - `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754179260000 }] } ``` #### removeExpiringTarget Removes the scheduled expiration for the context in the segment. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", }] } ```
* @summary Update expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentExpiringTargetInputRep} patchSegmentExpiringTargetInputRep * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, patchSegmentExpiringTargetInputRep: PatchSegmentExpiringTargetInputRep, options?: any): AxiosPromise; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/patch-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Update expiring user targets for a segment. Updating a user target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Schedules a date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The date when the user should expire from the segment targeting, in Unix milliseconds. #### updateExpireUserTargetDate Updates the date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The new date when the user should expire from the segment targeting, in Unix milliseconds. - `version`: The segment version. #### removeExpireUserTargetDate Removes the scheduled expiration for the user in the segment. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key.
* @summary Update expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentRequest} patchSegmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchExpiringUserTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, patchSegmentRequest: PatchSegmentRequest, options?: any): AxiosPromise; /** * Update a segment. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a segment To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating segments requires an `environmentKey` in addition to `instructions` and an optional `comment`. The body of the request takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. ### Instructions Semantic patch requests support the following `kind` instructions for updating segments.
Click to expand instructions for updating segment details and settings #### addTags Adds tags to the segment. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### removeTags Removes tags from the segment. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### updateName Updates the name of the segment. ##### Parameters - `value`: Name of the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated segment name\" }] } ```
Click to expand instructions for updating segment individual targets #### addExcludedTargets Adds context keys to the individual context targets excluded from the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addExcludedUsers Adds user keys to the individual user targets excluded from the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### addIncludedTargets Adds context keys to the individual context targets included in the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addIncludedUsers Adds user keys to the individual user targets included in the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeExcludedTargets Removes context keys from the individual context targets excluded from the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeExcludedUsers Removes user keys from the individual user targets excluded from the segment. If you are working with contexts, use `removeExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeIncludedTargets Removes context keys from the individual context targets included in the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeIncludedUsers Removes user keys from the individual user targets included in the segment. If you are working with contexts, use `removeIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ```
Click to expand instructions for updating segment targeting rules #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addClauses\", \"clauses\": [ { \"attribute\": \"email\", \"negate\": false, \"op\": \"contains\", \"values\": [\"value1\"] } ], \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", }] } ``` #### addRule Adds a new targeting rule to the segment. The rule may contain `clauses`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `description`: A description of the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"contains\", \"negate\": false, \"values\": [\"@launchdarkly.com\"] } ], \"description\": \"Targeting rule for LaunchDarkly employees\", }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules in the segment. ##### Parameters - `ruleIds`: Array of IDs of all targeting rules in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateRuleDescription Updates the description of the segment targeting rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleRolloutAndContextKind For a rule that includes a percentage of targets, updates the percentage and the context kind of the targets to include. ##### Parameters - `ruleId`: The ID of a targeting rule in the segment that includes a percentage of targets. - `weight`: The weight, in thousandths of a percent (0-100000). - `contextKind`: The context kind. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"weight\": \"20000\", \"contextKind\": \"device\" }] } ```
Click to expand instructions for working with Big Segments A \"big segment\" is a segment that is either a synced segment, or a list-based segment with more than 15,000 entries that includes only one targeted context kind. LaunchDarkly uses different implementations for different types of segments so that all of your segments have good performance. The following semantic patch instructions apply only to these [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments). #### addBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets excluded from the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets included in the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### processBigSegmentImport For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Processes a segment import. ##### Parameters - `importId`: The ID of the import. The import ID is returned in the `Location` header as part of the [Create big segment import](https://launchdarkly.com/docs/api/segments/create-big-segment-import) request. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"processBigSegmentImport\", \"importId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets excluded from the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets included in the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ```
### Using JSON patches on a segment If you do not include the header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. For example, to update the description for a segment with a JSON patch, use the following request body: ```json { \"patch\": [ { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"new description\" } ] } ``` To update fields in the segment that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add the new entry to the beginning of the array. Use `/-` to add the new entry to the end of the array. For example, to add a rule to a segment, use the following request body: ```json { \"patch\":[ { \"op\": \"add\", \"path\": \"/rules/0\", \"value\": { \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"email\", \"op\": \"endsWith\", \"values\": [\".edu\"], \"negate\": false }] } } ] } ``` To add or remove targets from segments, we recommend using semantic patch. Semantic patch for segments includes specific instructions for adding and removing both included and excluded targets. * @summary Patch segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchSegment(projectKey: string, environmentKey: string, segmentKey: string, patchWithComment: PatchWithComment, options?: any): AxiosPromise; /** * Create a new segment. * @summary Create segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {SegmentBody} segmentBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSegment(projectKey: string, environmentKey: string, segmentBody: SegmentBody, options?: any): AxiosPromise; /** * Update context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateBigSegmentContextTargets(projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: any): AxiosPromise; /** * Update user context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update user context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateBigSegmentTargets(projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: any): AxiosPromise; }; /** * SegmentsApi - object-oriented interface * @export * @class SegmentsApi * @extends {BaseAPI} */ export declare class SegmentsApi extends BaseAPI { /** * Starts a new export process for a big segment. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Create big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ createBigSegmentExport(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Start a new import process for a big segment. This is an import for a list-based segment that can include more than 15,000 entries. * @summary Create big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {any} [file] CSV file containing keys * @param {string} [mode] Import mode. Use either `merge` or `replace` * @param {boolean} [waitOnApprovals] Whether to wait for approvals before processing the import * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ createBigSegmentImport(projectKey: string, environmentKey: string, segmentKey: string, file?: any, mode?: string, waitOnApprovals?: boolean, options?: AxiosRequestConfig): Promise>; /** * Delete a segment. * @summary Delete segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ deleteSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Returns information about a big segment export process. This is an export for a synced segment or a list-based segment that can include more than 15,000 entries. * @summary Get big segment export * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} exportID The export ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getBigSegmentExport(projectKey: string, environmentKey: string, segmentKey: string, exportID: string, options?: AxiosRequestConfig): Promise>; /** * Returns information about a big segment import process. This is the import of a list-based segment that can include more than 15,000 entries. * @summary Get big segment import * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} importID The import ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getBigSegmentImport(projectKey: string, environmentKey: string, segmentKey: string, importID: string, options?: AxiosRequestConfig): Promise>; /** * For a given context instance with attributes, get membership details for all segments. In the request body, pass in the context instance. * @summary List segment memberships for context instance * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {{ [key: string]: any; }} requestBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getContextInstanceSegmentsMembershipByEnv(projectKey: string, environmentKey: string, requestBody: { [key: string]: any; }, options?: AxiosRequestConfig): Promise>; /** * Get a list of a segment\'s context targets that are scheduled for removal. * @summary Get expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getExpiringTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get a list of a segment\'s user targets that are scheduled for removal. * @summary Get expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getExpiringUserTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a single segment by key.

Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. * @summary Get segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getSegment(projectKey: string, environmentKey: string, segmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Get the membership status (included/excluded) for a given context in this big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Get big segment membership for context * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} contextKey The context key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getSegmentMembershipForContext(projectKey: string, environmentKey: string, segmentKey: string, contextKey: string, options?: AxiosRequestConfig): Promise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/get-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Get the membership status (included/excluded) for a given user in this big segment. This operation does not support standard segments. * @summary Get big segment membership for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getSegmentMembershipForUser(projectKey: string, environmentKey: string, segmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a list of all segments in the given project. Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments. ### Filtering segments The `filter` parameter supports the following operators: `equals`, `anyOf`, and `exists`. You can also combine filters in the following ways: - Use a comma (`,`) as an AND operator - Use a vertical bar (`|`) as an OR operator - Use parentheses (`()`) to group filters #### Supported fields and operators You can only filter certain fields in segments when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for segments, the `filter` parameter supports the following fields and operators: |
Field
|Description |Supported operators | |---|---|---| | `excludedKeys` | The segment keys of segments to exclude from the results. | `anyOf` | | `external` | Whether the segment is a synced segment. | `exists` | | `includedKeys` | The segment keys of segments to include in the results. | `anyOf` | | `query` | A \"fuzzy\" search across segment key, name, and description. Supply a string or list of strings to the operator. | `equals` | | `tags` | The segment tags. | `anyOf` | | `unbounded` | Whether the segment is a standard segment (`false`) or a big segment (`true`). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. | `equals` | Here are a few examples: * The filter `?filter=tags anyOf [\"enterprise\", \"beta\"],query equals \"toggle\"` matches segments with \"toggle\" in their key, name, or description that also have \"enterprise\" or \"beta\" as a tag. * The filter `?filter=excludedKeys anyOf [\"segmentKey1\", \"segmentKey2\"]` excludes the segments with those keys from the results. * The filter `?filter=unbounded equals true` matches larger list-based segments and synced segments. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags anyOf [\"enterprise\", \"beta\"]` must be encoded to `%5B`. * @summary List segments * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of segments to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {string} [sort] Accepts sorting order and fields. Fields can be comma separated. Possible fields are \'creationDate\', \'name\', \'lastModified\'. Example: `sort=name` sort by names ascending or `sort=-name,creationDate` sort by names descending and creationDate ascending. * @param {string} [filter] Accepts filter by `excludedKeys`, `external`, `includedKeys`, `query`, `tags`, `unbounded`. To learn more about the filter syntax, read the \'Filtering segments\' section above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ getSegments(projectKey: string, environmentKey: string, limit?: number, offset?: number, sort?: string, filter?: string, options?: AxiosRequestConfig): Promise>; /** * Update expiring context targets for a segment. Updating a context target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring context targets.
Click to expand instructions for updating expiring context targets #### addExpiringTarget Schedules a date and time when LaunchDarkly will remove a context from segment targeting. The segment must already have the context as an individual target. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The date when the context should expire from the segment targeting, in Unix milliseconds. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754092860000 }] } ``` #### updateExpiringTarget Updates the date and time when LaunchDarkly will remove a context from segment targeting. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The new date when the context should expire from the segment targeting, in Unix milliseconds. - `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn\'t match current version of the expiring target. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", \"value\": 1754179260000 }] } ``` #### removeExpiringTarget Removes the scheduled expiration for the context in the segment. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExpiringTarget\", \"targetType\": \"included\", \"contextKey\": \"user-key-123abc\", \"contextKind\": \"user\", }] } ```
* @summary Update expiring targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentExpiringTargetInputRep} patchSegmentExpiringTargetInputRep * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ patchExpiringTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, patchSegmentExpiringTargetInputRep: PatchSegmentExpiringTargetInputRep, options?: AxiosRequestConfig): Promise>; /** * > ### Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Update expiring targets for segment](https://launchdarkly.com/docs/ld-docs/api/segments/patch-expiring-targets-for-segment) instead of this endpoint. To learn more, read [Contexts](https://launchdarkly.com/docs/home/observability/contexts). Update expiring user targets for a segment. Updating a user target expiration uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty. ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Schedules a date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The date when the user should expire from the segment targeting, in Unix milliseconds. #### updateExpireUserTargetDate Updates the date and time when LaunchDarkly will remove a user from segment targeting. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key. - `value`: The new date when the user should expire from the segment targeting, in Unix milliseconds. - `version`: The segment version. #### removeExpireUserTargetDate Removes the scheduled expiration for the user in the segment. ##### Parameters - `targetType`: A segment\'s target type, must be either `included` or `excluded`. - `userKey`: The user key.
* @summary Update expiring user targets for segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchSegmentRequest} patchSegmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ patchExpiringUserTargetsForSegment(projectKey: string, environmentKey: string, segmentKey: string, patchSegmentRequest: PatchSegmentRequest, options?: AxiosRequestConfig): Promise>; /** * Update a segment. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates). ### Using semantic patches on a segment To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). The body of a semantic patch request for updating segments requires an `environmentKey` in addition to `instructions` and an optional `comment`. The body of the request takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): (Required) The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. ### Instructions Semantic patch requests support the following `kind` instructions for updating segments.
Click to expand instructions for updating segment details and settings #### addTags Adds tags to the segment. ##### Parameters - `values`: A list of tags to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### removeTags Removes tags from the segment. ##### Parameters - `values`: A list of tags to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] }] } ``` #### updateName Updates the name of the segment. ##### Parameters - `value`: Name of the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated segment name\" }] } ```
Click to expand instructions for updating segment individual targets #### addExcludedTargets Adds context keys to the individual context targets excluded from the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addExcludedUsers Adds user keys to the individual user targets excluded from the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### addIncludedTargets Adds context keys to the individual context targets included in the segment for the specified `contextKind`. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `contextKind`: The context kind the targets should be added to. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addIncludedUsers Adds user keys to the individual user targets included in the segment. Returns an error if this causes the same user key to be both included and excluded. If you are working with contexts, use `addIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeExcludedTargets Removes context keys from the individual context targets excluded from the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeExcludedUsers Removes user keys from the individual user targets excluded from the segment. If you are working with contexts, use `removeExcludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeExcludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ``` #### removeIncludedTargets Removes context keys from the individual context targets included in the segment for the specified `contextKind`. ##### Parameters - `contextKind`: The context kind the targets should be removed from. - `values`: List of keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedTargets\", \"contextKind\": \"org\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeIncludedUsers Removes user keys from the individual user targets included in the segment. If you are working with contexts, use `removeIncludedTargets` instead of this instruction. ##### Parameters - `values`: List of user keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeIncludedUsers\", \"values\": [ \"user-key-123abc\", \"user-key-456def\" ] }] } ```
Click to expand instructions for updating segment targeting rules #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addClauses\", \"clauses\": [ { \"attribute\": \"email\", \"negate\": false, \"op\": \"contains\", \"values\": [\"value1\"] } ], \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", }] } ``` #### addRule Adds a new targeting rule to the segment. The rule may contain `clauses`. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `description`: A description of the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"contains\", \"negate\": false, \"values\": [\"@launchdarkly.com\"] } ], \"description\": \"Targeting rule for LaunchDarkly employees\", }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addValuesToClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseIds`: Array of IDs of clauses in the rule. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeClauses\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"] }] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeValuesFromClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\", \"values\": [\"beta_testers\"] }] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules in the segment. ##### Parameters - `ruleIds`: Array of IDs of all targeting rules in the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"] }] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the segment. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, if not provided, defaults to `user`. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateClause\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\", \"clause\": { \"contextKind\": \"user\", \"attribute\": \"country\", \"op\": \"in\", \"negate\": false, \"values\": [\"Mexico\", \"Canada\"] } }] } ``` #### updateRuleDescription Updates the description of the segment targeting rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the segment. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateRuleDescription\", \"description\": \"New rule description\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### updateRuleRolloutAndContextKind For a rule that includes a percentage of targets, updates the percentage and the context kind of the targets to include. ##### Parameters - `ruleId`: The ID of a targeting rule in the segment that includes a percentage of targets. - `weight`: The weight, in thousandths of a percent (0-100000). - `contextKind`: The context kind. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"reorderRules\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"weight\": \"20000\", \"contextKind\": \"device\" }] } ```
Click to expand instructions for working with Big Segments A \"big segment\" is a segment that is either a synced segment, or a list-based segment with more than 15,000 entries that includes only one targeted context kind. LaunchDarkly uses different implementations for different types of segments so that all of your segments have good performance. The following semantic patch instructions apply only to these [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments). #### addBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets excluded from the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### addBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Adds context keys to the context targets included in the segment. Returns an error if this causes the same context key to be both included and excluded. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### processBigSegmentImport For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Processes a segment import. ##### Parameters - `importId`: The ID of the import. The import ID is returned in the `Location` header as part of the [Create big segment import](https://launchdarkly.com/docs/api/segments/create-big-segment-import) request. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"processBigSegmentImport\", \"importId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" }] } ``` #### removeBigSegmentExcludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets excluded from the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentExcludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ``` #### removeBigSegmentIncludedTargets For use with [larger list-based segments](https://launchdarkly.com/docs/home/flags/segments-create#create-larger-list-based-segments) ONLY. Removes context keys from the context targets included in the segment. ##### Parameters - `values`: List of context keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeBigSegmentIncludedTargets\", \"values\": [ \"org-key-123abc\", \"org-key-456def\" ] }] } ```
### Using JSON patches on a segment If you do not include the header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. For example, to update the description for a segment with a JSON patch, use the following request body: ```json { \"patch\": [ { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"new description\" } ] } ``` To update fields in the segment that are arrays, set the `path` to the name of the field and then append `/`. Use `/0` to add the new entry to the beginning of the array. Use `/-` to add the new entry to the end of the array. For example, to add a rule to a segment, use the following request body: ```json { \"patch\":[ { \"op\": \"add\", \"path\": \"/rules/0\", \"value\": { \"clauses\": [{ \"contextKind\": \"user\", \"attribute\": \"email\", \"op\": \"endsWith\", \"values\": [\".edu\"], \"negate\": false }] } } ] } ``` To add or remove targets from segments, we recommend using semantic patch. Semantic patch for segments includes specific instructions for adding and removing both included and excluded targets. * @summary Patch segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {PatchWithComment} patchWithComment * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ patchSegment(projectKey: string, environmentKey: string, segmentKey: string, patchWithComment: PatchWithComment, options?: AxiosRequestConfig): Promise>; /** * Create a new segment. * @summary Create segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {SegmentBody} segmentBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ postSegment(projectKey: string, environmentKey: string, segmentBody: SegmentBody, options?: AxiosRequestConfig): Promise>; /** * Update context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ updateBigSegmentContextTargets(projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: AxiosRequestConfig): Promise>; /** * Update user context targets included or excluded in a big segment. Big segments include larger list-based segments and synced segments. This operation does not support standard segments. * @summary Update user context targets on a big segment * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} segmentKey The segment key * @param {SegmentUserState} segmentUserState * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SegmentsApi */ updateBigSegmentTargets(projectKey: string, environmentKey: string, segmentKey: string, segmentUserState: SegmentUserState, options?: AxiosRequestConfig): Promise>; } /** * TagsApi - axios parameter creator * @export */ export declare const TagsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of tags. * @summary List tags * @param {Array} [kind] Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`. Returns all types by default. * @param {string} [pre] Return tags with the specified prefix * @param {boolean} [archived] Whether or not to return archived flags * @param {number} [limit] The number of tags to return. Maximum is 1000. * @param {number} [offset] The index of the first tag to return. Default is 0. * @param {string} [asOf] The time to retrieve tags as of. Default is the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTags: (kind?: Array, pre?: string, archived?: boolean, limit?: number, offset?: number, asOf?: string, options?: AxiosRequestConfig) => Promise; }; /** * TagsApi - functional programming interface * @export */ export declare const TagsApiFp: (configuration?: Configuration) => { /** * Get a list of tags. * @summary List tags * @param {Array} [kind] Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`. Returns all types by default. * @param {string} [pre] Return tags with the specified prefix * @param {boolean} [archived] Whether or not to return archived flags * @param {number} [limit] The number of tags to return. Maximum is 1000. * @param {number} [offset] The index of the first tag to return. Default is 0. * @param {string} [asOf] The time to retrieve tags as of. Default is the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTags(kind?: Array, pre?: string, archived?: boolean, limit?: number, offset?: number, asOf?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TagsApi - factory interface * @export */ export declare const TagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of tags. * @summary List tags * @param {Array} [kind] Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`. Returns all types by default. * @param {string} [pre] Return tags with the specified prefix * @param {boolean} [archived] Whether or not to return archived flags * @param {number} [limit] The number of tags to return. Maximum is 1000. * @param {number} [offset] The index of the first tag to return. Default is 0. * @param {string} [asOf] The time to retrieve tags as of. Default is the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTags(kind?: Array, pre?: string, archived?: boolean, limit?: number, offset?: number, asOf?: string, options?: any): AxiosPromise; }; /** * TagsApi - object-oriented interface * @export * @class TagsApi * @extends {BaseAPI} */ export declare class TagsApi extends BaseAPI { /** * Get a list of tags. * @summary List tags * @param {Array} [kind] Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`. Returns all types by default. * @param {string} [pre] Return tags with the specified prefix * @param {boolean} [archived] Whether or not to return archived flags * @param {number} [limit] The number of tags to return. Maximum is 1000. * @param {number} [offset] The index of the first tag to return. Default is 0. * @param {string} [asOf] The time to retrieve tags as of. Default is the current time. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TagsApi */ getTags(kind?: Array, pre?: string, archived?: boolean, limit?: number, offset?: number, asOf?: string, options?: AxiosRequestConfig): Promise>; } /** * TeamsApi - axios parameter creator * @export */ export declare const TeamsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a team by key. To learn more, read [Deleting teams](https://launchdarkly.com/docs/home/account/delete-teams). * @summary Delete team * @param {string} teamKey The team key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeam: (teamKey: string, options?: AxiosRequestConfig) => Promise; /** * Fetch a team by key. ### Expanding the teams response LaunchDarkly supports several fields for expanding the \"Get team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Get team * @param {string} teamKey The team key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeam: (teamKey: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Fetch the maintainers that have been assigned to the team. To learn more, read [Managing team maintainers](https://launchdarkly.com/docs/home/account/team-maintainers). * @summary Get team maintainers * @param {string} teamKey The team key * @param {number} [limit] The number of maintainers to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeamMaintainers: (teamKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://launchdarkly.com/docs/home/account/team-permissions). * @summary Get team custom roles * @param {string} teamKey The team key * @param {number} [limit] The number of roles to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeamRoles: (teamKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Return a list of teams. By default, this returns the first 20 teams. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering teams LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the teams\' names and keys. It is not case-sensitive. - A request with `query:abc` returns teams with the string `abc` in their name or key. - `nomembers` is a boolean that filters the list of teams who have 0 members - A request with `nomembers:true` returns teams that have 0 members - A request with `nomembers:false` returns teams that have 1 or more members ### Expanding the teams response LaunchDarkly supports expanding several fields in the \"List teams\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,maintainers` includes the `members` and `maintainers` fields in the response. * @summary List teams * @param {number} [limit] The number of teams to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeams: (limit?: number, offset?: number, filter?: string, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Perform a partial update to a team. Updating a team uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams. Several of the instructions require one or more member IDs as parameters. The member ID is returned as part of the [List account members](https://launchdarkly.com/docs/ld-docs/api/account-members/get-members) response. It is the `_id` field of each element in the `items` array.
Click to expand instructions for updating teams #### addCustomRoles Adds custom roles to the team. Team members will have these custom roles granted to them. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### removeCustomRoles Removes custom roles from the team. The app will no longer grant these custom roles to the team members. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### addRoleAttribute Adds a role attribute to a team. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to add. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### updateRoleAttribute Updates a role attribute on the team. Any existing values for the given key will be replaced with the new values. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to update. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### removeRoleAttribute Removes a role attribute from the team. ##### Parameters - `key`: The role attribute key to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeRoleAttribute\", \"key\": \"testAttribute\" } ] } ``` #### addMembers Adds members to the team. ##### Parameters - `values`: List of member IDs to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removeMembers Removes members from the team. ##### Parameters - `values`: List of member IDs to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceMembers Replaces the existing members of the team with the new members. ##### Parameters - `values`: List of member IDs of the new members. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### addPermissionGrants Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addPermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removePermissionGrants Removes permission grants from members for the team. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The `actionSet` and `actions` must match an existing permission grant. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removePermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### updateDescription Updates the description of the team. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated team description\" }] } ``` #### updateName Updates the name of the team. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated team name\" }] } ```
### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Update team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Update team * @param {string} teamKey The team key * @param {TeamPatchInput} teamPatchInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTeam: (teamKey: string, teamPatchInput: TeamPatchInput, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Create a team. To learn more, read [Creating a team](https://launchdarkly.com/docs/home/account/create-teams). ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Create team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Create team * @param {TeamPostInput} teamPostInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTeam: (teamPostInput: TeamPostInput, expand?: string, options?: AxiosRequestConfig) => Promise; /** * Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read [Manage team members](https://launchdarkly.com/docs/home/account/manage-teams#manage-team-members). **Members are only added on a `201` response.** A `207` indicates the CSV file contains a combination of valid and invalid entries. A `207` results in no members being added to the team. On a `207` response, if an entry contains bad input, the `message` field contains the row number as well as the reason for the error. The `message` field is omitted if the entry is valid. Example `207` response: ```json { \"items\": [ { \"status\": \"success\", \"value\": \"new-team-member@acme.com\" }, { \"message\": \"Line 2: empty row\", \"status\": \"error\", \"value\": \"\" }, { \"message\": \"Line 3: email already exists in the specified team\", \"status\": \"error\", \"value\": \"existing-team-member@acme.com\" }, { \"message\": \"Line 4: invalid email formatting\", \"status\": \"error\", \"value\": \"invalid email format\" } ] } ``` Message | Resolution --- | --- Empty row | This line is blank. Add an email address and try again. Duplicate entry | This email address appears in the file twice. Remove the email from the file and try again. Email already exists in the specified team | This member is already on your team. Remove the email from the file and try again. Invalid formatting | This email address is not formatted correctly. Fix the formatting and try again. Email does not belong to a LaunchDarkly member | The email address doesn\'t belong to a LaunchDarkly account member. Invite them to LaunchDarkly, then re-add them to the team. On a `400` response, the `message` field may contain errors specific to this endpoint. Example `400` response: ```json { \"code\": \"invalid_request\", \"message\": \"Unable to process file\" } ``` Message | Resolution --- | --- Unable to process file | LaunchDarkly could not process the file for an unspecified reason. Review your file for errors and try again. File exceeds 25mb | Break up your file into multiple files of less than 25mbs each. All emails have invalid formatting | None of the email addresses in the file are in the correct format. Fix the formatting and try again. All emails belong to existing team members | All listed members are already on this team. Populate the file with member emails that do not belong to the team and try again. File is empty | The CSV file does not contain any email addresses. Populate the file and try again. No emails belong to members of your LaunchDarkly organization | None of the email addresses belong to members of your LaunchDarkly account. Invite these members to LaunchDarkly, then re-add them to the team. * @summary Add multiple members to team * @param {string} teamKey The team key * @param {any} [file] CSV file containing email addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTeamMembers: (teamKey: string, file?: any, options?: AxiosRequestConfig) => Promise; }; /** * TeamsApi - functional programming interface * @export */ export declare const TeamsApiFp: (configuration?: Configuration) => { /** * Delete a team by key. To learn more, read [Deleting teams](https://launchdarkly.com/docs/home/account/delete-teams). * @summary Delete team * @param {string} teamKey The team key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeam(teamKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch a team by key. ### Expanding the teams response LaunchDarkly supports several fields for expanding the \"Get team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Get team * @param {string} teamKey The team key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeam(teamKey: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch the maintainers that have been assigned to the team. To learn more, read [Managing team maintainers](https://launchdarkly.com/docs/home/account/team-maintainers). * @summary Get team maintainers * @param {string} teamKey The team key * @param {number} [limit] The number of maintainers to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeamMaintainers(teamKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://launchdarkly.com/docs/home/account/team-permissions). * @summary Get team custom roles * @param {string} teamKey The team key * @param {number} [limit] The number of roles to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeamRoles(teamKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return a list of teams. By default, this returns the first 20 teams. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering teams LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the teams\' names and keys. It is not case-sensitive. - A request with `query:abc` returns teams with the string `abc` in their name or key. - `nomembers` is a boolean that filters the list of teams who have 0 members - A request with `nomembers:true` returns teams that have 0 members - A request with `nomembers:false` returns teams that have 1 or more members ### Expanding the teams response LaunchDarkly supports expanding several fields in the \"List teams\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,maintainers` includes the `members` and `maintainers` fields in the response. * @summary List teams * @param {number} [limit] The number of teams to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeams(limit?: number, offset?: number, filter?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Perform a partial update to a team. Updating a team uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams. Several of the instructions require one or more member IDs as parameters. The member ID is returned as part of the [List account members](https://launchdarkly.com/docs/ld-docs/api/account-members/get-members) response. It is the `_id` field of each element in the `items` array.
Click to expand instructions for updating teams #### addCustomRoles Adds custom roles to the team. Team members will have these custom roles granted to them. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### removeCustomRoles Removes custom roles from the team. The app will no longer grant these custom roles to the team members. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### addRoleAttribute Adds a role attribute to a team. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to add. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### updateRoleAttribute Updates a role attribute on the team. Any existing values for the given key will be replaced with the new values. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to update. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### removeRoleAttribute Removes a role attribute from the team. ##### Parameters - `key`: The role attribute key to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeRoleAttribute\", \"key\": \"testAttribute\" } ] } ``` #### addMembers Adds members to the team. ##### Parameters - `values`: List of member IDs to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removeMembers Removes members from the team. ##### Parameters - `values`: List of member IDs to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceMembers Replaces the existing members of the team with the new members. ##### Parameters - `values`: List of member IDs of the new members. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### addPermissionGrants Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addPermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removePermissionGrants Removes permission grants from members for the team. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The `actionSet` and `actions` must match an existing permission grant. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removePermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### updateDescription Updates the description of the team. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated team description\" }] } ``` #### updateName Updates the name of the team. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated team name\" }] } ```
### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Update team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Update team * @param {string} teamKey The team key * @param {TeamPatchInput} teamPatchInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTeam(teamKey: string, teamPatchInput: TeamPatchInput, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a team. To learn more, read [Creating a team](https://launchdarkly.com/docs/home/account/create-teams). ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Create team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Create team * @param {TeamPostInput} teamPostInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTeam(teamPostInput: TeamPostInput, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read [Manage team members](https://launchdarkly.com/docs/home/account/manage-teams#manage-team-members). **Members are only added on a `201` response.** A `207` indicates the CSV file contains a combination of valid and invalid entries. A `207` results in no members being added to the team. On a `207` response, if an entry contains bad input, the `message` field contains the row number as well as the reason for the error. The `message` field is omitted if the entry is valid. Example `207` response: ```json { \"items\": [ { \"status\": \"success\", \"value\": \"new-team-member@acme.com\" }, { \"message\": \"Line 2: empty row\", \"status\": \"error\", \"value\": \"\" }, { \"message\": \"Line 3: email already exists in the specified team\", \"status\": \"error\", \"value\": \"existing-team-member@acme.com\" }, { \"message\": \"Line 4: invalid email formatting\", \"status\": \"error\", \"value\": \"invalid email format\" } ] } ``` Message | Resolution --- | --- Empty row | This line is blank. Add an email address and try again. Duplicate entry | This email address appears in the file twice. Remove the email from the file and try again. Email already exists in the specified team | This member is already on your team. Remove the email from the file and try again. Invalid formatting | This email address is not formatted correctly. Fix the formatting and try again. Email does not belong to a LaunchDarkly member | The email address doesn\'t belong to a LaunchDarkly account member. Invite them to LaunchDarkly, then re-add them to the team. On a `400` response, the `message` field may contain errors specific to this endpoint. Example `400` response: ```json { \"code\": \"invalid_request\", \"message\": \"Unable to process file\" } ``` Message | Resolution --- | --- Unable to process file | LaunchDarkly could not process the file for an unspecified reason. Review your file for errors and try again. File exceeds 25mb | Break up your file into multiple files of less than 25mbs each. All emails have invalid formatting | None of the email addresses in the file are in the correct format. Fix the formatting and try again. All emails belong to existing team members | All listed members are already on this team. Populate the file with member emails that do not belong to the team and try again. File is empty | The CSV file does not contain any email addresses. Populate the file and try again. No emails belong to members of your LaunchDarkly organization | None of the email addresses belong to members of your LaunchDarkly account. Invite these members to LaunchDarkly, then re-add them to the team. * @summary Add multiple members to team * @param {string} teamKey The team key * @param {any} [file] CSV file containing email addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTeamMembers(teamKey: string, file?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TeamsApi - factory interface * @export */ export declare const TeamsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a team by key. To learn more, read [Deleting teams](https://launchdarkly.com/docs/home/account/delete-teams). * @summary Delete team * @param {string} teamKey The team key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeam(teamKey: string, options?: any): AxiosPromise; /** * Fetch a team by key. ### Expanding the teams response LaunchDarkly supports several fields for expanding the \"Get team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Get team * @param {string} teamKey The team key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeam(teamKey: string, expand?: string, options?: any): AxiosPromise; /** * Fetch the maintainers that have been assigned to the team. To learn more, read [Managing team maintainers](https://launchdarkly.com/docs/home/account/team-maintainers). * @summary Get team maintainers * @param {string} teamKey The team key * @param {number} [limit] The number of maintainers to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeamMaintainers(teamKey: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://launchdarkly.com/docs/home/account/team-permissions). * @summary Get team custom roles * @param {string} teamKey The team key * @param {number} [limit] The number of roles to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeamRoles(teamKey: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Return a list of teams. By default, this returns the first 20 teams. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering teams LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the teams\' names and keys. It is not case-sensitive. - A request with `query:abc` returns teams with the string `abc` in their name or key. - `nomembers` is a boolean that filters the list of teams who have 0 members - A request with `nomembers:true` returns teams that have 0 members - A request with `nomembers:false` returns teams that have 1 or more members ### Expanding the teams response LaunchDarkly supports expanding several fields in the \"List teams\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,maintainers` includes the `members` and `maintainers` fields in the response. * @summary List teams * @param {number} [limit] The number of teams to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeams(limit?: number, offset?: number, filter?: string, expand?: string, options?: any): AxiosPromise; /** * Perform a partial update to a team. Updating a team uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams. Several of the instructions require one or more member IDs as parameters. The member ID is returned as part of the [List account members](https://launchdarkly.com/docs/ld-docs/api/account-members/get-members) response. It is the `_id` field of each element in the `items` array.
Click to expand instructions for updating teams #### addCustomRoles Adds custom roles to the team. Team members will have these custom roles granted to them. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### removeCustomRoles Removes custom roles from the team. The app will no longer grant these custom roles to the team members. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### addRoleAttribute Adds a role attribute to a team. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to add. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### updateRoleAttribute Updates a role attribute on the team. Any existing values for the given key will be replaced with the new values. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to update. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### removeRoleAttribute Removes a role attribute from the team. ##### Parameters - `key`: The role attribute key to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeRoleAttribute\", \"key\": \"testAttribute\" } ] } ``` #### addMembers Adds members to the team. ##### Parameters - `values`: List of member IDs to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removeMembers Removes members from the team. ##### Parameters - `values`: List of member IDs to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceMembers Replaces the existing members of the team with the new members. ##### Parameters - `values`: List of member IDs of the new members. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### addPermissionGrants Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addPermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removePermissionGrants Removes permission grants from members for the team. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The `actionSet` and `actions` must match an existing permission grant. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removePermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### updateDescription Updates the description of the team. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated team description\" }] } ``` #### updateName Updates the name of the team. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated team name\" }] } ```
### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Update team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Update team * @param {string} teamKey The team key * @param {TeamPatchInput} teamPatchInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTeam(teamKey: string, teamPatchInput: TeamPatchInput, expand?: string, options?: any): AxiosPromise; /** * Create a team. To learn more, read [Creating a team](https://launchdarkly.com/docs/home/account/create-teams). ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Create team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Create team * @param {TeamPostInput} teamPostInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTeam(teamPostInput: TeamPostInput, expand?: string, options?: any): AxiosPromise; /** * Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read [Manage team members](https://launchdarkly.com/docs/home/account/manage-teams#manage-team-members). **Members are only added on a `201` response.** A `207` indicates the CSV file contains a combination of valid and invalid entries. A `207` results in no members being added to the team. On a `207` response, if an entry contains bad input, the `message` field contains the row number as well as the reason for the error. The `message` field is omitted if the entry is valid. Example `207` response: ```json { \"items\": [ { \"status\": \"success\", \"value\": \"new-team-member@acme.com\" }, { \"message\": \"Line 2: empty row\", \"status\": \"error\", \"value\": \"\" }, { \"message\": \"Line 3: email already exists in the specified team\", \"status\": \"error\", \"value\": \"existing-team-member@acme.com\" }, { \"message\": \"Line 4: invalid email formatting\", \"status\": \"error\", \"value\": \"invalid email format\" } ] } ``` Message | Resolution --- | --- Empty row | This line is blank. Add an email address and try again. Duplicate entry | This email address appears in the file twice. Remove the email from the file and try again. Email already exists in the specified team | This member is already on your team. Remove the email from the file and try again. Invalid formatting | This email address is not formatted correctly. Fix the formatting and try again. Email does not belong to a LaunchDarkly member | The email address doesn\'t belong to a LaunchDarkly account member. Invite them to LaunchDarkly, then re-add them to the team. On a `400` response, the `message` field may contain errors specific to this endpoint. Example `400` response: ```json { \"code\": \"invalid_request\", \"message\": \"Unable to process file\" } ``` Message | Resolution --- | --- Unable to process file | LaunchDarkly could not process the file for an unspecified reason. Review your file for errors and try again. File exceeds 25mb | Break up your file into multiple files of less than 25mbs each. All emails have invalid formatting | None of the email addresses in the file are in the correct format. Fix the formatting and try again. All emails belong to existing team members | All listed members are already on this team. Populate the file with member emails that do not belong to the team and try again. File is empty | The CSV file does not contain any email addresses. Populate the file and try again. No emails belong to members of your LaunchDarkly organization | None of the email addresses belong to members of your LaunchDarkly account. Invite these members to LaunchDarkly, then re-add them to the team. * @summary Add multiple members to team * @param {string} teamKey The team key * @param {any} [file] CSV file containing email addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTeamMembers(teamKey: string, file?: any, options?: any): AxiosPromise; }; /** * TeamsApi - object-oriented interface * @export * @class TeamsApi * @extends {BaseAPI} */ export declare class TeamsApi extends BaseAPI { /** * Delete a team by key. To learn more, read [Deleting teams](https://launchdarkly.com/docs/home/account/delete-teams). * @summary Delete team * @param {string} teamKey The team key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ deleteTeam(teamKey: string, options?: AxiosRequestConfig): Promise>; /** * Fetch a team by key. ### Expanding the teams response LaunchDarkly supports several fields for expanding the \"Get team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Get team * @param {string} teamKey The team key. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ getTeam(teamKey: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Fetch the maintainers that have been assigned to the team. To learn more, read [Managing team maintainers](https://launchdarkly.com/docs/home/account/team-maintainers). * @summary Get team maintainers * @param {string} teamKey The team key * @param {number} [limit] The number of maintainers to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ getTeamMaintainers(teamKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://launchdarkly.com/docs/home/account/team-permissions). * @summary Get team custom roles * @param {string} teamKey The team key * @param {number} [limit] The number of roles to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ getTeamRoles(teamKey: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Return a list of teams. By default, this returns the first 20 teams. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don\'t exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering teams LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the teams\' names and keys. It is not case-sensitive. - A request with `query:abc` returns teams with the string `abc` in their name or key. - `nomembers` is a boolean that filters the list of teams who have 0 members - A request with `nomembers:true` returns teams that have 0 members - A request with `nomembers:false` returns teams that have 1 or more members ### Expanding the teams response LaunchDarkly supports expanding several fields in the \"List teams\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `roleAttributes` includes a list of the role attributes that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,maintainers` includes the `members` and `maintainers` fields in the response. * @summary List teams * @param {number} [limit] The number of teams to return in the response. Defaults to 20. * @param {number} [offset] Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. * @param {string} [filter] A comma-separated list of filters. Each filter is constructed as `field:value`. * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ getTeams(limit?: number, offset?: number, filter?: string, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Perform a partial update to a team. Updating a team uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams. Several of the instructions require one or more member IDs as parameters. The member ID is returned as part of the [List account members](https://launchdarkly.com/docs/ld-docs/api/account-members/get-members) response. It is the `_id` field of each element in the `items` array.
Click to expand instructions for updating teams #### addCustomRoles Adds custom roles to the team. Team members will have these custom roles granted to them. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### removeCustomRoles Removes custom roles from the team. The app will no longer grant these custom roles to the team members. ##### Parameters - `values`: List of custom role keys. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeCustomRoles\", \"values\": [ \"example-custom-role\" ] }] } ``` #### addRoleAttribute Adds a role attribute to a team. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to add. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"addRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### updateRoleAttribute Updates a role attribute on the team. Any existing values for the given key will be replaced with the new values. Team members will have these role attribute values scoped for all custom roles granted to them. ##### Parameters - `key`: The role attribute key to update. - `values`: List of role attribute values for that key. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"updateRoleAttribute\", \"key\": \"testAttribute\", \"values\": [\"someNewValue\", \"someOtherNewValue\"] } ] } ``` #### removeRoleAttribute Removes a role attribute from the team. ##### Parameters - `key`: The role attribute key to remove. Here\'s an example: ```json { \"instructions\": [ { \"kind\": \"removeRoleAttribute\", \"key\": \"testAttribute\" } ] } ``` #### addMembers Adds members to the team. ##### Parameters - `values`: List of member IDs to add. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removeMembers Removes members from the team. ##### Parameters - `values`: List of member IDs to remove. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removeMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceMembers Replaces the existing members of the team with the new members. ##### Parameters - `values`: List of member IDs of the new members. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembers\", \"values\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### addPermissionGrants Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addPermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### removePermissionGrants Removes permission grants from members for the team. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The `actionSet` and `actions` must match an existing permission grant. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"removePermissionGrants\", \"actions\": [ \"updateTeamName\", \"updateTeamDescription\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### updateDescription Updates the description of the team. ##### Parameters - `value`: The new description. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated team description\" }] } ``` #### updateName Updates the name of the team. ##### Parameters - `value`: The new name. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"updateName\", \"value\": \"Updated team name\" }] } ```
### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Update team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Update team * @param {string} teamKey The team key * @param {TeamPatchInput} teamPatchInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ patchTeam(teamKey: string, teamPatchInput: TeamPatchInput, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Create a team. To learn more, read [Creating a team](https://launchdarkly.com/docs/home/account/create-teams). ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Create team\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response. * @summary Create team * @param {TeamPostInput} teamPostInput * @param {string} [expand] A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ postTeam(teamPostInput: TeamPostInput, expand?: string, options?: AxiosRequestConfig): Promise>; /** * Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read [Manage team members](https://launchdarkly.com/docs/home/account/manage-teams#manage-team-members). **Members are only added on a `201` response.** A `207` indicates the CSV file contains a combination of valid and invalid entries. A `207` results in no members being added to the team. On a `207` response, if an entry contains bad input, the `message` field contains the row number as well as the reason for the error. The `message` field is omitted if the entry is valid. Example `207` response: ```json { \"items\": [ { \"status\": \"success\", \"value\": \"new-team-member@acme.com\" }, { \"message\": \"Line 2: empty row\", \"status\": \"error\", \"value\": \"\" }, { \"message\": \"Line 3: email already exists in the specified team\", \"status\": \"error\", \"value\": \"existing-team-member@acme.com\" }, { \"message\": \"Line 4: invalid email formatting\", \"status\": \"error\", \"value\": \"invalid email format\" } ] } ``` Message | Resolution --- | --- Empty row | This line is blank. Add an email address and try again. Duplicate entry | This email address appears in the file twice. Remove the email from the file and try again. Email already exists in the specified team | This member is already on your team. Remove the email from the file and try again. Invalid formatting | This email address is not formatted correctly. Fix the formatting and try again. Email does not belong to a LaunchDarkly member | The email address doesn\'t belong to a LaunchDarkly account member. Invite them to LaunchDarkly, then re-add them to the team. On a `400` response, the `message` field may contain errors specific to this endpoint. Example `400` response: ```json { \"code\": \"invalid_request\", \"message\": \"Unable to process file\" } ``` Message | Resolution --- | --- Unable to process file | LaunchDarkly could not process the file for an unspecified reason. Review your file for errors and try again. File exceeds 25mb | Break up your file into multiple files of less than 25mbs each. All emails have invalid formatting | None of the email addresses in the file are in the correct format. Fix the formatting and try again. All emails belong to existing team members | All listed members are already on this team. Populate the file with member emails that do not belong to the team and try again. File is empty | The CSV file does not contain any email addresses. Populate the file and try again. No emails belong to members of your LaunchDarkly organization | None of the email addresses belong to members of your LaunchDarkly account. Invite these members to LaunchDarkly, then re-add them to the team. * @summary Add multiple members to team * @param {string} teamKey The team key * @param {any} [file] CSV file containing email addresses * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsApi */ postTeamMembers(teamKey: string, file?: any, options?: AxiosRequestConfig): Promise>; } /** * TeamsBetaApi - axios parameter creator * @export */ export declare const TeamsBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Perform a partial update to multiple teams. Updating teams uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams.
Click to expand instructions for updating teams #### addMembersToTeams Add the members to teams. ##### Parameters - `memberIDs`: List of member IDs to add. - `teamKeys`: List of teams to update. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembersToTeams\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\" ], \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ] }] } ``` #### addAllMembersToTeams Add all members to the team. Members that match any of the filters are **excluded** from the update. ##### Parameters - `teamKeys`: List of teams to update. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addAllMembersToTeams\", \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ], \"filterLastSeen\": { \"never\": true } }] } ```
* @summary Update teams * @param {TeamsPatchInput} teamsPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTeams: (teamsPatchInput: TeamsPatchInput, options?: AxiosRequestConfig) => Promise; }; /** * TeamsBetaApi - functional programming interface * @export */ export declare const TeamsBetaApiFp: (configuration?: Configuration) => { /** * Perform a partial update to multiple teams. Updating teams uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams.
Click to expand instructions for updating teams #### addMembersToTeams Add the members to teams. ##### Parameters - `memberIDs`: List of member IDs to add. - `teamKeys`: List of teams to update. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembersToTeams\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\" ], \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ] }] } ``` #### addAllMembersToTeams Add all members to the team. Members that match any of the filters are **excluded** from the update. ##### Parameters - `teamKeys`: List of teams to update. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addAllMembersToTeams\", \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ], \"filterLastSeen\": { \"never\": true } }] } ```
* @summary Update teams * @param {TeamsPatchInput} teamsPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTeams(teamsPatchInput: TeamsPatchInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TeamsBetaApi - factory interface * @export */ export declare const TeamsBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Perform a partial update to multiple teams. Updating teams uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams.
Click to expand instructions for updating teams #### addMembersToTeams Add the members to teams. ##### Parameters - `memberIDs`: List of member IDs to add. - `teamKeys`: List of teams to update. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembersToTeams\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\" ], \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ] }] } ``` #### addAllMembersToTeams Add all members to the team. Members that match any of the filters are **excluded** from the update. ##### Parameters - `teamKeys`: List of teams to update. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addAllMembersToTeams\", \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ], \"filterLastSeen\": { \"never\": true } }] } ```
* @summary Update teams * @param {TeamsPatchInput} teamsPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchTeams(teamsPatchInput: TeamsPatchInput, options?: any): AxiosPromise; }; /** * TeamsBetaApi - object-oriented interface * @export * @class TeamsBetaApi * @extends {BaseAPI} */ export declare class TeamsBetaApi extends BaseAPI { /** * Perform a partial update to multiple teams. Updating teams uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams.
Click to expand instructions for updating teams #### addMembersToTeams Add the members to teams. ##### Parameters - `memberIDs`: List of member IDs to add. - `teamKeys`: List of teams to update. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addMembersToTeams\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\" ], \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ] }] } ``` #### addAllMembersToTeams Add all members to the team. Members that match any of the filters are **excluded** from the update. ##### Parameters - `teamKeys`: List of teams to update. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members\' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here\'s an example: ```json { \"instructions\": [{ \"kind\": \"addAllMembersToTeams\", \"teamKeys\": [ \"example-team-1\", \"example-team-2\" ], \"filterLastSeen\": { \"never\": true } }] } ```
* @summary Update teams * @param {TeamsPatchInput} teamsPatchInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TeamsBetaApi */ patchTeams(teamsPatchInput: TeamsPatchInput, options?: AxiosRequestConfig): Promise>; } /** * UserSettingsApi - axios parameter creator * @export */ export declare const UserSettingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of flags for which the given user is scheduled for removal. * @summary Get expiring dates on flags for user * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExpiringFlagsForUser: (projectKey: string, userKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; /** * Get a single flag setting for a user by flag key.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled. * @summary Get flag setting for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserFlagSetting: (projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, options?: AxiosRequestConfig) => Promise; /** * Get the current flag settings for a given user.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled and the `alternate.page` flag disabled, and that the user has not been explicitly targeted to receive a particular variation. * @summary List flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserFlagSettings: (projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig) => Promise; /** * Schedule the specified user for removal from individual targeting on one or more flags. The user must already be individually targeted for each flag. You can add, update, or remove a scheduled removal date. You can only schedule a user for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. * `version`: The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until explicitly removed, or until another removal is scheduled. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag
* @summary Update expiring user target for flags * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {PatchUsersRequest} patchUsersRequest * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ patchExpiringFlagsForUser: (projectKey: string, userKey: string, environmentKey: string, patchUsersRequest: PatchUsersRequest, options?: AxiosRequestConfig) => Promise; /** * Enable or disable a feature flag for a user based on their key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a user. If you previously patched the flag, and the patch included the user\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user\'s key before, it calculates the flag values based on the user key alone. * @summary Update flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ putFlagSetting: (projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, valuePut: ValuePut, options?: AxiosRequestConfig) => Promise; }; /** * UserSettingsApi - functional programming interface * @export */ export declare const UserSettingsApiFp: (configuration?: Configuration) => { /** * Get a list of flags for which the given user is scheduled for removal. * @summary Get expiring dates on flags for user * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExpiringFlagsForUser(projectKey: string, userKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single flag setting for a user by flag key.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled. * @summary Get flag setting for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserFlagSetting(projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the current flag settings for a given user.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled and the `alternate.page` flag disabled, and that the user has not been explicitly targeted to receive a particular variation. * @summary List flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserFlagSettings(projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Schedule the specified user for removal from individual targeting on one or more flags. The user must already be individually targeted for each flag. You can add, update, or remove a scheduled removal date. You can only schedule a user for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. * `version`: The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until explicitly removed, or until another removal is scheduled. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag
* @summary Update expiring user target for flags * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {PatchUsersRequest} patchUsersRequest * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ patchExpiringFlagsForUser(projectKey: string, userKey: string, environmentKey: string, patchUsersRequest: PatchUsersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Enable or disable a feature flag for a user based on their key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a user. If you previously patched the flag, and the patch included the user\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user\'s key before, it calculates the flag values based on the user key alone. * @summary Update flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ putFlagSetting(projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, valuePut: ValuePut, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserSettingsApi - factory interface * @export */ export declare const UserSettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of flags for which the given user is scheduled for removal. * @summary Get expiring dates on flags for user * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getExpiringFlagsForUser(projectKey: string, userKey: string, environmentKey: string, options?: any): AxiosPromise; /** * Get a single flag setting for a user by flag key.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled. * @summary Get flag setting for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserFlagSetting(projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, options?: any): AxiosPromise; /** * Get the current flag settings for a given user.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled and the `alternate.page` flag disabled, and that the user has not been explicitly targeted to receive a particular variation. * @summary List flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserFlagSettings(projectKey: string, environmentKey: string, userKey: string, options?: any): AxiosPromise; /** * Schedule the specified user for removal from individual targeting on one or more flags. The user must already be individually targeted for each flag. You can add, update, or remove a scheduled removal date. You can only schedule a user for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. * `version`: The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until explicitly removed, or until another removal is scheduled. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag
* @summary Update expiring user target for flags * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {PatchUsersRequest} patchUsersRequest * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ patchExpiringFlagsForUser(projectKey: string, userKey: string, environmentKey: string, patchUsersRequest: PatchUsersRequest, options?: any): AxiosPromise; /** * Enable or disable a feature flag for a user based on their key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a user. If you previously patched the flag, and the patch included the user\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user\'s key before, it calculates the flag values based on the user key alone. * @summary Update flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ putFlagSetting(projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, valuePut: ValuePut, options?: any): AxiosPromise; }; /** * UserSettingsApi - object-oriented interface * @export * @class UserSettingsApi * @extends {BaseAPI} */ export declare class UserSettingsApi extends BaseAPI { /** * Get a list of flags for which the given user is scheduled for removal. * @summary Get expiring dates on flags for user * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UserSettingsApi */ getExpiringFlagsForUser(projectKey: string, userKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; /** * Get a single flag setting for a user by flag key.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled. * @summary Get flag setting for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UserSettingsApi */ getUserFlagSetting(projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, options?: AxiosRequestConfig): Promise>; /** * Get the current flag settings for a given user.

The `_value` is the flag variation that the user receives. The `setting` indicates whether you\'ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled and the `alternate.page` flag disabled, and that the user has not been explicitly targeted to receive a particular variation. * @summary List flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UserSettingsApi */ getUserFlagSettings(projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise>; /** * Schedule the specified user for removal from individual targeting on one or more flags. The user must already be individually targeted for each flag. You can add, update, or remove a scheduled removal date. You can only schedule a user for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating expiring user targets.
Click to expand instructions for updating expiring user targets #### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag\'s individual targeting. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag * `value`: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. * `version`: The version of the expiring user target to update. If included, update will fail if version doesn\'t match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag\'s individual targeting. The user will remain part of the flag\'s individual targeting until explicitly removed, or until another removal is scheduled. ##### Parameters * `flagKey`: The flag key * `variationId`: ID of a variation on the flag
* @summary Update expiring user target for flags * @param {string} projectKey The project key * @param {string} userKey The user key * @param {string} environmentKey The environment key * @param {PatchUsersRequest} patchUsersRequest * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UserSettingsApi */ patchExpiringFlagsForUser(projectKey: string, userKey: string, environmentKey: string, patchUsersRequest: PatchUsersRequest, options?: AxiosRequestConfig): Promise>; /** * Enable or disable a feature flag for a user based on their key. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a user. If you previously patched the flag, and the patch included the user\'s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user\'s key before, it calculates the flag values based on the user key alone. * @summary Update flag settings for user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {string} featureFlagKey The feature flag key * @param {ValuePut} valuePut * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UserSettingsApi */ putFlagSetting(projectKey: string, environmentKey: string, userKey: string, featureFlagKey: string, valuePut: ValuePut, options?: AxiosRequestConfig): Promise>; } /** * UsersApi - axios parameter creator * @export */ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Delete context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/delete-context-instances) instead of this endpoint. Delete a user by key. * @summary Delete user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ deleteUser: (projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig) => Promise; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/search-context-instances) instead of this endpoint. Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query. An example user attribute filter set is `filter=firstName:Anna,activeTrial:false`. This matches users that have the user attribute `firstName` set to `Anna`, that also have the attribute `activeTrial` set to `false`. To paginate through results, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary Find users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [q] Full-text search for users based on name, first name, last name, e-mail address, or key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {number} [offset] Deprecated, use `searchAfter` instead. Specifies the first item to return in the collection. * @param {number} [after] A Unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {string} [filter] A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getSearchUsers: (projectKey: string, environmentKey: string, q?: string, limit?: number, offset?: number, after?: number, sort?: string, searchAfter?: string, filter?: string, options?: AxiosRequestConfig) => Promise; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-instances) instead of this endpoint. Get a user by key. The `user` object contains all attributes sent in `variation` calls for that key. * @summary Get user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUser: (projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig) => Promise; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for contexts](https://launchdarkly.com/docs/ld-docs/api/contexts/search-contexts) instead of this endpoint. List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis. Each page displays users up to a set `limit`. The default is 20. To page through, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary List users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of elements to return per page * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUsers: (projectKey: string, environmentKey: string, limit?: number, searchAfter?: string, options?: AxiosRequestConfig) => Promise; }; /** * UsersApi - functional programming interface * @export */ export declare const UsersApiFp: (configuration?: Configuration) => { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Delete context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/delete-context-instances) instead of this endpoint. Delete a user by key. * @summary Delete user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ deleteUser(projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/search-context-instances) instead of this endpoint. Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query. An example user attribute filter set is `filter=firstName:Anna,activeTrial:false`. This matches users that have the user attribute `firstName` set to `Anna`, that also have the attribute `activeTrial` set to `false`. To paginate through results, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary Find users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [q] Full-text search for users based on name, first name, last name, e-mail address, or key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {number} [offset] Deprecated, use `searchAfter` instead. Specifies the first item to return in the collection. * @param {number} [after] A Unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {string} [filter] A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getSearchUsers(projectKey: string, environmentKey: string, q?: string, limit?: number, offset?: number, after?: number, sort?: string, searchAfter?: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-instances) instead of this endpoint. Get a user by key. The `user` object contains all attributes sent in `variation` calls for that key. * @summary Get user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUser(projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for contexts](https://launchdarkly.com/docs/ld-docs/api/contexts/search-contexts) instead of this endpoint. List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis. Each page displays users up to a set `limit`. The default is 20. To page through, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary List users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of elements to return per page * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUsers(projectKey: string, environmentKey: string, limit?: number, searchAfter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersApi - factory interface * @export */ export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Delete context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/delete-context-instances) instead of this endpoint. Delete a user by key. * @summary Delete user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ deleteUser(projectKey: string, environmentKey: string, userKey: string, options?: any): AxiosPromise; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/search-context-instances) instead of this endpoint. Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query. An example user attribute filter set is `filter=firstName:Anna,activeTrial:false`. This matches users that have the user attribute `firstName` set to `Anna`, that also have the attribute `activeTrial` set to `false`. To paginate through results, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary Find users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [q] Full-text search for users based on name, first name, last name, e-mail address, or key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {number} [offset] Deprecated, use `searchAfter` instead. Specifies the first item to return in the collection. * @param {number} [after] A Unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {string} [filter] A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getSearchUsers(projectKey: string, environmentKey: string, q?: string, limit?: number, offset?: number, after?: number, sort?: string, searchAfter?: string, filter?: string, options?: any): AxiosPromise; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-instances) instead of this endpoint. Get a user by key. The `user` object contains all attributes sent in `variation` calls for that key. * @summary Get user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUser(projectKey: string, environmentKey: string, userKey: string, options?: any): AxiosPromise; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for contexts](https://launchdarkly.com/docs/ld-docs/api/contexts/search-contexts) instead of this endpoint. List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis. Each page displays users up to a set `limit`. The default is 20. To page through, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary List users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of elements to return per page * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUsers(projectKey: string, environmentKey: string, limit?: number, searchAfter?: string, options?: any): AxiosPromise; }; /** * UsersApi - object-oriented interface * @export * @class UsersApi * @extends {BaseAPI} */ export declare class UsersApi extends BaseAPI { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Delete context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/delete-context-instances) instead of this endpoint. Delete a user by key. * @summary Delete user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UsersApi */ deleteUser(projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise>; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/search-context-instances) instead of this endpoint. Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query. An example user attribute filter set is `filter=firstName:Anna,activeTrial:false`. This matches users that have the user attribute `firstName` set to `Anna`, that also have the attribute `activeTrial` set to `false`. To paginate through results, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary Find users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} [q] Full-text search for users based on name, first name, last name, e-mail address, or key * @param {number} [limit] Specifies the maximum number of items in the collection to return (max: 50, default: 20) * @param {number} [offset] Deprecated, use `searchAfter` instead. Specifies the first item to return in the collection. * @param {number} [after] A Unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly * @param {string} [sort] Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {string} [filter] A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UsersApi */ getSearchUsers(projectKey: string, environmentKey: string, q?: string, limit?: number, offset?: number, after?: number, sort?: string, searchAfter?: string, filter?: string, options?: AxiosRequestConfig): Promise>; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context instances](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-instances) instead of this endpoint. Get a user by key. The `user` object contains all attributes sent in `variation` calls for that key. * @summary Get user * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {string} userKey The user key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UsersApi */ getUser(projectKey: string, environmentKey: string, userKey: string, options?: AxiosRequestConfig): Promise>; /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Search for contexts](https://launchdarkly.com/docs/ld-docs/api/contexts/search-contexts) instead of this endpoint. List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis. Each page displays users up to a set `limit`. The default is 20. To page through, follow the `next` link in the `_links` object. To learn more, read [Representations](https://launchdarkly.com/docs/ld-docs/api#representations). * @summary List users * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {number} [limit] The number of elements to return per page * @param {string} [searchAfter] Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UsersApi */ getUsers(projectKey: string, environmentKey: string, limit?: number, searchAfter?: string, options?: AxiosRequestConfig): Promise>; } /** * UsersBetaApi - axios parameter creator * @export */ export declare const UsersBetaApiAxiosParamCreator: (configuration?: Configuration) => { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context attribute names ](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-attribute-names) instead of this endpoint. Get all in-use user attributes in the specified environment. The set of in-use attributes typically consists of all attributes seen within the past 30 days. * @summary Get user attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserAttributeNames: (projectKey: string, environmentKey: string, options?: AxiosRequestConfig) => Promise; }; /** * UsersBetaApi - functional programming interface * @export */ export declare const UsersBetaApiFp: (configuration?: Configuration) => { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context attribute names ](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-attribute-names) instead of this endpoint. Get all in-use user attributes in the specified environment. The set of in-use attributes typically consists of all attributes seen within the past 30 days. * @summary Get user attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserAttributeNames(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersBetaApi - factory interface * @export */ export declare const UsersBetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context attribute names ](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-attribute-names) instead of this endpoint. Get all in-use user attributes in the specified environment. The set of in-use attributes typically consists of all attributes seen within the past 30 days. * @summary Get user attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getUserAttributeNames(projectKey: string, environmentKey: string, options?: any): AxiosPromise; }; /** * UsersBetaApi - object-oriented interface * @export * @class UsersBetaApi * @extends {BaseAPI} */ export declare class UsersBetaApi extends BaseAPI { /** * > ### Use contexts instead > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use [Get context attribute names ](https://launchdarkly.com/docs/ld-docs/api/contexts/get-context-attribute-names) instead of this endpoint. Get all in-use user attributes in the specified environment. The set of in-use attributes typically consists of all attributes seen within the past 30 days. * @summary Get user attribute names * @param {string} projectKey The project key * @param {string} environmentKey The environment key * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UsersBetaApi */ getUserAttributeNames(projectKey: string, environmentKey: string, options?: AxiosRequestConfig): Promise>; } /** * WebhooksApi - axios parameter creator * @export */ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a webhook by ID. * @summary Delete webhook * @param {string} id The ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook: (id: string, options?: AxiosRequestConfig) => Promise; /** * Fetch a list of all webhooks. * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllWebhooks: (options?: AxiosRequestConfig) => Promise; /** * Get a single webhook by ID. * @summary Get webhook * @param {string} id The ID of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook: (id: string, options?: AxiosRequestConfig) => Promise; /** * Update a webhook\'s settings. Updating webhook settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update webhook * @param {string} id The ID of the webhook to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchWebhook: (id: string, patchOperation: Array, options?: AxiosRequestConfig) => Promise; /** * Create a new webhook. * @summary Creates a webhook * @param {WebhookPost} webhookPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebhook: (webhookPost: WebhookPost, options?: AxiosRequestConfig) => Promise; }; /** * WebhooksApi - functional programming interface * @export */ export declare const WebhooksApiFp: (configuration?: Configuration) => { /** * Delete a webhook by ID. * @summary Delete webhook * @param {string} id The ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch a list of all webhooks. * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllWebhooks(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a single webhook by ID. * @summary Get webhook * @param {string} id The ID of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a webhook\'s settings. Updating webhook settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update webhook * @param {string} id The ID of the webhook to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchWebhook(id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new webhook. * @summary Creates a webhook * @param {WebhookPost} webhookPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebhook(webhookPost: WebhookPost, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebhooksApi - factory interface * @export */ export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a webhook by ID. * @summary Delete webhook * @param {string} id The ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(id: string, options?: any): AxiosPromise; /** * Fetch a list of all webhooks. * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllWebhooks(options?: any): AxiosPromise; /** * Get a single webhook by ID. * @summary Get webhook * @param {string} id The ID of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(id: string, options?: any): AxiosPromise; /** * Update a webhook\'s settings. Updating webhook settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update webhook * @param {string} id The ID of the webhook to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchWebhook(id: string, patchOperation: Array, options?: any): AxiosPromise; /** * Create a new webhook. * @summary Creates a webhook * @param {WebhookPost} webhookPost * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebhook(webhookPost: WebhookPost, options?: any): AxiosPromise; }; /** * WebhooksApi - object-oriented interface * @export * @class WebhooksApi * @extends {BaseAPI} */ export declare class WebhooksApi extends BaseAPI { /** * Delete a webhook by ID. * @summary Delete webhook * @param {string} id The ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ deleteWebhook(id: string, options?: AxiosRequestConfig): Promise>; /** * Fetch a list of all webhooks. * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ getAllWebhooks(options?: AxiosRequestConfig): Promise>; /** * Get a single webhook by ID. * @summary Get webhook * @param {string} id The ID of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ getWebhook(id: string, options?: AxiosRequestConfig): Promise>; /** * Update a webhook\'s settings. Updating webhook settings uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates). * @summary Update webhook * @param {string} id The ID of the webhook to update * @param {Array} patchOperation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ patchWebhook(id: string, patchOperation: Array, options?: AxiosRequestConfig): Promise>; /** * Create a new webhook. * @summary Creates a webhook * @param {WebhookPost} webhookPost * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ postWebhook(webhookPost: WebhookPost, options?: AxiosRequestConfig): Promise>; } /** * WorkflowTemplatesApi - axios parameter creator * @export */ export declare const WorkflowTemplatesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a template for a feature flag workflow * @summary Create workflow template * @param {CreateWorkflowTemplateInput} createWorkflowTemplateInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWorkflowTemplate: (createWorkflowTemplateInput: CreateWorkflowTemplateInput, options?: AxiosRequestConfig) => Promise; /** * Delete a workflow template * @summary Delete workflow template * @param {string} templateKey The template key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWorkflowTemplate: (templateKey: string, options?: AxiosRequestConfig) => Promise; /** * Get workflow templates belonging to an account, or can optionally return templates_endpoints.workflowTemplateSummariesListingOutputRep when summary query param is true * @summary Get workflow templates * @param {boolean} [summary] Whether the entire template object or just a summary should be returned * @param {string} [search] The substring in either the name or description of a template * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWorkflowTemplates: (summary?: boolean, search?: string, options?: AxiosRequestConfig) => Promise; }; /** * WorkflowTemplatesApi - functional programming interface * @export */ export declare const WorkflowTemplatesApiFp: (configuration?: Configuration) => { /** * Create a template for a feature flag workflow * @summary Create workflow template * @param {CreateWorkflowTemplateInput} createWorkflowTemplateInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWorkflowTemplate(createWorkflowTemplateInput: CreateWorkflowTemplateInput, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a workflow template * @summary Delete workflow template * @param {string} templateKey The template key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWorkflowTemplate(templateKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get workflow templates belonging to an account, or can optionally return templates_endpoints.workflowTemplateSummariesListingOutputRep when summary query param is true * @summary Get workflow templates * @param {boolean} [summary] Whether the entire template object or just a summary should be returned * @param {string} [search] The substring in either the name or description of a template * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWorkflowTemplates(summary?: boolean, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WorkflowTemplatesApi - factory interface * @export */ export declare const WorkflowTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a template for a feature flag workflow * @summary Create workflow template * @param {CreateWorkflowTemplateInput} createWorkflowTemplateInput * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWorkflowTemplate(createWorkflowTemplateInput: CreateWorkflowTemplateInput, options?: any): AxiosPromise; /** * Delete a workflow template * @summary Delete workflow template * @param {string} templateKey The template key * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWorkflowTemplate(templateKey: string, options?: any): AxiosPromise; /** * Get workflow templates belonging to an account, or can optionally return templates_endpoints.workflowTemplateSummariesListingOutputRep when summary query param is true * @summary Get workflow templates * @param {boolean} [summary] Whether the entire template object or just a summary should be returned * @param {string} [search] The substring in either the name or description of a template * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWorkflowTemplates(summary?: boolean, search?: string, options?: any): AxiosPromise; }; /** * WorkflowTemplatesApi - object-oriented interface * @export * @class WorkflowTemplatesApi * @extends {BaseAPI} */ export declare class WorkflowTemplatesApi extends BaseAPI { /** * Create a template for a feature flag workflow * @summary Create workflow template * @param {CreateWorkflowTemplateInput} createWorkflowTemplateInput * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowTemplatesApi */ createWorkflowTemplate(createWorkflowTemplateInput: CreateWorkflowTemplateInput, options?: AxiosRequestConfig): Promise>; /** * Delete a workflow template * @summary Delete workflow template * @param {string} templateKey The template key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowTemplatesApi */ deleteWorkflowTemplate(templateKey: string, options?: AxiosRequestConfig): Promise>; /** * Get workflow templates belonging to an account, or can optionally return templates_endpoints.workflowTemplateSummariesListingOutputRep when summary query param is true * @summary Get workflow templates * @param {boolean} [summary] Whether the entire template object or just a summary should be returned * @param {string} [search] The substring in either the name or description of a template * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowTemplatesApi */ getWorkflowTemplates(summary?: boolean, search?: string, options?: AxiosRequestConfig): Promise>; } /** * WorkflowsApi - axios parameter creator * @export */ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a workflow from a feature flag. * @summary Delete workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWorkflow: (projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: AxiosRequestConfig) => Promise; /** * Get a specific workflow by ID. * @summary Get custom workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomWorkflow: (projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: AxiosRequestConfig) => Promise; /** * Display workflows associated with a feature flag. * @summary Get workflows * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} [status] Filter results by workflow status. Valid status filters are `active`, `completed`, and `failed`. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `creationDate` or `stopDate`. * @param {number} [limit] The maximum number of workflows to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWorkflows: (projectKey: string, featureFlagKey: string, environmentKey: string, status?: string, sort?: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * Create a workflow for a feature flag. You can create a workflow directly, or you can apply a template to create a new workflow. ### Creating a workflow You can use the create workflow endpoint to create a workflow directly by adding a `stages` array to the request body. For each stage, define the `name`, `conditions` when the stage should be executed, and `action` that describes the stage.
Click to expand example _Example request body_ ```json { \"name\": \"Progressive rollout starting in two days\", \"description\": \"Turn flag targeting on and increase feature rollout in 10% increments each day\", \"stages\": [ { \"name\": \"10% rollout on day 1\", \"conditions\": [ { \"kind\": \"schedule\", \"scheduleKind\": \"relative\", // or \"absolute\" // If \"scheduleKind\" is \"absolute\", set \"executionDate\"; // \"waitDuration\" and \"waitDurationUnit\" will be ignored \"waitDuration\": 2, \"waitDurationUnit\": \"calendarDay\" }, { \"kind\": \"ld-approval\", \"notifyMemberIds\": [ \"507f1f77bcf86cd799439011\" ], \"notifyTeamKeys\": [ \"team-key-123abc\" ] } ], \"action\": { \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"452f5fb5-7320-4ba3-81a1-8f4324f79d49\": 90000, \"fc15f6a4-05d3-4aa4-a997-446be461345d\": 10000 } } ] } } ] } ```
### Creating a workflow by applying a workflow template You can also create a workflow by applying a workflow template. If you pass a valid workflow template key as the `templateKey` query parameter with the request, the API will attempt to create a new workflow with the stages defined in the workflow template with the corresponding key. #### Applicability of stages Templates are created in the context of a particular flag in a particular environment in a particular project. However, because workflows created from a template can be applied to any project, environment, and flag, some steps of the workflow may need to be updated in order to be applicable for the target resource. You can pass a `dryRun` query parameter to tell the API to return a report of which steps of the workflow template are applicable in the target project/environment/flag, and which will need to be updated. When the `dryRun` query parameter is present the response body includes a `meta` property that holds a list of parameters that could potentially be inapplicable for the target resource. Each of these parameters will include a `valid` field. You will need to update any invalid parameters in order to create the new workflow. You can do this using the `parameters` property, which overrides the workflow template parameters. #### Overriding template parameters You can use the `parameters` property in the request body to tell the API to override the specified workflow template parameters with new values that are specific to your target project/environment/flag.
Click to expand example _Example request body_ ```json { \"name\": \"workflow created from my-template\", \"description\": \"description of my workflow\", \"parameters\": [ { \"_id\": \"62cf2bc4cadbeb7697943f3b\", \"path\": \"/clauses/0/values\", \"default\": { \"value\": [\"updated-segment\"] } }, { \"_id\": \"62cf2bc4cadbeb7697943f3d\", \"path\": \"/variationId\", \"default\": { \"value\": \"abcd1234-abcd-1234-abcd-1234abcd12\" } } ] } ```
If there are any steps in the template that are not applicable to the target resource, the workflow will not be created, and the `meta` property will be included in the response body detailing which parameters need to be updated. * @summary Create workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CustomWorkflowInput} customWorkflowInput * @param {string} [templateKey] The template key to apply as a starting point for the new workflow * @param {boolean} [dryRun] Whether to call the endpoint in dry-run mode * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWorkflow: (projectKey: string, featureFlagKey: string, environmentKey: string, customWorkflowInput: CustomWorkflowInput, templateKey?: string, dryRun?: boolean, options?: AxiosRequestConfig) => Promise; }; /** * WorkflowsApi - functional programming interface * @export */ export declare const WorkflowsApiFp: (configuration?: Configuration) => { /** * Delete a workflow from a feature flag. * @summary Delete workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a specific workflow by ID. * @summary Get custom workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Display workflows associated with a feature flag. * @summary Get workflows * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} [status] Filter results by workflow status. Valid status filters are `active`, `completed`, and `failed`. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `creationDate` or `stopDate`. * @param {number} [limit] The maximum number of workflows to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWorkflows(projectKey: string, featureFlagKey: string, environmentKey: string, status?: string, sort?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a workflow for a feature flag. You can create a workflow directly, or you can apply a template to create a new workflow. ### Creating a workflow You can use the create workflow endpoint to create a workflow directly by adding a `stages` array to the request body. For each stage, define the `name`, `conditions` when the stage should be executed, and `action` that describes the stage.
Click to expand example _Example request body_ ```json { \"name\": \"Progressive rollout starting in two days\", \"description\": \"Turn flag targeting on and increase feature rollout in 10% increments each day\", \"stages\": [ { \"name\": \"10% rollout on day 1\", \"conditions\": [ { \"kind\": \"schedule\", \"scheduleKind\": \"relative\", // or \"absolute\" // If \"scheduleKind\" is \"absolute\", set \"executionDate\"; // \"waitDuration\" and \"waitDurationUnit\" will be ignored \"waitDuration\": 2, \"waitDurationUnit\": \"calendarDay\" }, { \"kind\": \"ld-approval\", \"notifyMemberIds\": [ \"507f1f77bcf86cd799439011\" ], \"notifyTeamKeys\": [ \"team-key-123abc\" ] } ], \"action\": { \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"452f5fb5-7320-4ba3-81a1-8f4324f79d49\": 90000, \"fc15f6a4-05d3-4aa4-a997-446be461345d\": 10000 } } ] } } ] } ```
### Creating a workflow by applying a workflow template You can also create a workflow by applying a workflow template. If you pass a valid workflow template key as the `templateKey` query parameter with the request, the API will attempt to create a new workflow with the stages defined in the workflow template with the corresponding key. #### Applicability of stages Templates are created in the context of a particular flag in a particular environment in a particular project. However, because workflows created from a template can be applied to any project, environment, and flag, some steps of the workflow may need to be updated in order to be applicable for the target resource. You can pass a `dryRun` query parameter to tell the API to return a report of which steps of the workflow template are applicable in the target project/environment/flag, and which will need to be updated. When the `dryRun` query parameter is present the response body includes a `meta` property that holds a list of parameters that could potentially be inapplicable for the target resource. Each of these parameters will include a `valid` field. You will need to update any invalid parameters in order to create the new workflow. You can do this using the `parameters` property, which overrides the workflow template parameters. #### Overriding template parameters You can use the `parameters` property in the request body to tell the API to override the specified workflow template parameters with new values that are specific to your target project/environment/flag.
Click to expand example _Example request body_ ```json { \"name\": \"workflow created from my-template\", \"description\": \"description of my workflow\", \"parameters\": [ { \"_id\": \"62cf2bc4cadbeb7697943f3b\", \"path\": \"/clauses/0/values\", \"default\": { \"value\": [\"updated-segment\"] } }, { \"_id\": \"62cf2bc4cadbeb7697943f3d\", \"path\": \"/variationId\", \"default\": { \"value\": \"abcd1234-abcd-1234-abcd-1234abcd12\" } } ] } ```
If there are any steps in the template that are not applicable to the target resource, the workflow will not be created, and the `meta` property will be included in the response body detailing which parameters need to be updated. * @summary Create workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CustomWorkflowInput} customWorkflowInput * @param {string} [templateKey] The template key to apply as a starting point for the new workflow * @param {boolean} [dryRun] Whether to call the endpoint in dry-run mode * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, customWorkflowInput: CustomWorkflowInput, templateKey?: string, dryRun?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WorkflowsApi - factory interface * @export */ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a workflow from a feature flag. * @summary Delete workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow id * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: any): AxiosPromise; /** * Get a specific workflow by ID. * @summary Get custom workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: any): AxiosPromise; /** * Display workflows associated with a feature flag. * @summary Get workflows * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} [status] Filter results by workflow status. Valid status filters are `active`, `completed`, and `failed`. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `creationDate` or `stopDate`. * @param {number} [limit] The maximum number of workflows to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWorkflows(projectKey: string, featureFlagKey: string, environmentKey: string, status?: string, sort?: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Create a workflow for a feature flag. You can create a workflow directly, or you can apply a template to create a new workflow. ### Creating a workflow You can use the create workflow endpoint to create a workflow directly by adding a `stages` array to the request body. For each stage, define the `name`, `conditions` when the stage should be executed, and `action` that describes the stage.
Click to expand example _Example request body_ ```json { \"name\": \"Progressive rollout starting in two days\", \"description\": \"Turn flag targeting on and increase feature rollout in 10% increments each day\", \"stages\": [ { \"name\": \"10% rollout on day 1\", \"conditions\": [ { \"kind\": \"schedule\", \"scheduleKind\": \"relative\", // or \"absolute\" // If \"scheduleKind\" is \"absolute\", set \"executionDate\"; // \"waitDuration\" and \"waitDurationUnit\" will be ignored \"waitDuration\": 2, \"waitDurationUnit\": \"calendarDay\" }, { \"kind\": \"ld-approval\", \"notifyMemberIds\": [ \"507f1f77bcf86cd799439011\" ], \"notifyTeamKeys\": [ \"team-key-123abc\" ] } ], \"action\": { \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"452f5fb5-7320-4ba3-81a1-8f4324f79d49\": 90000, \"fc15f6a4-05d3-4aa4-a997-446be461345d\": 10000 } } ] } } ] } ```
### Creating a workflow by applying a workflow template You can also create a workflow by applying a workflow template. If you pass a valid workflow template key as the `templateKey` query parameter with the request, the API will attempt to create a new workflow with the stages defined in the workflow template with the corresponding key. #### Applicability of stages Templates are created in the context of a particular flag in a particular environment in a particular project. However, because workflows created from a template can be applied to any project, environment, and flag, some steps of the workflow may need to be updated in order to be applicable for the target resource. You can pass a `dryRun` query parameter to tell the API to return a report of which steps of the workflow template are applicable in the target project/environment/flag, and which will need to be updated. When the `dryRun` query parameter is present the response body includes a `meta` property that holds a list of parameters that could potentially be inapplicable for the target resource. Each of these parameters will include a `valid` field. You will need to update any invalid parameters in order to create the new workflow. You can do this using the `parameters` property, which overrides the workflow template parameters. #### Overriding template parameters You can use the `parameters` property in the request body to tell the API to override the specified workflow template parameters with new values that are specific to your target project/environment/flag.
Click to expand example _Example request body_ ```json { \"name\": \"workflow created from my-template\", \"description\": \"description of my workflow\", \"parameters\": [ { \"_id\": \"62cf2bc4cadbeb7697943f3b\", \"path\": \"/clauses/0/values\", \"default\": { \"value\": [\"updated-segment\"] } }, { \"_id\": \"62cf2bc4cadbeb7697943f3d\", \"path\": \"/variationId\", \"default\": { \"value\": \"abcd1234-abcd-1234-abcd-1234abcd12\" } } ] } ```
If there are any steps in the template that are not applicable to the target resource, the workflow will not be created, and the `meta` property will be included in the response body detailing which parameters need to be updated. * @summary Create workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CustomWorkflowInput} customWorkflowInput * @param {string} [templateKey] The template key to apply as a starting point for the new workflow * @param {boolean} [dryRun] Whether to call the endpoint in dry-run mode * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, customWorkflowInput: CustomWorkflowInput, templateKey?: string, dryRun?: boolean, options?: any): AxiosPromise; }; /** * WorkflowsApi - object-oriented interface * @export * @class WorkflowsApi * @extends {BaseAPI} */ export declare class WorkflowsApi extends BaseAPI { /** * Delete a workflow from a feature flag. * @summary Delete workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ deleteWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: AxiosRequestConfig): Promise>; /** * Get a specific workflow by ID. * @summary Get custom workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} workflowId The workflow ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ getCustomWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, workflowId: string, options?: AxiosRequestConfig): Promise>; /** * Display workflows associated with a feature flag. * @summary Get workflows * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {string} [status] Filter results by workflow status. Valid status filters are `active`, `completed`, and `failed`. * @param {string} [sort] A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `creationDate` or `stopDate`. * @param {number} [limit] The maximum number of workflows to return. Defaults to 20. * @param {number} [offset] Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ getWorkflows(projectKey: string, featureFlagKey: string, environmentKey: string, status?: string, sort?: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * Create a workflow for a feature flag. You can create a workflow directly, or you can apply a template to create a new workflow. ### Creating a workflow You can use the create workflow endpoint to create a workflow directly by adding a `stages` array to the request body. For each stage, define the `name`, `conditions` when the stage should be executed, and `action` that describes the stage.
Click to expand example _Example request body_ ```json { \"name\": \"Progressive rollout starting in two days\", \"description\": \"Turn flag targeting on and increase feature rollout in 10% increments each day\", \"stages\": [ { \"name\": \"10% rollout on day 1\", \"conditions\": [ { \"kind\": \"schedule\", \"scheduleKind\": \"relative\", // or \"absolute\" // If \"scheduleKind\" is \"absolute\", set \"executionDate\"; // \"waitDuration\" and \"waitDurationUnit\" will be ignored \"waitDuration\": 2, \"waitDurationUnit\": \"calendarDay\" }, { \"kind\": \"ld-approval\", \"notifyMemberIds\": [ \"507f1f77bcf86cd799439011\" ], \"notifyTeamKeys\": [ \"team-key-123abc\" ] } ], \"action\": { \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"452f5fb5-7320-4ba3-81a1-8f4324f79d49\": 90000, \"fc15f6a4-05d3-4aa4-a997-446be461345d\": 10000 } } ] } } ] } ```
### Creating a workflow by applying a workflow template You can also create a workflow by applying a workflow template. If you pass a valid workflow template key as the `templateKey` query parameter with the request, the API will attempt to create a new workflow with the stages defined in the workflow template with the corresponding key. #### Applicability of stages Templates are created in the context of a particular flag in a particular environment in a particular project. However, because workflows created from a template can be applied to any project, environment, and flag, some steps of the workflow may need to be updated in order to be applicable for the target resource. You can pass a `dryRun` query parameter to tell the API to return a report of which steps of the workflow template are applicable in the target project/environment/flag, and which will need to be updated. When the `dryRun` query parameter is present the response body includes a `meta` property that holds a list of parameters that could potentially be inapplicable for the target resource. Each of these parameters will include a `valid` field. You will need to update any invalid parameters in order to create the new workflow. You can do this using the `parameters` property, which overrides the workflow template parameters. #### Overriding template parameters You can use the `parameters` property in the request body to tell the API to override the specified workflow template parameters with new values that are specific to your target project/environment/flag.
Click to expand example _Example request body_ ```json { \"name\": \"workflow created from my-template\", \"description\": \"description of my workflow\", \"parameters\": [ { \"_id\": \"62cf2bc4cadbeb7697943f3b\", \"path\": \"/clauses/0/values\", \"default\": { \"value\": [\"updated-segment\"] } }, { \"_id\": \"62cf2bc4cadbeb7697943f3d\", \"path\": \"/variationId\", \"default\": { \"value\": \"abcd1234-abcd-1234-abcd-1234abcd12\" } } ] } ```
If there are any steps in the template that are not applicable to the target resource, the workflow will not be created, and the `meta` property will be included in the response body detailing which parameters need to be updated. * @summary Create workflow * @param {string} projectKey The project key * @param {string} featureFlagKey The feature flag key * @param {string} environmentKey The environment key * @param {CustomWorkflowInput} customWorkflowInput * @param {string} [templateKey] The template key to apply as a starting point for the new workflow * @param {boolean} [dryRun] Whether to call the endpoint in dry-run mode * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowsApi */ postWorkflow(projectKey: string, featureFlagKey: string, environmentKey: string, customWorkflowInput: CustomWorkflowInput, templateKey?: string, dryRun?: boolean, options?: AxiosRequestConfig): Promise>; }