launchdarkly_api 5.4.0 → 6.0.0

data/docs/Modification.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::Modification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Modification.new(
+  date: 2021-08-05T19:46:31.148082Z
+)
+```
+

data/docs/MultiEnvironmentDependentFlag.md

@@ -1,12 +1,22 @@
 # LaunchDarklyApi::MultiEnvironmentDependentFlag
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** |  | [optional] 
-**key** | **String** |  | [optional] 
-**environments** | [**Array<DependentFlagEnvironment>**](DependentFlagEnvironment.md) |  | [optional] 
-**_links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) |  | [optional] 
-**_site** | [**Site**](Site.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **key** | **String** |  |  |
+| **environments** | [**Array<DependentFlagEnvironment>**](DependentFlagEnvironment.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MultiEnvironmentDependentFlag.new(
+  name: null,
+  key: null,
+  environments: null
+)
+```
 

data/docs/MultiEnvironmentDependentFlags.md

@@ -1,10 +1,22 @@
 # LaunchDarklyApi::MultiEnvironmentDependentFlags
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | [**Array<MultiEnvironmentDependentFlag>**](MultiEnvironmentDependentFlag.md) |  | [optional] 
-**_links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) |  | [optional] 
-**_site** | [**Site**](Site.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<MultiEnvironmentDependentFlag>**](MultiEnvironmentDependentFlag.md) |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **_site** | [**Link**](Link.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MultiEnvironmentDependentFlags.new(
+  items: null,
+  _links: null,
+  _site: null
+)
+```
 

data/docs/NewMemberForm.md

@@ -0,0 +1,28 @@
+# LaunchDarklyApi::NewMemberForm
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The member's email |  |
+| **password** | **String** | The member's password | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::NewMemberForm.new(
+  email: null,
+  password: null,
+  first_name: null,
+  last_name: null,
+  role: null,
+  custom_roles: null
+)
+```
+

data/docs/OtherApi.md

@@ -0,0 +1,282 @@
+# LaunchDarklyApi::OtherApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_ips**](OtherApi.md#get_ips) | **GET** /api/v2/public-ip-list | Gets the public IP list |
+| [**get_openapi_spec**](OtherApi.md#get_openapi_spec) | **GET** /api/v2/openapi.json | Gets the OpenAPI spec in json |
+| [**get_root**](OtherApi.md#get_root) | **GET** /api/v2 | Root resource |
+| [**get_versions**](OtherApi.md#get_versions) | **GET** /api/v2/versions | Get version information |
+
+
+## get_ips
+
+> <IpList> get_ips
+
+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/).
+
+### 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::OtherApi.new
+
+begin
+  # Gets the public IP list
+  result = api_instance.get_ips
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_ips: #{e}"
+end
+```
+
+#### Using the get_ips_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IpList>, Integer, Hash)> get_ips_with_http_info
+
+```ruby
+begin
+  # Gets the public IP list
+  data, status_code, headers = api_instance.get_ips_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IpList>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_ips_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**IpList**](IpList.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_openapi_spec
+
+> get_openapi_spec
+
+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.
+
+### 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::OtherApi.new
+
+begin
+  # Gets the OpenAPI spec in json
+  api_instance.get_openapi_spec
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_openapi_spec: #{e}"
+end
+```
+
+#### Using the get_openapi_spec_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)> get_openapi_spec_with_http_info
+
+```ruby
+begin
+  # Gets the OpenAPI spec in json
+  data, status_code, headers = api_instance.get_openapi_spec_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_openapi_spec_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_root
+
+> <Hash<String, InlineResponse200>> get_root
+
+Root resource
+
+Issue a `GET` request to the root resource to find all of the resource categories supported by the API
+
+### 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::OtherApi.new
+
+begin
+  # Root resource
+  result = api_instance.get_root
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_root: #{e}"
+end
+```
+
+#### Using the get_root_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Hash<String, InlineResponse200>>, Integer, Hash)> get_root_with_http_info
+
+```ruby
+begin
+  # Root resource
+  data, status_code, headers = api_instance.get_root_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Hash<String, InlineResponse200>>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_root_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Hash&lt;String, InlineResponse200&gt;**](InlineResponse200.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_versions
+
+> <VersionsRep> get_versions
+
+Get version information
+
+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.
+
+### 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::OtherApi.new
+
+begin
+  # Get version information
+  result = api_instance.get_versions
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_versions: #{e}"
+end
+```
+
+#### Using the get_versions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VersionsRep>, Integer, Hash)> get_versions_with_http_info
+
+```ruby
+begin
+  # Get version information
+  data, status_code, headers = api_instance.get_versions_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VersionsRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling OtherApi->get_versions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VersionsRep**](VersionsRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ParentResourceRep.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::ParentResourceRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **resource** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ParentResourceRep.new(
+  _links: null,
+  name: null,
+  resource: null
+)
+```
+

data/docs/PatchOperation.md

@@ -1,10 +1,22 @@
 # LaunchDarklyApi::PatchOperation
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**op** | **String** |  | 
-**path** | **String** |  | 
-**value** | **Object** |  | 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | **String** | The type of operation to perform |  |
+| **path** | **String** | A JSON Pointer string specifying the part of the document to operate on |  |
+| **value** | **Object** | A JSON value used in \"add\", \"replace\", and \"test\" operations |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::PatchOperation.new(
+  op: replace,
+  path: /biscuits,
+  value: Chocolate Digestive
+)
+```
 

data/docs/PatchSegmentInstruction.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::PatchSegmentInstruction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** |  |  |
+| **user_key** | **String** | A unique key used to represent the user |  |
+| **target_type** | **String** | A segment's target type. Must be either <code>included</code> or <code>excluded</code> |  |
+| **value** | **Integer** | Schedule user target expiration on a segment by including a timestamp | [optional] |
+| **version** | **Integer** | Required if <code>kind</code> is <code>updateExpireUserTargetDate</code> | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::PatchSegmentInstruction.new(
+  kind: null,
+  user_key: null,
+  target_type: null,
+  value: null,
+  version: null
+)
+```
+