launchdarkly_api 5.4.0 → 7.1.0

data/docs/Webhook.md

@@ -1,15 +1,34 @@
 # LaunchDarklyApi::Webhook
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_links** | [**Links**](Links.md) |  | [optional] 
-**_id** | [**Id**](Id.md) |  | [optional] 
-**url** | **String** | The URL of the remote webhook. | [optional] 
-**secret** | **String** | If defined, the webhooks post request will include a X-LD-Signature header whose value will contain an HMAC SHA256 hex digest of the webhook payload, using the secret as the key. | [optional] 
-**on** | **BOOLEAN** | Whether this webhook is enabled or not. | [optional] 
-**name** | **String** | The name of the webhook. | [optional] 
-**statements** | [**Array<Statement>**](Statement.md) |  | [optional] 
-**tags** | **Array<String>** | Tags assigned to this webhook. | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **_id** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **url** | **String** |  |  |
+| **secret** | **String** |  | [optional] |
+| **statements** | [**Array<StatementRep>**](StatementRep.md) |  | [optional] |
+| **on** | **Boolean** |  |  |
+| **tags** | **Array<String>** |  |  |
+| **_access** | [**AccessRep**](AccessRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Webhook.new(
+  _links: null,
+  _id: 57be1db38b75bf0772d11384,
+  name: Example hook,
+  url: http://www.example.com,
+  secret: frobozz,
+  statements: null,
+  on: true,
+  tags: [],
+  _access: null
+)
+```
 

data/docs/WebhookPost.md

@@ -0,0 +1,30 @@
+# LaunchDarklyApi::WebhookPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A human-readable name for your webhook | [optional] |
+| **url** | **String** | The URL of the remote webhook |  |
+| **secret** | **String** | If sign is true, and the secret attribute is omitted, LaunchDarkly automatically generates a secret for you. | [optional] |
+| **statements** | [**Array<StatementPost>**](StatementPost.md) |  | [optional] |
+| **sign** | **Boolean** | If sign is false, the webhook does not include a signature header, and the secret can be omitted. |  |
+| **on** | **Boolean** | Whether or not this webhook is enabled. |  |
+| **tags** | **Array<String>** | List of tags for this webhook | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::WebhookPost.new(
+  name: Example hook,
+  url: http://www.example.com,
+  secret: frobozz,
+  statements: null,
+  sign: true,
+  on: true,
+  tags: []
+)
+```
+

data/docs/Webhooks.md

@@ -1,9 +1,20 @@
 # LaunchDarklyApi::Webhooks
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_links** | [**Links**](Links.md) |  | [optional] 
-**items** | [**Array<Webhook>**](Webhook.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **items** | [**Array<Webhook>**](Webhook.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Webhooks.new(
+  _links: null,
+  items: null
+)
+```
 

data/docs/WebhooksApi.md

@@ -1,51 +1,71 @@
 # LaunchDarklyApi::WebhooksApi
 
-All URIs are relative to *https://app.launchdarkly.com/api/v2*
+All URIs are relative to *https://app.launchdarkly.com*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{resourceId} | Delete a webhook by ID.
-[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{resourceId} | Get a webhook by ID.
-[**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Fetch a list of all webhooks.
-[**patch_webhook**](WebhooksApi.md#patch_webhook) | **PATCH** /webhooks/{resourceId} | Modify a webhook by ID.
-[**post_webhook**](WebhooksApi.md#post_webhook) | **POST** /webhooks | Create a webhook.
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /api/v2/webhooks/{id} | Delete webhook |
+| [**get_all_webhooks**](WebhooksApi.md#get_all_webhooks) | **GET** /api/v2/webhooks | List webhooks |
+| [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /api/v2/webhooks/{id} | Get webhook |
+| [**patch_webhook**](WebhooksApi.md#patch_webhook) | **PATCH** /api/v2/webhooks/{id} | Update webhook |
+| [**post_webhook**](WebhooksApi.md#post_webhook) | **POST** /api/v2/webhooks | Creates a webhook |
 
 
-# **delete_webhook**
-> delete_webhook(resource_id, )
+## delete_webhook
+
+> delete_webhook(id)
+
+Delete webhook
 
 Delete a webhook by ID.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::WebhooksApi.new
+id = 'id_example' # String | The ID of the webhook to delete
+
+begin
+  # Delete webhook
+  api_instance.delete_webhook(id)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling WebhooksApi->delete_webhook: #{e}"
+end
+```
 
-resource_id = 'resource_id_example' # String | The resource ID.
+#### Using the delete_webhook_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_webhook_with_http_info(id)
+
+```ruby
 begin
-  #Delete a webhook by ID.
-  api_instance.delete_webhook(resource_id, )
+  # Delete webhook
+  data, status_code, headers = api_instance.delete_webhook_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling WebhooksApi->delete_webhook: #{e}"
+  puts "Error when calling WebhooksApi->delete_webhook_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **resource_id** | **String**| The resource ID. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the webhook to delete |  |
 
 ### Return type
 
@@ -53,152 +73,211 @@ nil (empty response body)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_all_webhooks
 
+> <Webhooks> get_all_webhooks
 
+List webhooks
 
-# **get_webhook**
-> Webhook get_webhook(resource_id, )
+Fetch a list of all webhooks.
 
-Get a webhook by ID.
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::WebhooksApi.new
 
-resource_id = 'resource_id_example' # String | The resource ID.
+begin
+  # List webhooks
+  result = api_instance.get_all_webhooks
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling WebhooksApi->get_all_webhooks: #{e}"
+end
+```
+
+#### Using the get_all_webhooks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<Webhooks>, Integer, Hash)> get_all_webhooks_with_http_info
 
+```ruby
 begin
-  #Get a webhook by ID.
-  result = api_instance.get_webhook(resource_id, )
-  p result
+  # List webhooks
+  data, status_code, headers = api_instance.get_all_webhooks_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhooks>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling WebhooksApi->get_webhook: #{e}"
+  puts "Error when calling WebhooksApi->get_all_webhooks_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **resource_id** | **String**| The resource ID. | 
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**Webhook**](Webhook.md)
+[**Webhooks**](Webhooks.md)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_webhook
 
-# **get_webhooks**
-> Webhooks get_webhooks
+> <Webhook> get_webhook(id)
 
-Fetch a list of all webhooks.
+Get webhook
+
+Get a single webhook by ID.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::WebhooksApi.new
+id = 'id_example' # String | The ID of the webhook
 
 begin
-  #Fetch a list of all webhooks.
-  result = api_instance.get_webhooks
+  # Get webhook
+  result = api_instance.get_webhook(id)
   p result
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling WebhooksApi->get_webhooks: #{e}"
+  puts "Error when calling WebhooksApi->get_webhook: #{e}"
+end
+```
+
+#### Using the get_webhook_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Webhook>, Integer, Hash)> get_webhook_with_http_info(id)
+
+```ruby
+begin
+  # Get webhook
+  data, status_code, headers = api_instance.get_webhook_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling WebhooksApi->get_webhook_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the webhook |  |
 
 ### Return type
 
-[**Webhooks**](Webhooks.md)
+[**Webhook**](Webhook.md)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
 
+## patch_webhook
 
+> <Webhook> patch_webhook(id, patch_operation)
 
-# **patch_webhook**
-> Webhook patch_webhook(resource_id, patch_delta)
+Update webhook
 
-Modify a webhook by ID.
+Update a webhook's settings. The request should be a valid JSON Patch document describing the changes to be made to the webhook.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::WebhooksApi.new
+id = 'id_example' # String | The ID of the webhook to update
+patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})] # Array<PatchOperation> | 
+
+begin
+  # Update webhook
+  result = api_instance.patch_webhook(id, patch_operation)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling WebhooksApi->patch_webhook: #{e}"
+end
+```
 
-resource_id = 'resource_id_example' # String | The resource ID.
+#### Using the patch_webhook_with_http_info variant
 
-patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<Webhook>, Integer, Hash)> patch_webhook_with_http_info(id, patch_operation)
 
+```ruby
 begin
-  #Modify a webhook by ID.
-  result = api_instance.patch_webhook(resource_id, patch_delta)
-  p result
+  # Update webhook
+  data, status_code, headers = api_instance.patch_webhook_with_http_info(id, patch_operation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling WebhooksApi->patch_webhook: #{e}"
+  puts "Error when calling WebhooksApi->patch_webhook_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **resource_id** | **String**| The resource ID. | 
- **patch_delta** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the webhook to update |  |
+| **patch_operation** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md) |  |  |
 
 ### Return type
 
@@ -206,51 +285,70 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
+
 
+## post_webhook
 
+> <Webhook> post_webhook(webhook_post)
 
-# **post_webhook**
-> Webhook post_webhook(webhook_body)
+Creates a webhook
 
-Create a webhook.
+Create a new webhook
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::WebhooksApi.new
+webhook_post = LaunchDarklyApi::WebhookPost.new({url: 'http://www.example.com', sign: true, on: true}) # WebhookPost | 
+
+begin
+  # Creates a webhook
+  result = api_instance.post_webhook(webhook_post)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling WebhooksApi->post_webhook: #{e}"
+end
+```
+
+#### Using the post_webhook_with_http_info variant
 
-webhook_body = LaunchDarklyApi::WebhookBody.new # WebhookBody | New webhook.
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<Webhook>, Integer, Hash)> post_webhook_with_http_info(webhook_post)
 
+```ruby
 begin
-  #Create a webhook.
-  result = api_instance.post_webhook(webhook_body)
-  p result
+  # Creates a webhook
+  data, status_code, headers = api_instance.post_webhook_with_http_info(webhook_post)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling WebhooksApi->post_webhook: #{e}"
+  puts "Error when calling WebhooksApi->post_webhook_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **webhook_body** | [**WebhookBody**](WebhookBody.md)| New webhook. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_post** | [**WebhookPost**](WebhookPost.md) |  |  |
 
 ### Return type
 
@@ -258,12 +356,10 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/WeightedVariation.md

@@ -1,9 +1,22 @@
 # LaunchDarklyApi::WeightedVariation
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**variation** | **Integer** |  | [optional] 
-**weight** | **Integer** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variation** | **Integer** |  |  |
+| **weight** | **Integer** |  |  |
+| **_untracked** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::WeightedVariation.new(
+  variation: null,
+  weight: null,
+  _untracked: null
+)
+```