launchdarkly_api 19.0.0 → 20.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +24 -10
- data/docs/AIConfigPost.md +3 -1
- data/docs/AIConfigsBetaApi.md +387 -0
- data/docs/AccountUsageBetaApi.md +182 -0
- data/docs/AgentGraph.md +30 -0
- data/docs/AgentGraphEdge.md +24 -0
- data/docs/AgentGraphEdgePost.md +24 -0
- data/docs/AgentGraphPatch.md +24 -0
- data/docs/AgentGraphPost.md +26 -0
- data/docs/AgentGraphs.md +22 -0
- data/docs/FeatureFlagsApi.md +3 -1
- data/docs/GuardedReleaseConfig.md +10 -2
- data/docs/IterationInput.md +0 -2
- data/docs/IterationRep.md +1 -3
- data/docs/PostReleasePolicyRequest.md +2 -2
- data/docs/ProgressiveReleaseConfig.md +20 -0
- data/docs/PutReleasePolicyRequest.md +2 -2
- data/docs/ReleasePolicy.md +2 -2
- data/docs/ReleasePolicyScope.md +3 -1
- data/docs/ReleasePolicyStage.md +20 -0
- data/docs/Rule.md +2 -0
- data/docs/SegmentsApi.md +8 -4
- data/docs/TagsApi.md +2 -2
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +171 -0
- data/lib/launchdarkly_api/api/ai_configs_beta_api.rb +417 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +3 -0
- data/lib/launchdarkly_api/api/segments_api.rb +3 -0
- data/lib/launchdarkly_api/api/tags_api.rb +2 -2
- data/lib/launchdarkly_api/models/agent_graph.rb +350 -0
- data/lib/launchdarkly_api/models/agent_graph_edge.rb +303 -0
- data/lib/launchdarkly_api/models/agent_graph_edge_post.rb +303 -0
- data/lib/launchdarkly_api/models/agent_graph_patch.rb +254 -0
- data/lib/launchdarkly_api/models/agent_graph_post.rb +298 -0
- data/lib/launchdarkly_api/models/{covariance_info_rep.rb → agent_graphs.rb} +43 -59
- data/lib/launchdarkly_api/models/ai_config_post.rb +13 -4
- data/lib/launchdarkly_api/models/guarded_release_config.rb +50 -21
- data/lib/launchdarkly_api/models/iteration_input.rb +1 -11
- data/lib/launchdarkly_api/models/iteration_rep.rb +4 -13
- data/lib/launchdarkly_api/models/post_release_policy_request.rb +1 -2
- data/lib/launchdarkly_api/models/progressive_release_config.rb +234 -0
- data/lib/launchdarkly_api/models/put_release_policy_request.rb +1 -2
- data/lib/launchdarkly_api/models/release_policy.rb +1 -2
- data/lib/launchdarkly_api/models/release_policy_scope.rb +16 -4
- data/lib/launchdarkly_api/models/release_policy_stage.rb +263 -0
- data/lib/launchdarkly_api/models/rule.rb +11 -1
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +8 -1
- data/spec/api/account_usage_beta_api_spec.rb +41 -0
- data/spec/api/ai_configs_beta_api_spec.rb +72 -0
- data/spec/api/feature_flags_api_spec.rb +1 -0
- data/spec/api/segments_api_spec.rb +1 -0
- data/spec/api/tags_api_spec.rb +1 -1
- data/spec/models/agent_graph_edge_post_spec.rb +54 -0
- data/spec/models/agent_graph_edge_spec.rb +54 -0
- data/spec/models/agent_graph_patch_spec.rb +54 -0
- data/spec/models/agent_graph_post_spec.rb +60 -0
- data/spec/models/agent_graph_spec.rb +72 -0
- data/spec/models/{covariance_info_rep_spec.rb → agent_graphs_spec.rb} +9 -9
- data/spec/models/ai_config_post_spec.rb +6 -0
- data/spec/models/guarded_release_config_spec.rb +24 -0
- data/spec/models/iteration_input_spec.rb +0 -6
- data/spec/models/iteration_rep_spec.rb +0 -6
- data/spec/models/progressive_release_config_spec.rb +42 -0
- data/spec/models/release_policy_scope_spec.rb +6 -0
- data/spec/models/release_policy_stage_spec.rb +42 -0
- data/spec/models/rule_spec.rb +6 -0
- metadata +34 -6
- data/docs/CovarianceInfoRep.md +0 -22
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#LaunchDarkly REST API
|
|
3
|
+
|
|
4
|
+
#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). To learn how to use LaunchDarkly using the user interface (UI) instead, read our [product documentation](https://launchdarkly.com/docs/home). ## 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. Depending on the permissions granted as part of your [role](https://launchdarkly.com/docs/home/account/roles), 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 and EU environments In addition to the commercial versions, LaunchDarkly offers instances for federal agencies and those based in the European Union (EU). ### 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). ### EU environments The version of LaunchDarkly that is available in the EU is different from the version of LaunchDarkly available to other regions. If you are based in the EU, you likely use the EU instance of LaunchDarkly. The LaunchDarkly EU instance complies with EU data residency principles, including the protection and confidentiality of EU customer information. If you are working in the EU instance of LaunchDarkly, the base URI for each request is `https://app.eu.launchdarkly.com`. To learn more, read [LaunchDarkly in the European Union (EU)](https://launchdarkly.com/docs/home/infrastructure/eu). ## 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 <table> <tr> <th>Version</th> <th>Changes</th> <th>End of life (EOL)</th> </tr> <tr> <td>`20240415`</td> <td> <ul><li>Changed several endpoints from unpaginated to paginated. Use the `limit` and `offset` query parameters to page through the results.</li> <li>Changed the [list access tokens](https://launchdarkly.com/docs/api/access-tokens/get-tokens) endpoint: <ul><li>Response is now paginated with a default limit of `25`</li></ul></li> <li>Changed the [list account members](https://launchdarkly.com/docs/api/account-members/get-members) endpoint: <ul><li>The `accessCheck` filter is no longer available</li></ul></li> <li>Changed the [list custom roles](https://launchdarkly.com/docs/api/custom-roles/get-custom-roles) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li></ul></li> <li>Changed the [list feature flags](https://launchdarkly.com/docs/api/feature-flags/get-feature-flags) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li><li>The `environments` field is now only returned if the request is filtered by environment, using the `filterEnv` query parameter</li><li>The `followerId`, `hasDataExport`, `status`, `contextKindTargeted`, and `segmentTargeted` filters are no longer available</li><li>The `compare` query parameter is no longer available</li></ul></li> <li>Changed the [list segments](https://launchdarkly.com/docs/api/segments/get-segments) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li></ul></li> <li>Changed the [list teams](https://launchdarkly.com/docs/api/teams/get-teams) endpoint: <ul><li>The `expand` parameter no longer supports including `projects` or `roles`</li><li>In paginated results, the maximum page size is now 100</li></ul></li> <li>Changed the [get workflows](https://launchdarkly.com/docs/api/workflows/get-workflows) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li><li>The `_conflicts` field in the response is no longer available</li></ul></li> </ul> </td> <td>Current</td> </tr> <tr> <td>`20220603`</td> <td> <ul><li>Changed the [list projects](https://launchdarkly.com/docs/api/projects/get-projects) return value:<ul><li>Response is now paginated with a default limit of `20`.</li><li>Added support for filter and sort.</li><li>The project `environments` field is now expandable. This field is omitted by default.</li></ul></li><li>Changed the [get project](https://launchdarkly.com/docs/api/projects/get-project) return value:<ul><li>The `environments` field is now expandable. This field is omitted by default.</li></ul></li></ul> </td> <td>2025-04-15</td> </tr> <tr> <td>`20210729`</td> <td> <ul><li>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`.</li><li> Changed the [get user](https://launchdarkly.com/docs/api/users/get-user) return value. It now returns a user record, not a user. </li><li>Added additional optional fields to environment, segments, flags, members, and segments, including the ability to create big segments. </li><li> Added default values for flag variations when new environments are created. </li><li>Added filtering and pagination for getting flags and members, including `limit`, `number`, `filter`, and `sort` query parameters. </li><li>Added endpoints for expiring user targets for flags and segments, scheduled changes, access tokens, Relay Proxy configuration, integrations and subscriptions, and approvals. </li></ul> </td> <td>2023-06-03</td> </tr> <tr> <td>`20191212`</td> <td> <ul><li>[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. </li><li> Added endpoints for flags, flag status, projects, environments, audit logs, members, users, custom roles, segments, usage, streams, events, and data export. </li></ul> </td> <td>2022-07-29</td> </tr> <tr> <td>`20160426`</td> <td> <ul><li>Initial versioning of API. Tokens created before versioning have their version set to this.</li></ul> </td> <td>2020-12-12</td> </tr> </table> To learn more about how EOL is determined, read LaunchDarkly's [End of Life (EOL) Policy](https://launchdarkly.com/policies/end-of-life-policy/).
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0
|
|
7
|
+
Contact: support@launchdarkly.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.16.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module LaunchDarklyApi
|
|
17
|
+
class ReleasePolicyStage
|
|
18
|
+
attr_accessor :allocation
|
|
19
|
+
|
|
20
|
+
attr_accessor :duration_millis
|
|
21
|
+
|
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
23
|
+
def self.attribute_map
|
|
24
|
+
{
|
|
25
|
+
:'allocation' => :'allocation',
|
|
26
|
+
:'duration_millis' => :'durationMillis'
|
|
27
|
+
}
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# Returns attribute mapping this model knows about
|
|
31
|
+
def self.acceptable_attribute_map
|
|
32
|
+
attribute_map
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Returns all the JSON keys this model knows about
|
|
36
|
+
def self.acceptable_attributes
|
|
37
|
+
acceptable_attribute_map.values
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Attribute type mapping.
|
|
41
|
+
def self.openapi_types
|
|
42
|
+
{
|
|
43
|
+
:'allocation' => :'Integer',
|
|
44
|
+
:'duration_millis' => :'Integer'
|
|
45
|
+
}
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# List of attributes with nullable: true
|
|
49
|
+
def self.openapi_nullable
|
|
50
|
+
Set.new([
|
|
51
|
+
])
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# Initializes the object
|
|
55
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
56
|
+
def initialize(attributes = {})
|
|
57
|
+
if (!attributes.is_a?(Hash))
|
|
58
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `LaunchDarklyApi::ReleasePolicyStage` initialize method"
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
62
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
63
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
64
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
65
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `LaunchDarklyApi::ReleasePolicyStage`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
66
|
+
end
|
|
67
|
+
h[k.to_sym] = v
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
if attributes.key?(:'allocation')
|
|
71
|
+
self.allocation = attributes[:'allocation']
|
|
72
|
+
else
|
|
73
|
+
self.allocation = nil
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
if attributes.key?(:'duration_millis')
|
|
77
|
+
self.duration_millis = attributes[:'duration_millis']
|
|
78
|
+
else
|
|
79
|
+
self.duration_millis = nil
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
84
|
+
# @return Array for valid properties with the reasons
|
|
85
|
+
def list_invalid_properties
|
|
86
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
87
|
+
invalid_properties = Array.new
|
|
88
|
+
if @allocation.nil?
|
|
89
|
+
invalid_properties.push('invalid value for "allocation", allocation cannot be nil.')
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
if @duration_millis.nil?
|
|
93
|
+
invalid_properties.push('invalid value for "duration_millis", duration_millis cannot be nil.')
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
invalid_properties
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# Check to see if the all the properties in the model are valid
|
|
100
|
+
# @return true if the model is valid
|
|
101
|
+
def valid?
|
|
102
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
103
|
+
return false if @allocation.nil?
|
|
104
|
+
return false if @duration_millis.nil?
|
|
105
|
+
true
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Custom attribute writer method with validation
|
|
109
|
+
# @param [Object] allocation Value to be assigned
|
|
110
|
+
def allocation=(allocation)
|
|
111
|
+
if allocation.nil?
|
|
112
|
+
fail ArgumentError, 'allocation cannot be nil'
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
@allocation = allocation
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# Custom attribute writer method with validation
|
|
119
|
+
# @param [Object] duration_millis Value to be assigned
|
|
120
|
+
def duration_millis=(duration_millis)
|
|
121
|
+
if duration_millis.nil?
|
|
122
|
+
fail ArgumentError, 'duration_millis cannot be nil'
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
@duration_millis = duration_millis
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Checks equality by comparing each attribute.
|
|
129
|
+
# @param [Object] Object to be compared
|
|
130
|
+
def ==(o)
|
|
131
|
+
return true if self.equal?(o)
|
|
132
|
+
self.class == o.class &&
|
|
133
|
+
allocation == o.allocation &&
|
|
134
|
+
duration_millis == o.duration_millis
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# @see the `==` method
|
|
138
|
+
# @param [Object] Object to be compared
|
|
139
|
+
def eql?(o)
|
|
140
|
+
self == o
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
# Calculates hash code according to all attributes.
|
|
144
|
+
# @return [Integer] Hash code
|
|
145
|
+
def hash
|
|
146
|
+
[allocation, duration_millis].hash
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Builds the object from hash
|
|
150
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
151
|
+
# @return [Object] Returns the model itself
|
|
152
|
+
def self.build_from_hash(attributes)
|
|
153
|
+
return nil unless attributes.is_a?(Hash)
|
|
154
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
155
|
+
transformed_hash = {}
|
|
156
|
+
openapi_types.each_pair do |key, type|
|
|
157
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
158
|
+
transformed_hash["#{key}"] = nil
|
|
159
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
160
|
+
# check to ensure the input is an array given that the attribute
|
|
161
|
+
# is documented as an array but the input is not
|
|
162
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
163
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
164
|
+
end
|
|
165
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
166
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
167
|
+
end
|
|
168
|
+
end
|
|
169
|
+
new(transformed_hash)
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
# Deserializes the data based on type
|
|
173
|
+
# @param string type Data type
|
|
174
|
+
# @param string value Value to be deserialized
|
|
175
|
+
# @return [Object] Deserialized data
|
|
176
|
+
def self._deserialize(type, value)
|
|
177
|
+
case type.to_sym
|
|
178
|
+
when :Time
|
|
179
|
+
Time.parse(value)
|
|
180
|
+
when :Date
|
|
181
|
+
Date.parse(value)
|
|
182
|
+
when :String
|
|
183
|
+
value.to_s
|
|
184
|
+
when :Integer
|
|
185
|
+
value.to_i
|
|
186
|
+
when :Float
|
|
187
|
+
value.to_f
|
|
188
|
+
when :Boolean
|
|
189
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
190
|
+
true
|
|
191
|
+
else
|
|
192
|
+
false
|
|
193
|
+
end
|
|
194
|
+
when :Object
|
|
195
|
+
# generic object (usually a Hash), return directly
|
|
196
|
+
value
|
|
197
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
198
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
199
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
200
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
201
|
+
k_type = Regexp.last_match[:k_type]
|
|
202
|
+
v_type = Regexp.last_match[:v_type]
|
|
203
|
+
{}.tap do |hash|
|
|
204
|
+
value.each do |k, v|
|
|
205
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
206
|
+
end
|
|
207
|
+
end
|
|
208
|
+
else # model
|
|
209
|
+
# models (e.g. Pet) or oneOf
|
|
210
|
+
klass = LaunchDarklyApi.const_get(type)
|
|
211
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
212
|
+
end
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# Returns the string representation of the object
|
|
216
|
+
# @return [String] String presentation of the object
|
|
217
|
+
def to_s
|
|
218
|
+
to_hash.to_s
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
222
|
+
# @return [Hash] Returns the object in the form of hash
|
|
223
|
+
def to_body
|
|
224
|
+
to_hash
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
# Returns the object in the form of hash
|
|
228
|
+
# @return [Hash] Returns the object in the form of hash
|
|
229
|
+
def to_hash
|
|
230
|
+
hash = {}
|
|
231
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
232
|
+
value = self.send(attr)
|
|
233
|
+
if value.nil?
|
|
234
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
235
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
hash[param] = _to_hash(value)
|
|
239
|
+
end
|
|
240
|
+
hash
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
# Outputs non-array value in the form of hash
|
|
244
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
245
|
+
# @param [Object] value Any valid value
|
|
246
|
+
# @return [Hash] Returns the value in the form of hash
|
|
247
|
+
def _to_hash(value)
|
|
248
|
+
if value.is_a?(Array)
|
|
249
|
+
value.compact.map { |v| _to_hash(v) }
|
|
250
|
+
elsif value.is_a?(Hash)
|
|
251
|
+
{}.tap do |hash|
|
|
252
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
253
|
+
end
|
|
254
|
+
elsif value.respond_to? :to_hash
|
|
255
|
+
value.to_hash
|
|
256
|
+
else
|
|
257
|
+
value
|
|
258
|
+
end
|
|
259
|
+
end
|
|
260
|
+
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
end
|
|
@@ -18,6 +18,9 @@ module LaunchDarklyApi
|
|
|
18
18
|
# The flag rule ID
|
|
19
19
|
attr_accessor :_id
|
|
20
20
|
|
|
21
|
+
# Whether the rule is disabled
|
|
22
|
+
attr_accessor :disabled
|
|
23
|
+
|
|
21
24
|
# The index of the variation, from the array of variations for this flag
|
|
22
25
|
attr_accessor :variation
|
|
23
26
|
|
|
@@ -38,6 +41,7 @@ module LaunchDarklyApi
|
|
|
38
41
|
def self.attribute_map
|
|
39
42
|
{
|
|
40
43
|
:'_id' => :'_id',
|
|
44
|
+
:'disabled' => :'disabled',
|
|
41
45
|
:'variation' => :'variation',
|
|
42
46
|
:'rollout' => :'rollout',
|
|
43
47
|
:'clauses' => :'clauses',
|
|
@@ -61,6 +65,7 @@ module LaunchDarklyApi
|
|
|
61
65
|
def self.openapi_types
|
|
62
66
|
{
|
|
63
67
|
:'_id' => :'String',
|
|
68
|
+
:'disabled' => :'Boolean',
|
|
64
69
|
:'variation' => :'Integer',
|
|
65
70
|
:'rollout' => :'Rollout',
|
|
66
71
|
:'clauses' => :'Array<Clause>',
|
|
@@ -96,6 +101,10 @@ module LaunchDarklyApi
|
|
|
96
101
|
self._id = attributes[:'_id']
|
|
97
102
|
end
|
|
98
103
|
|
|
104
|
+
if attributes.key?(:'disabled')
|
|
105
|
+
self.disabled = attributes[:'disabled']
|
|
106
|
+
end
|
|
107
|
+
|
|
99
108
|
if attributes.key?(:'variation')
|
|
100
109
|
self.variation = attributes[:'variation']
|
|
101
110
|
end
|
|
@@ -178,6 +187,7 @@ module LaunchDarklyApi
|
|
|
178
187
|
return true if self.equal?(o)
|
|
179
188
|
self.class == o.class &&
|
|
180
189
|
_id == o._id &&
|
|
190
|
+
disabled == o.disabled &&
|
|
181
191
|
variation == o.variation &&
|
|
182
192
|
rollout == o.rollout &&
|
|
183
193
|
clauses == o.clauses &&
|
|
@@ -195,7 +205,7 @@ module LaunchDarklyApi
|
|
|
195
205
|
# Calculates hash code according to all attributes.
|
|
196
206
|
# @return [Integer] Hash code
|
|
197
207
|
def hash
|
|
198
|
-
[_id, variation, rollout, clauses, track_events, description, ref].hash
|
|
208
|
+
[_id, disabled, variation, rollout, clauses, track_events, description, ref].hash
|
|
199
209
|
end
|
|
200
210
|
|
|
201
211
|
# Builds the object from hash
|
data/lib/launchdarkly_api.rb
CHANGED
|
@@ -53,6 +53,12 @@ require 'launchdarkly_api/models/access_denied_reason'
|
|
|
53
53
|
require 'launchdarkly_api/models/access_token_post'
|
|
54
54
|
require 'launchdarkly_api/models/action_input'
|
|
55
55
|
require 'launchdarkly_api/models/action_output'
|
|
56
|
+
require 'launchdarkly_api/models/agent_graph'
|
|
57
|
+
require 'launchdarkly_api/models/agent_graph_edge'
|
|
58
|
+
require 'launchdarkly_api/models/agent_graph_edge_post'
|
|
59
|
+
require 'launchdarkly_api/models/agent_graph_patch'
|
|
60
|
+
require 'launchdarkly_api/models/agent_graph_post'
|
|
61
|
+
require 'launchdarkly_api/models/agent_graphs'
|
|
56
62
|
require 'launchdarkly_api/models/ai_configs_access'
|
|
57
63
|
require 'launchdarkly_api/models/ai_configs_access_allowed_reason'
|
|
58
64
|
require 'launchdarkly_api/models/ai_configs_access_allowed_rep'
|
|
@@ -148,7 +154,6 @@ require 'launchdarkly_api/models/context_search'
|
|
|
148
154
|
require 'launchdarkly_api/models/contexts'
|
|
149
155
|
require 'launchdarkly_api/models/copied_from_env'
|
|
150
156
|
require 'launchdarkly_api/models/core_link'
|
|
151
|
-
require 'launchdarkly_api/models/covariance_info_rep'
|
|
152
157
|
require 'launchdarkly_api/models/create_announcement_body'
|
|
153
158
|
require 'launchdarkly_api/models/create_approval_request_request'
|
|
154
159
|
require 'launchdarkly_api/models/create_copy_flag_config_approval_request_request'
|
|
@@ -430,6 +435,7 @@ require 'launchdarkly_api/models/post_flag_scheduled_changes_input'
|
|
|
430
435
|
require 'launchdarkly_api/models/post_insight_group_params'
|
|
431
436
|
require 'launchdarkly_api/models/post_release_policy_request'
|
|
432
437
|
require 'launchdarkly_api/models/prerequisite'
|
|
438
|
+
require 'launchdarkly_api/models/progressive_release_config'
|
|
433
439
|
require 'launchdarkly_api/models/project'
|
|
434
440
|
require 'launchdarkly_api/models/project_post'
|
|
435
441
|
require 'launchdarkly_api/models/project_rep'
|
|
@@ -469,6 +475,7 @@ require 'launchdarkly_api/models/release_policies_access_rep'
|
|
|
469
475
|
require 'launchdarkly_api/models/release_policies_response'
|
|
470
476
|
require 'launchdarkly_api/models/release_policy'
|
|
471
477
|
require 'launchdarkly_api/models/release_policy_scope'
|
|
478
|
+
require 'launchdarkly_api/models/release_policy_stage'
|
|
472
479
|
require 'launchdarkly_api/models/release_progression'
|
|
473
480
|
require 'launchdarkly_api/models/release_progression_collection'
|
|
474
481
|
require 'launchdarkly_api/models/releaser_audience_config_input'
|
|
@@ -185,6 +185,26 @@ describe 'AccountUsageBetaApi' do
|
|
|
185
185
|
end
|
|
186
186
|
end
|
|
187
187
|
|
|
188
|
+
# unit tests for get_mau_clientside_usage
|
|
189
|
+
# Get MAU clientside usage
|
|
190
|
+
# Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. The counts reflect data reported from client-side SDKs.<br/><br/>For past months, the primary context kind is fixed and reflects the last known primary kind for that month. For the current month, it may vary as new primary context kinds are observed.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.
|
|
191
|
+
# @param [Hash] opts the optional parameters
|
|
192
|
+
# @option opts [String] :from The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
|
|
193
|
+
# @option opts [String] :to The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
|
|
194
|
+
# @option opts [String] :project_key A project key to filter results by. Can be specified multiple times, one query parameter per project key.
|
|
195
|
+
# @option opts [String] :environment_key An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
|
|
196
|
+
# @option opts [String] :sdk_name An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
|
|
197
|
+
# @option opts [String] :anonymous An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`.
|
|
198
|
+
# @option opts [String] :group_by If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
|
|
199
|
+
# @option opts [String] :aggregation_type Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.
|
|
200
|
+
# @option opts [String] :granularity Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only.
|
|
201
|
+
# @return [SeriesListRep]
|
|
202
|
+
describe 'get_mau_clientside_usage test' do
|
|
203
|
+
it 'should work' do
|
|
204
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
205
|
+
end
|
|
206
|
+
end
|
|
207
|
+
|
|
188
208
|
# unit tests for get_mau_sdks_by_type
|
|
189
209
|
# Get MAU SDKs by type
|
|
190
210
|
# 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.<br/><br/>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).
|
|
@@ -199,6 +219,27 @@ describe 'AccountUsageBetaApi' do
|
|
|
199
219
|
end
|
|
200
220
|
end
|
|
201
221
|
|
|
222
|
+
# unit tests for get_mau_total_usage
|
|
223
|
+
# Get MAU total usage
|
|
224
|
+
# Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only.<br/><br/>For past months, this reflects the context kind that was most recently marked as primary for that month. For the current month, the context kind may vary as new primary kinds are observed.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.
|
|
225
|
+
# @param [Hash] opts the optional parameters
|
|
226
|
+
# @option opts [String] :from The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
|
|
227
|
+
# @option opts [String] :to The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
|
|
228
|
+
# @option opts [String] :project_key A project key to filter results by. Can be specified multiple times, one query parameter per project key.
|
|
229
|
+
# @option opts [String] :environment_key An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
|
|
230
|
+
# @option opts [String] :sdk_name An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
|
|
231
|
+
# @option opts [String] :sdk_type An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
|
|
232
|
+
# @option opts [String] :anonymous An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`.
|
|
233
|
+
# @option opts [String] :group_by If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`.
|
|
234
|
+
# @option opts [String] :aggregation_type Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.
|
|
235
|
+
# @option opts [String] :granularity Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only.
|
|
236
|
+
# @return [SeriesListRep]
|
|
237
|
+
describe 'get_mau_total_usage test' do
|
|
238
|
+
it 'should work' do
|
|
239
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
240
|
+
end
|
|
241
|
+
end
|
|
242
|
+
|
|
202
243
|
# unit tests for get_mau_usage
|
|
203
244
|
# Get MAU usage
|
|
204
245
|
# Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.<br/><br/>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).
|
|
@@ -32,6 +32,20 @@ describe 'AIConfigsBetaApi' do
|
|
|
32
32
|
end
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# unit tests for delete_agent_graph
|
|
36
|
+
# Delete agent graph
|
|
37
|
+
# Delete an existing agent graph and all of its edges.
|
|
38
|
+
# @param ld_api_version Version of the endpoint.
|
|
39
|
+
# @param project_key
|
|
40
|
+
# @param graph_key
|
|
41
|
+
# @param [Hash] opts the optional parameters
|
|
42
|
+
# @return [nil]
|
|
43
|
+
describe 'delete_agent_graph test' do
|
|
44
|
+
it 'should work' do
|
|
45
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
|
|
35
49
|
# unit tests for delete_ai_config
|
|
36
50
|
# Delete AI Config
|
|
37
51
|
# Delete an existing AI Config.
|
|
@@ -103,6 +117,20 @@ describe 'AIConfigsBetaApi' do
|
|
|
103
117
|
end
|
|
104
118
|
end
|
|
105
119
|
|
|
120
|
+
# unit tests for get_agent_graph
|
|
121
|
+
# Get agent graph
|
|
122
|
+
# Retrieve a specific agent graph by its key, including its edges.
|
|
123
|
+
# @param ld_api_version Version of the endpoint.
|
|
124
|
+
# @param project_key
|
|
125
|
+
# @param graph_key
|
|
126
|
+
# @param [Hash] opts the optional parameters
|
|
127
|
+
# @return [AgentGraph]
|
|
128
|
+
describe 'get_agent_graph test' do
|
|
129
|
+
it 'should work' do
|
|
130
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
106
134
|
# unit tests for get_ai_config
|
|
107
135
|
# Get AI Config
|
|
108
136
|
# Retrieve a specific AI Config by its key.
|
|
@@ -225,6 +253,21 @@ describe 'AIConfigsBetaApi' do
|
|
|
225
253
|
end
|
|
226
254
|
end
|
|
227
255
|
|
|
256
|
+
# unit tests for list_agent_graphs
|
|
257
|
+
# List agent graphs
|
|
258
|
+
# Get a list of all agent graphs in the given project. Returns metadata only, without edge data.
|
|
259
|
+
# @param ld_api_version Version of the endpoint.
|
|
260
|
+
# @param project_key
|
|
261
|
+
# @param [Hash] opts the optional parameters
|
|
262
|
+
# @option opts [Integer] :limit The number of AI Configs to return.
|
|
263
|
+
# @option opts [Integer] :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`.
|
|
264
|
+
# @return [AgentGraphs]
|
|
265
|
+
describe 'list_agent_graphs test' do
|
|
266
|
+
it 'should work' do
|
|
267
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
268
|
+
end
|
|
269
|
+
end
|
|
270
|
+
|
|
228
271
|
# unit tests for list_ai_tool_versions
|
|
229
272
|
# List AI tool versions
|
|
230
273
|
# Get a list of all versions of an AI tool in the given project.
|
|
@@ -273,6 +316,21 @@ describe 'AIConfigsBetaApi' do
|
|
|
273
316
|
end
|
|
274
317
|
end
|
|
275
318
|
|
|
319
|
+
# unit tests for patch_agent_graph
|
|
320
|
+
# Update agent graph
|
|
321
|
+
# Edit an existing agent graph. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. If the update includes `rootConfigKey` or `edges`, both must be present and will be treated as full replacements.
|
|
322
|
+
# @param ld_api_version Version of the endpoint.
|
|
323
|
+
# @param project_key
|
|
324
|
+
# @param graph_key
|
|
325
|
+
# @param [Hash] opts the optional parameters
|
|
326
|
+
# @option opts [AgentGraphPatch] :agent_graph_patch Agent graph object to update
|
|
327
|
+
# @return [AgentGraph]
|
|
328
|
+
describe 'patch_agent_graph test' do
|
|
329
|
+
it 'should work' do
|
|
330
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
331
|
+
end
|
|
332
|
+
end
|
|
333
|
+
|
|
276
334
|
# unit tests for patch_ai_config
|
|
277
335
|
# Update AI Config
|
|
278
336
|
# 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\"] } ```
|
|
@@ -334,6 +392,20 @@ describe 'AIConfigsBetaApi' do
|
|
|
334
392
|
end
|
|
335
393
|
end
|
|
336
394
|
|
|
395
|
+
# unit tests for post_agent_graph
|
|
396
|
+
# Create new agent graph
|
|
397
|
+
# Create a new agent graph within the given project.
|
|
398
|
+
# @param ld_api_version Version of the endpoint.
|
|
399
|
+
# @param project_key
|
|
400
|
+
# @param agent_graph_post Agent graph object to create
|
|
401
|
+
# @param [Hash] opts the optional parameters
|
|
402
|
+
# @return [AgentGraph]
|
|
403
|
+
describe 'post_agent_graph test' do
|
|
404
|
+
it 'should work' do
|
|
405
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
406
|
+
end
|
|
407
|
+
end
|
|
408
|
+
|
|
337
409
|
# unit tests for post_ai_config
|
|
338
410
|
# Create new AI Config
|
|
339
411
|
# Create a new AI Config within the given project.
|
|
@@ -203,6 +203,7 @@ describe 'FeatureFlagsApi' do
|
|
|
203
203
|
# @param patch_with_comment
|
|
204
204
|
# @param [Hash] opts the optional parameters
|
|
205
205
|
# @option opts [Boolean] :ignore_conflicts If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.
|
|
206
|
+
# @option opts [Boolean] :dry_run If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied.
|
|
206
207
|
# @return [FeatureFlag]
|
|
207
208
|
describe 'patch_feature_flag test' do
|
|
208
209
|
it 'should work' do
|
|
@@ -248,6 +248,7 @@ describe 'SegmentsApi' do
|
|
|
248
248
|
# @param segment_key The segment key
|
|
249
249
|
# @param patch_with_comment
|
|
250
250
|
# @param [Hash] opts the optional parameters
|
|
251
|
+
# @option opts [Boolean] :dry_run If true, the patch will be validated but not persisted. Returns a preview of the segment after the patch is applied.
|
|
251
252
|
# @return [UserSegment]
|
|
252
253
|
describe 'patch_segment test' do
|
|
253
254
|
it 'should work' do
|
data/spec/api/tags_api_spec.rb
CHANGED
|
@@ -36,7 +36,7 @@ describe 'TagsApi' do
|
|
|
36
36
|
# List tags
|
|
37
37
|
# Get a list of tags.
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
|
-
# @option opts [Array<String>] :kind Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`, `aiconfig`, and `view`. Returns all types by default.
|
|
39
|
+
# @option opts [Array<String>] :kind Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`, `metric-data-source`, `aiconfig`, and `view`. Returns all types by default.
|
|
40
40
|
# @option opts [String] :pre Return tags with the specified prefix
|
|
41
41
|
# @option opts [Boolean] :archived Whether or not to return archived flags
|
|
42
42
|
# @option opts [Integer] :limit The number of tags to return. Maximum is 1000.
|