launchdarkly_api 8.0.0 → 10.0.0

data/docs/MetricInput.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::MetricInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **primary** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MetricInput.new(
+  key: null,
+  primary: null
+)
+```
+

data/docs/MetricPost.md

@@ -4,18 +4,18 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **key** | **String** |  |  |
-| **name** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **kind** | **String** |  |  |
-| **selector** | **String** | Required for click metrics | [optional] |
-| **urls** | [**Array<UrlPost>**](UrlPost.md) | Required for click and pageview metrics | [optional] |
-| **is_active** | **Boolean** |  | [optional] |
-| **is_numeric** | **Boolean** |  | [optional] |
-| **unit** | **String** |  | [optional] |
-| **event_key** | **String** | Required for custom metrics | [optional] |
-| **success_criteria** | **String** |  | [optional] |
-| **tags** | **Array<String>** |  | [optional] |
+| **key** | **String** | A unique key to reference the metric |  |
+| **name** | **String** | A human-friendly name for the metric | [optional] |
+| **description** | **String** | Description of the metric | [optional] |
+| **kind** | **String** | The kind of event your metric will track |  |
+| **selector** | **String** | One or more CSS selectors. Required for click metrics. | [optional] |
+| **urls** | [**Array<UrlPost>**](UrlPost.md) | One or more target URLs. Required for click and pageview metrics. | [optional] |
+| **is_active** | **Boolean** | Whether to track a conversion when users take an action. Required for custom metrics. Either <code>isActive</code> or <code>isNumeric</code> may be true, but not both. | [optional] |
+| **is_numeric** | **Boolean** | Whether to track numeric changes in value against a baseline. Required for custom metrics. Either <code>isActive</code> or <code>isNumeric</code> may be true, but not both. | [optional] |
+| **unit** | **String** | The unit of measure. Only for numeric custom metrics. | [optional] |
+| **event_key** | **String** | The event name to use in your code. Required for custom metrics. | [optional] |
+| **success_criteria** | **String** | Success criteria. Required for numeric custom metrics. | [optional] |
+| **tags** | **Array<String>** | Tags for the metric | [optional] |
 
 ## Example
 
@@ -23,18 +23,18 @@
 require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::MetricPost.new(
-  key: null,
-  name: null,
-  description: null,
-  kind: null,
-  selector: null,
-  urls: null,
-  is_active: null,
-  is_numeric: null,
-  unit: null,
-  event_key: null,
-  success_criteria: null,
-  tags: null
+  key: example-metric,
+  name: Example metric,
+  description: optional description,
+  kind: custom,
+  selector: .dropdown-toggle,
+  urls: invalid example,
+  is_active: true,
+  is_numeric: false,
+  unit: orders,
+  event_key: sales generated,
+  success_criteria: Higher than baseline,
+  tags: ["example-tag"]
 )
 ```
 

data/docs/MetricRep.md

@@ -26,7 +26,7 @@
 | **_attached_features** | [**Array<FlagListingRep>**](FlagListingRep.md) |  | [optional] |
 | **_version** | **Integer** |  | [optional] |
 | **selector** | **String** |  | [optional] |
-| **urls** | **Array<Object>** |  | [optional] |
+| **urls** | **Array<Hash>** |  | [optional] |
 
 ## Example
 

data/docs/MetricV2Rep.md

@@ -0,0 +1,24 @@
+# LaunchDarklyApi::MetricV2Rep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **name** | **String** |  |  |
+| **kind** | **String** |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MetricV2Rep.new(
+  key: null,
+  name: null,
+  kind: null,
+  _links: {"self":{"href":"/api/v2/metrics/my-project/my-metric","type":"application/json"}}
+)
+```
+

data/docs/MetricsApi.md

@@ -308,7 +308,7 @@ end
 
 Create metric
 
-Create a new metric in the specified project. Note that the expected POST body differs depending on the specified kind property.
+Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property.
 
 ### Examples
 
@@ -325,7 +325,7 @@ end
 
 api_instance = LaunchDarklyApi::MetricsApi.new
 project_key = 'project_key_example' # String | The project key
-metric_post = LaunchDarklyApi::MetricPost.new({key: 'key_example', kind: 'pageview'}) # MetricPost | 
+metric_post = LaunchDarklyApi::MetricPost.new({key: 'example-metric', kind: 'pageview'}) # MetricPost | 
 
 begin
   # Create metric

data/docs/NewMemberForm.md

@@ -9,7 +9,7 @@
 | **first_name** | **String** | The member's first name | [optional] |
 | **last_name** | **String** | The member's last name | [optional] |
 | **role** | **String** | The member's built-in role | [optional] |
-| **custom_roles** | **Array<String>** | The member's custom role | [optional] |
+| **custom_roles** | **Array<String>** | An array of the member's custom roles | [optional] |
 
 ## Example
 
@@ -17,12 +17,12 @@
 require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::NewMemberForm.new(
-  email: null,
-  password: null,
-  first_name: null,
-  last_name: null,
-  role: null,
-  custom_roles: null
+  email: sandy@acme.com,
+  password: ***,
+  first_name: Sandy,
+  last_name: Smith,
+  role: reader,
+  custom_roles: ["customRole1","customRole2"]
 )
 ```
 

data/docs/NotFoundErrorRep.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** |  | [optional] |
-| **message** | **String** |  | [optional] |
+| **code** | **String** | Specific error code encountered | [optional] |
+| **message** | **String** | Description of the error | [optional] |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::NotFoundErrorRep.new(
   code: not_found,
-  message: resource not found
+  message: Invalid resource identifier
 )
 ```
 

data/docs/OAuth2ClientsBetaApi.md

@@ -0,0 +1,365 @@
+# LaunchDarklyApi::OAuth2ClientsBetaApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_o_auth2_client**](OAuth2ClientsBetaApi.md#create_o_auth2_client) | **POST** /api/v2/oauth/clients | Create a LaunchDarkly OAuth 2.0 client |
+| [**delete_o_auth_client**](OAuth2ClientsBetaApi.md#delete_o_auth_client) | **DELETE** /api/v2/oauth/clients/{clientId} | Delete OAuth 2.0 client |
+| [**get_o_auth_client_by_id**](OAuth2ClientsBetaApi.md#get_o_auth_client_by_id) | **GET** /api/v2/oauth/clients/{clientId} | Get client by ID |
+| [**get_o_auth_clients**](OAuth2ClientsBetaApi.md#get_o_auth_clients) | **GET** /api/v2/oauth/clients | Get clients |
+| [**patch_o_auth_client**](OAuth2ClientsBetaApi.md#patch_o_auth_client) | **PATCH** /api/v2/oauth/clients/{clientId} | Patch client by ID |
+
+
+## create_o_auth2_client
+
+> <Client> create_o_auth2_client(oauth_client_post)
+
+Create a LaunchDarkly OAuth 2.0 client
+
+Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::OAuth2ClientsBetaApi.new
+oauth_client_post = LaunchDarklyApi::OauthClientPost.new # OauthClientPost | 
+
+begin
+  # Create a LaunchDarkly OAuth 2.0 client
+  result = api_instance.create_o_auth2_client(oauth_client_post)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->create_o_auth2_client: #{e}"
+end
+```
+
+#### Using the create_o_auth2_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Client>, Integer, Hash)> create_o_auth2_client_with_http_info(oauth_client_post)
+
+```ruby
+begin
+  # Create a LaunchDarkly OAuth 2.0 client
+  data, status_code, headers = api_instance.create_o_auth2_client_with_http_info(oauth_client_post)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Client>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->create_o_auth2_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **oauth_client_post** | [**OauthClientPost**](OauthClientPost.md) |  |  |
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_o_auth_client
+
+> delete_o_auth_client(client_id)
+
+Delete OAuth 2.0 client
+
+Delete an existing OAuth 2.0 client by unique client ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::OAuth2ClientsBetaApi.new
+client_id = 'client_id_example' # String | The client ID
+
+begin
+  # Delete OAuth 2.0 client
+  api_instance.delete_o_auth_client(client_id)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->delete_o_auth_client: #{e}"
+end
+```
+
+#### Using the delete_o_auth_client_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_o_auth_client_with_http_info(client_id)
+
+```ruby
+begin
+  # Delete OAuth 2.0 client
+  data, status_code, headers = api_instance.delete_o_auth_client_with_http_info(client_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->delete_o_auth_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The client ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_o_auth_client_by_id
+
+> <Client> get_o_auth_client_by_id(client_id)
+
+Get client by ID
+
+Get a registered OAuth 2.0 client by unique client ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::OAuth2ClientsBetaApi.new
+client_id = 'client_id_example' # String | The client ID
+
+begin
+  # Get client by ID
+  result = api_instance.get_o_auth_client_by_id(client_id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->get_o_auth_client_by_id: #{e}"
+end
+```
+
+#### Using the get_o_auth_client_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Client>, Integer, Hash)> get_o_auth_client_by_id_with_http_info(client_id)
+
+```ruby
+begin
+  # Get client by ID
+  data, status_code, headers = api_instance.get_o_auth_client_by_id_with_http_info(client_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Client>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->get_o_auth_client_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The client ID |  |
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_o_auth_clients
+
+> <ClientCollection> get_o_auth_clients
+
+Get clients
+
+Get all OAuth 2.0 clients registered by your account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::OAuth2ClientsBetaApi.new
+
+begin
+  # Get clients
+  result = api_instance.get_o_auth_clients
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->get_o_auth_clients: #{e}"
+end
+```
+
+#### Using the get_o_auth_clients_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientCollection>, Integer, Hash)> get_o_auth_clients_with_http_info
+
+```ruby
+begin
+  # Get clients
+  data, status_code, headers = api_instance.get_o_auth_clients_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientCollection>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->get_o_auth_clients_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ClientCollection**](ClientCollection.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_o_auth_client
+
+> <Client> patch_o_auth_client(client_id, patch_operation)
+
+Patch client by ID
+
+Patch an existing OAuth 2.0 client by client ID. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the client. Only `name`, `description`, and `redirectUri` may be patched.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::OAuth2ClientsBetaApi.new
+client_id = 'client_id_example' # String | The client ID
+patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField', value: new example value})] # Array<PatchOperation> | 
+
+begin
+  # Patch client by ID
+  result = api_instance.patch_o_auth_client(client_id, patch_operation)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->patch_o_auth_client: #{e}"
+end
+```
+
+#### Using the patch_o_auth_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Client>, Integer, Hash)> patch_o_auth_client_with_http_info(client_id, patch_operation)
+
+```ruby
+begin
+  # Patch client by ID
+  data, status_code, headers = api_instance.patch_o_auth_client_with_http_info(client_id, patch_operation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Client>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OAuth2ClientsBetaApi->patch_o_auth_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | The client ID |  |
+| **patch_operation** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md) |  |  |
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OauthClientPost.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::OauthClientPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of your new LaunchDarkly OAuth 2.0 client. | [optional] |
+| **redirect_uri** | **String** | The redirect URI for your new OAuth 2.0 application. This should be an absolute URL conforming with the standard HTTPS protocol. | [optional] |
+| **description** | **String** | Description of your OAuth 2.0 client. | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::OauthClientPost.new(
+  name: null,
+  redirect_uri: null,
+  description: null
+)
+```
+

data/docs/OtherApi.md

@@ -16,7 +16,7 @@ All URIs are relative to *https://app.launchdarkly.com*
 
 Gets the public IP list
 
-Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall.<br /><br />This endpoint returns a JSON object with two attributes: `addresses` and `outboundAddresses`. The `addresses` element contains the IP addresses LaunchDarkly's service uses. The `outboundAddresses` element contains the IP addresses outgoing webhook notifications use.<br /><br />We post upcoming changes to this list in advance on our [status page](https://status.launchdarkly.com/).
+Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall. <br /><br />This endpoint returns a JSON object with two attributes: `addresses` and `outboundAddresses`. The `addresses` element contains the IP addresses LaunchDarkly's service uses. The `outboundAddresses` element contains the IP addresses outgoing webhook notifications use.<br /><br />We post upcoming changes to this list in advance on our [status page](https://status.launchdarkly.com/). <br /><br />In the sandbox, click 'Try it' and enter any string in the 'Authorization' field to test this endpoint.
 
 ### Examples
 
@@ -84,7 +84,7 @@ This endpoint does not need any parameter.
 
 Gets the OpenAPI spec in json
 
-The OpenAPI spec endpoint serves the latest version of the OpenAPI specification for LaunchDarkly's API in json format.
+Get the latest version of the OpenAPI specification for LaunchDarkly's API in JSON format. In the sandbox, click 'Try it' and enter any string in the 'Authorization' field to test this endpoint.
 
 ### Examples
 
@@ -151,7 +151,7 @@ nil (empty response body)
 
 Root resource
 
-Issue a `GET` request to the root resource to find all of the resource categories supported by the API
+Get all of the resource categories the API supports. In the sandbox, click 'Try it' and enter any string in the 'Authorization' field to test this endpoint.
 
 ### Examples
 

data/docs/ParameterDefault.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::ParameterDefault
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Object** | The default value for the given parameter | [optional] |
+| **boolean_variation_value** | **Boolean** | Variation value for boolean flags. Not applicable for non-boolean flags. | [optional] |
+| **rule_clause** | [**RuleClause**](RuleClause.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ParameterDefault.new(
+  value: null,
+  boolean_variation_value: null,
+  rule_clause: null
+)
+```
+

data/docs/ParameterRep.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ParameterRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variation_id** | **String** |  | [optional] |
+| **flag_key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ParameterRep.new(
+  variation_id: null,
+  flag_key: null
+)
+```
+

data/docs/ParentResourceRep.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
 | **name** | **String** |  | [optional] |
-| **resource** | **Object** |  | [optional] |
+| **resource** | **Hash<String, Object>** |  | [optional] |
 
 ## Example
 

data/docs/PatchFailedErrorRep.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** |  | [optional] |
-| **message** | **String** |  | [optional] |
+| **code** | **String** | Specific error code encountered | [optional] |
+| **message** | **String** | Description of the error | [optional] |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::PatchFailedErrorRep.new(
   code: patch_failed,
-  message: could not apply patch
+  message: Unprocessable entity. Could not apply patch.
 )
 ```