statsig_console_sdk 0.1.0

data/docs/HoldoutsApi.md

@@ -0,0 +1,843 @@
+# StatsigConsoleSDK::HoldoutsApi
+
+All URIs are relative to *https://statsigapi.net*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**console_v1_holdouts_get**](HoldoutsApi.md#console_v1_holdouts_get) | **GET** /console/v1/holdouts | List Holdouts |
+| [**console_v1_holdouts_id_delete**](HoldoutsApi.md#console_v1_holdouts_id_delete) | **DELETE** /console/v1/holdouts/{id} | Delete holdout by id |
+| [**console_v1_holdouts_id_get**](HoldoutsApi.md#console_v1_holdouts_id_get) | **GET** /console/v1/holdouts/{id} | Get holdout by id |
+| [**console_v1_holdouts_id_overrides_delete**](HoldoutsApi.md#console_v1_holdouts_id_overrides_delete) | **DELETE** /console/v1/holdouts/{id}/overrides | Remove Holdout Overrides |
+| [**console_v1_holdouts_id_overrides_get**](HoldoutsApi.md#console_v1_holdouts_id_overrides_get) | **GET** /console/v1/holdouts/{id}/overrides | Read Holdout Overrides |
+| [**console_v1_holdouts_id_overrides_patch**](HoldoutsApi.md#console_v1_holdouts_id_overrides_patch) | **PATCH** /console/v1/holdouts/{id}/overrides | Add Holdout Overrides |
+| [**console_v1_holdouts_id_overrides_post**](HoldoutsApi.md#console_v1_holdouts_id_overrides_post) | **POST** /console/v1/holdouts/{id}/overrides | Update Holdout Overrides |
+| [**console_v1_holdouts_id_patch**](HoldoutsApi.md#console_v1_holdouts_id_patch) | **PATCH** /console/v1/holdouts/{id} | Patch holdout by id. You can pass in only the data you want to update. |
+| [**console_v1_holdouts_id_post**](HoldoutsApi.md#console_v1_holdouts_id_post) | **POST** /console/v1/holdouts/{id} | Update holdout by id |
+| [**console_v1_holdouts_id_pulse_results_get**](HoldoutsApi.md#console_v1_holdouts_id_pulse_results_get) | **GET** /console/v1/holdouts/{id}/pulse_results | Retrieve Pulse Results |
+| [**console_v1_holdouts_post**](HoldoutsApi.md#console_v1_holdouts_post) | **POST** /console/v1/holdouts | Create holdout |
+
+
+## console_v1_holdouts_get
+
+> <ConsoleV1HoldoutsGet200Response> console_v1_holdouts_get(opts)
+
+List Holdouts
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+opts = {
+  creator_name: 'creator_name_example', # String | Name of the creator.
+  creator_id: 'creator_id_example', # String | ID of the user who created the entity.
+  tags: nil, # ConsoleV1AlertsGetTagsParameter | Filter by tags
+  limit: 10, # Integer | Results per page
+  page: 1, # Integer | Page number
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # List Holdouts
+  result = api_instance.console_v1_holdouts_get(opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_get: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsGet200Response>, Integer, Hash)> console_v1_holdouts_get_with_http_info(opts)
+
+```ruby
+begin
+  # List Holdouts
+  data, status_code, headers = api_instance.console_v1_holdouts_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsGet200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creator_name** | **String** | Name of the creator. | [optional] |
+| **creator_id** | **String** | ID of the user who created the entity. | [optional] |
+| **tags** | [**ConsoleV1AlertsGetTagsParameter**](.md) | Filter by tags | [optional] |
+| **limit** | **Integer** | Results per page | [optional] |
+| **page** | **Integer** | Page number | [optional] |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsGet200Response**](ConsoleV1HoldoutsGet200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_delete
+
+> <ConsoleV1HoldoutsIdDelete200Response> console_v1_holdouts_id_delete(id, opts)
+
+Delete holdout by id
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Delete holdout by id
+  result = api_instance.console_v1_holdouts_id_delete(id, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_delete: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdDelete200Response>, Integer, Hash)> console_v1_holdouts_id_delete_with_http_info(id, opts)
+
+```ruby
+begin
+  # Delete holdout by id
+  data, status_code, headers = api_instance.console_v1_holdouts_id_delete_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdDelete200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdDelete200Response**](ConsoleV1HoldoutsIdDelete200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_get
+
+> <ConsoleV1HoldoutsIdGet200Response> console_v1_holdouts_id_get(id, opts)
+
+Get holdout by id
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Get holdout by id
+  result = api_instance.console_v1_holdouts_id_get(id, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_get: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdGet200Response>, Integer, Hash)> console_v1_holdouts_id_get_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get holdout by id
+  data, status_code, headers = api_instance.console_v1_holdouts_id_get_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdGet200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdGet200Response**](ConsoleV1HoldoutsIdGet200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_overrides_delete
+
+> <ConsoleV1HoldoutsIdOverridesDelete200Response> console_v1_holdouts_id_overrides_delete(id, opts)
+
+Remove Holdout Overrides
+
+Remove selected ids from an id list
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Remove Holdout Overrides
+  result = api_instance.console_v1_holdouts_id_overrides_delete(id, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_delete: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_overrides_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdOverridesDelete200Response>, Integer, Hash)> console_v1_holdouts_id_overrides_delete_with_http_info(id, opts)
+
+```ruby
+begin
+  # Remove Holdout Overrides
+  data, status_code, headers = api_instance.console_v1_holdouts_id_overrides_delete_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdOverridesDelete200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdOverridesDelete200Response**](ConsoleV1HoldoutsIdOverridesDelete200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_overrides_get
+
+> <ConsoleV1HoldoutsIdOverridesGet200Response> console_v1_holdouts_id_overrides_get(id, opts)
+
+Read Holdout Overrides
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Read Holdout Overrides
+  result = api_instance.console_v1_holdouts_id_overrides_get(id, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_get: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_overrides_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdOverridesGet200Response>, Integer, Hash)> console_v1_holdouts_id_overrides_get_with_http_info(id, opts)
+
+```ruby
+begin
+  # Read Holdout Overrides
+  data, status_code, headers = api_instance.console_v1_holdouts_id_overrides_get_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdOverridesGet200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdOverridesGet200Response**](ConsoleV1HoldoutsIdOverridesGet200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_overrides_patch
+
+> <ConsoleV1HoldoutsIdOverridesPost200Response> console_v1_holdouts_id_overrides_patch(id, update_overrides_contract_dto, opts)
+
+Add Holdout Overrides
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+update_overrides_contract_dto = StatsigConsoleSDK::UpdateOverridesContractDtoOneOf.new({environment_overrides: [StatsigConsoleSDK::OverrideDtoEnvironmentOverridesInner.new({unit_id: 'unit123', passing_ids: ["id1", "id2"], failing_ids: ["id3", "id4"]})]}) # UpdateOverridesContractDto | 
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Add Holdout Overrides
+  result = api_instance.console_v1_holdouts_id_overrides_patch(id, update_overrides_contract_dto, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_patch: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_overrides_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdOverridesPost200Response>, Integer, Hash)> console_v1_holdouts_id_overrides_patch_with_http_info(id, update_overrides_contract_dto, opts)
+
+```ruby
+begin
+  # Add Holdout Overrides
+  data, status_code, headers = api_instance.console_v1_holdouts_id_overrides_patch_with_http_info(id, update_overrides_contract_dto, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdOverridesPost200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **update_overrides_contract_dto** | [**UpdateOverridesContractDto**](UpdateOverridesContractDto.md) |  |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdOverridesPost200Response**](ConsoleV1HoldoutsIdOverridesPost200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_overrides_post
+
+> <ConsoleV1HoldoutsIdOverridesPost200Response> console_v1_holdouts_id_overrides_post(id, update_overrides_contract_dto, opts)
+
+Update Holdout Overrides
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+update_overrides_contract_dto = StatsigConsoleSDK::UpdateOverridesContractDtoOneOf.new({environment_overrides: [StatsigConsoleSDK::OverrideDtoEnvironmentOverridesInner.new({unit_id: 'unit123', passing_ids: ["id1", "id2"], failing_ids: ["id3", "id4"]})]}) # UpdateOverridesContractDto | 
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Update Holdout Overrides
+  result = api_instance.console_v1_holdouts_id_overrides_post(id, update_overrides_contract_dto, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_post: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_overrides_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdOverridesPost200Response>, Integer, Hash)> console_v1_holdouts_id_overrides_post_with_http_info(id, update_overrides_contract_dto, opts)
+
+```ruby
+begin
+  # Update Holdout Overrides
+  data, status_code, headers = api_instance.console_v1_holdouts_id_overrides_post_with_http_info(id, update_overrides_contract_dto, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdOverridesPost200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_overrides_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **update_overrides_contract_dto** | [**UpdateOverridesContractDto**](UpdateOverridesContractDto.md) |  |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdOverridesPost200Response**](ConsoleV1HoldoutsIdOverridesPost200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_patch
+
+> <ConsoleV1HoldoutsIdPatch200Response> console_v1_holdouts_id_patch(id, holdout_partial_update_contract_dto, opts)
+
+Patch holdout by id. You can pass in only the data you want to update.
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+holdout_partial_update_contract_dto = StatsigConsoleSDK::HoldoutPartialUpdateContractDto.new # HoldoutPartialUpdateContractDto | 
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Patch holdout by id. You can pass in only the data you want to update.
+  result = api_instance.console_v1_holdouts_id_patch(id, holdout_partial_update_contract_dto, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_patch: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdPatch200Response>, Integer, Hash)> console_v1_holdouts_id_patch_with_http_info(id, holdout_partial_update_contract_dto, opts)
+
+```ruby
+begin
+  # Patch holdout by id. You can pass in only the data you want to update.
+  data, status_code, headers = api_instance.console_v1_holdouts_id_patch_with_http_info(id, holdout_partial_update_contract_dto, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdPatch200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **holdout_partial_update_contract_dto** | [**HoldoutPartialUpdateContractDto**](HoldoutPartialUpdateContractDto.md) |  |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdPatch200Response**](ConsoleV1HoldoutsIdPatch200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_post
+
+> <ConsoleV1HoldoutsIdPost200Response> console_v1_holdouts_id_post(id, holdout_full_update_contract_dto, opts)
+
+Update holdout by id
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+holdout_full_update_contract_dto = StatsigConsoleSDK::HoldoutFullUpdateContractDto.new({is_enabled: true, description: 'example holdout description', pass_percentage: 5, gate_ids: ["4pjeXYDjC2WinSgOiII7wh"], experiment_ids: ["70fCNphHGesdLwHdHau99q"], layer_ids: ["5O908pyGoCqw6QH1nt8v82"], is_global: false, targeting_gate_id: '4pjeXYDjC2WinSgOiII7wh'}) # HoldoutFullUpdateContractDto | 
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Update holdout by id
+  result = api_instance.console_v1_holdouts_id_post(id, holdout_full_update_contract_dto, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_post: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdPost200Response>, Integer, Hash)> console_v1_holdouts_id_post_with_http_info(id, holdout_full_update_contract_dto, opts)
+
+```ruby
+begin
+  # Update holdout by id
+  data, status_code, headers = api_instance.console_v1_holdouts_id_post_with_http_info(id, holdout_full_update_contract_dto, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdPost200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **holdout_full_update_contract_dto** | [**HoldoutFullUpdateContractDto**](HoldoutFullUpdateContractDto.md) |  |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdPost200Response**](ConsoleV1HoldoutsIdPost200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## console_v1_holdouts_id_pulse_results_get
+
+> <ConsoleV1HoldoutsIdPulseResultsGet200Response> console_v1_holdouts_id_pulse_results_get(id, opts)
+
+Retrieve Pulse Results
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+id = 'id_example' # String | id
+opts = {
+  cuped: 'cuped_example', # String | Whether to apply CUPED. Allowed values are \"true\" or \"false\".
+  confidence: 'confidence_example', # String | Confidence interval (0-100)
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Retrieve Pulse Results
+  result = api_instance.console_v1_holdouts_id_pulse_results_get(id, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_pulse_results_get: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_id_pulse_results_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsIdPulseResultsGet200Response>, Integer, Hash)> console_v1_holdouts_id_pulse_results_get_with_http_info(id, opts)
+
+```ruby
+begin
+  # Retrieve Pulse Results
+  data, status_code, headers = api_instance.console_v1_holdouts_id_pulse_results_get_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsIdPulseResultsGet200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_id_pulse_results_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | id |  |
+| **cuped** | **String** | Whether to apply CUPED. Allowed values are \&quot;true\&quot; or \&quot;false\&quot;. | [optional] |
+| **confidence** | **String** | Confidence interval (0-100) | [optional] |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsIdPulseResultsGet200Response**](ConsoleV1HoldoutsIdPulseResultsGet200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## console_v1_holdouts_post
+
+> <ConsoleV1HoldoutsPost200Response> console_v1_holdouts_post(holdout_create_contract_dto, opts)
+
+Create holdout
+
+### Examples
+
+```ruby
+require 'time'
+require 'statsig_console_sdk'
+# setup authorization
+StatsigConsoleSDK.configure do |config|
+  # Configure API key authorization: STATSIG-API-KEY
+  config.api_key['STATSIG-API-KEY'] = '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['STATSIG-API-KEY'] = 'Bearer'
+end
+
+api_instance = StatsigConsoleSDK::HoldoutsApi.new
+holdout_create_contract_dto = StatsigConsoleSDK::HoldoutCreateContractDto.new({name: 'team holdout'}) # HoldoutCreateContractDto | 
+opts = {
+  x_respect_review_settings: 'x_respect_review_settings_example' # String | Optional header to respect review settings for mutation endpoints.
+}
+
+begin
+  # Create holdout
+  result = api_instance.console_v1_holdouts_post(holdout_create_contract_dto, opts)
+  p result
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_post: #{e}"
+end
+```
+
+#### Using the console_v1_holdouts_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConsoleV1HoldoutsPost200Response>, Integer, Hash)> console_v1_holdouts_post_with_http_info(holdout_create_contract_dto, opts)
+
+```ruby
+begin
+  # Create holdout
+  data, status_code, headers = api_instance.console_v1_holdouts_post_with_http_info(holdout_create_contract_dto, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConsoleV1HoldoutsPost200Response>
+rescue StatsigConsoleSDK::ApiError => e
+  puts "Error when calling HoldoutsApi->console_v1_holdouts_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **holdout_create_contract_dto** | [**HoldoutCreateContractDto**](HoldoutCreateContractDto.md) |  |  |
+| **x_respect_review_settings** | **String** | Optional header to respect review settings for mutation endpoints. | [optional] |
+
+### Return type
+
+[**ConsoleV1HoldoutsPost200Response**](ConsoleV1HoldoutsPost200Response.md)
+
+### Authorization
+
+[STATSIG-API-KEY](../README.md#STATSIG-API-KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+