klaviyo_sdk 1.0.3.20220329 → 1.0.4.20220329

data/docs/CampaignsApi.md

@@ -1,707 +0,0 @@
-# Klaviyo::CampaignsApi
-
-All URIs are relative to *https://a.klaviyo.com/api*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**cancel_campaign**](CampaignsApi.md#cancel_campaign) | **POST** /v1/campaign/{campaign_id}/cancel | Cancel a Campaign |
-| [**clone_campaign**](CampaignsApi.md#clone_campaign) | **POST** /v1/campaign/{campaign_id}/clone | Clone a Campaign |
-| [**create_campaign**](CampaignsApi.md#create_campaign) | **POST** /v1/campaigns | Create New Campaign |
-| [**get_campaign_info**](CampaignsApi.md#get_campaign_info) | **GET** /v1/campaign/{campaign_id} | Get Campaign Info |
-| [**get_campaign_recipients**](CampaignsApi.md#get_campaign_recipients) | **GET** /v1/campaign/{campaign_id}/recipients | Get Campaign Recipients |
-| [**get_campaigns**](CampaignsApi.md#get_campaigns) | **GET** /v1/campaigns | Get Campaigns |
-| [**schedule_campaign**](CampaignsApi.md#schedule_campaign) | **POST** /v1/campaign/{campaign_id}/schedule | Schedule a Campaign |
-| [**send_campaign**](CampaignsApi.md#send_campaign) | **POST** /v1/campaign/{campaign_id}/send | Send a Campaign Immediately |
-| [**update_campaign**](CampaignsApi.md#update_campaign) | **PUT** /v1/campaign/{campaign_id} | Update Campaign |
-
-
-## cancel_campaign
-
-> <Campaign> cancel_campaign(campaign_id)
-
-Cancel a Campaign
-
-Cancels a campaign send. Marks a campaign as cancelled regardless of it's current status.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-campaign_id = 'CAMPAIGN_ID' # String | 
-
-begin
-  # Cancel a Campaign
-  result = api_instance.cancel_campaign(campaign_id)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->cancel_campaign: #{e}"
-end
-```
-
-#### Using the cancel_campaign_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Campaign>, Integer, Hash)> cancel_campaign_with_http_info(campaign_id)
-
-```ruby
-begin
-  # Cancel a Campaign
-  data, status_code, headers = api_instance.cancel_campaign_with_http_info(campaign_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Campaign>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->cancel_campaign_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaign_id** | **String** |  | [default to &#39;CAMPAIGN_ID&#39;] |
-
-### Return type
-
-[**Campaign**](Campaign.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## clone_campaign
-
-> <Campaign> clone_campaign(campaign_id, name, list_id)
-
-Clone a Campaign
-
-Creates a copy of a campaign. The new campaign starts as a draft.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-campaign_id = 'CAMPAIGN_ID' # String | 
-name = 'name_example' # String | The name for the new campaign. All other properties of the campaign will remain the same. Note, the template for the new campaign will be cloned from the existing template so changes to the existing campaign's content will not alter the content of the new campaign.
-list_id = 'list_id_example' # String | The list you will send the campaign to.
-
-begin
-  # Clone a Campaign
-  result = api_instance.clone_campaign(campaign_id, name, list_id)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->clone_campaign: #{e}"
-end
-```
-
-#### Using the clone_campaign_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Campaign>, Integer, Hash)> clone_campaign_with_http_info(campaign_id, name, list_id)
-
-```ruby
-begin
-  # Clone a Campaign
-  data, status_code, headers = api_instance.clone_campaign_with_http_info(campaign_id, name, list_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Campaign>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->clone_campaign_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaign_id** | **String** |  | [default to &#39;CAMPAIGN_ID&#39;] |
-| **name** | **String** | The name for the new campaign. All other properties of the campaign will remain the same. Note, the template for the new campaign will be cloned from the existing template so changes to the existing campaign&#39;s content will not alter the content of the new campaign. | [default to &#39;Cloned Campaign&#39;] |
-| **list_id** | **String** | The list you will send the campaign to. | [default to &#39;LIST_ID&#39;] |
-
-### Return type
-
-[**Campaign**](Campaign.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: application/json
-
-
-## create_campaign
-
-> <Campaign> create_campaign(list_id, template_id, from_email, from_name, subject, opts)
-
-Create New Campaign
-
-Creates a new campaign. The created campaign is a draft and is not automatically sent.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-list_id = 'list_id_example' # String | The list you will send the campaign to.
-template_id = 'template_id_example' # String |  The template that will define the content of the page. Note: the Email Template is copied when creating this campaign, so future changes to that Email Template will not alter the content of this campaign. 
-from_email = 'from_email_example' # String | The email address your email will be sent from and will be used in the `reply-to` header.
-from_name = 'from_name_example' # String | The name or label associated with the email address you're sending from.
-subject = 'subject_example' # String | The email subject of the campaign
-opts = {
-  name: 'name_example', # String | If not specified, this will default to the subject of the campaign.
-  use_smart_sending: true, # Boolean | If set, limits the number of emails sent to an individual within a short period. Valid values are `true` and `false`. If not specified, defaults to `true`.
-  add_google_analytics: true # Boolean | If specified, adds Google Analytics tracking tags to links. Valid values are `true` and `false`. If not specified, defaults to `false`.
-}
-
-begin
-  # Create New Campaign
-  result = api_instance.create_campaign(list_id, template_id, from_email, from_name, subject, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->create_campaign: #{e}"
-end
-```
-
-#### Using the create_campaign_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Campaign>, Integer, Hash)> create_campaign_with_http_info(list_id, template_id, from_email, from_name, subject, opts)
-
-```ruby
-begin
-  # Create New Campaign
-  data, status_code, headers = api_instance.create_campaign_with_http_info(list_id, template_id, from_email, from_name, subject, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Campaign>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->create_campaign_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** | The list you will send the campaign to. | [default to &#39;LIST_ID&#39;] |
-| **template_id** | **String** |  The template that will define the content of the page. Note: the Email Template is copied when creating this campaign, so future changes to that Email Template will not alter the content of this campaign.  | [default to &#39;TEMPLATE_ID&#39;] |
-| **from_email** | **String** | The email address your email will be sent from and will be used in the &#x60;reply-to&#x60; header. | [default to &#39;george.washington@klaviyo.com&#39;] |
-| **from_name** | **String** | The name or label associated with the email address you&#39;re sending from. | [default to &#39;George Washington&#39;] |
-| **subject** | **String** | The email subject of the campaign | [default to &#39;Happy Fourth!&#39;] |
-| **name** | **String** | If not specified, this will default to the subject of the campaign. | [optional][default to &#39;Campaign Name&#39;] |
-| **use_smart_sending** | **Boolean** | If set, limits the number of emails sent to an individual within a short period. Valid values are &#x60;true&#x60; and &#x60;false&#x60;. If not specified, defaults to &#x60;true&#x60;. | [optional][default to true] |
-| **add_google_analytics** | **Boolean** | If specified, adds Google Analytics tracking tags to links. Valid values are &#x60;true&#x60; and &#x60;false&#x60;. If not specified, defaults to &#x60;false&#x60;. | [optional][default to false] |
-
-### Return type
-
-[**Campaign**](Campaign.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: application/json
-
-
-## get_campaign_info
-
-> <Campaign> get_campaign_info(campaign_id)
-
-Get Campaign Info
-
-Returns summary information for the campaign specified.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-campaign_id = 'CAMPAIGN_ID' # String | 
-
-begin
-  # Get Campaign Info
-  result = api_instance.get_campaign_info(campaign_id)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->get_campaign_info: #{e}"
-end
-```
-
-#### Using the get_campaign_info_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Campaign>, Integer, Hash)> get_campaign_info_with_http_info(campaign_id)
-
-```ruby
-begin
-  # Get Campaign Info
-  data, status_code, headers = api_instance.get_campaign_info_with_http_info(campaign_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Campaign>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->get_campaign_info_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaign_id** | **String** |  | [default to &#39;CAMPAIGN_ID&#39;] |
-
-### Return type
-
-[**Campaign**](Campaign.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_campaign_recipients
-
-> Hash&lt;String, Object&gt; get_campaign_recipients(campaign_id, opts)
-
-Get Campaign Recipients
-
-Returns summary information about email recipients for the campaign specified that includes each recipients email, customer ID, and status.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-campaign_id = 'CAMPAIGN_ID' # String | 
-opts = {
-  count: 25000, # Integer | For pagination, the number of results to return. Max = 25,000
-  sort: 'asc', # String | Sort order to apply to results, either ascending or descending. Valid values are `asc` or `desc`. Defaults to `asc`.
-  offset: 'next_offset' # String | For pagination, if a response to this endpoint includes a `next_offset`, use that value to get the next page of recipients.
-}
-
-begin
-  # Get Campaign Recipients
-  result = api_instance.get_campaign_recipients(campaign_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->get_campaign_recipients: #{e}"
-end
-```
-
-#### Using the get_campaign_recipients_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_recipients_with_http_info(campaign_id, opts)
-
-```ruby
-begin
-  # Get Campaign Recipients
-  data, status_code, headers = api_instance.get_campaign_recipients_with_http_info(campaign_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->get_campaign_recipients_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaign_id** | **String** |  | [default to &#39;CAMPAIGN_ID&#39;] |
-| **count** | **Integer** | For pagination, the number of results to return. Max &#x3D; 25,000 | [optional][default to 5000] |
-| **sort** | **String** | Sort order to apply to results, either ascending or descending. Valid values are &#x60;asc&#x60; or &#x60;desc&#x60;. Defaults to &#x60;asc&#x60;. | [optional][default to &#39;asc&#39;] |
-| **offset** | **String** | For pagination, if a response to this endpoint includes a &#x60;next_offset&#x60;, use that value to get the next page of recipients. | [optional] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_campaigns
-
-> Hash&lt;String, Object&gt; get_campaigns(opts)
-
-Get Campaigns
-
-Returns a list of all the campaigns you've created. The campaigns are returned in reverse sorted order by the time they were created.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-opts = {
-  page: 0, # Integer | For pagination, which page of results to return. Default = 0
-  count: 100 # Integer | For pagination, the number of results to return. Max = 100
-}
-
-begin
-  # Get Campaigns
-  result = api_instance.get_campaigns(opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->get_campaigns: #{e}"
-end
-```
-
-#### Using the get_campaigns_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaigns_with_http_info(opts)
-
-```ruby
-begin
-  # Get Campaigns
-  data, status_code, headers = api_instance.get_campaigns_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->get_campaigns_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **page** | **Integer** | For pagination, which page of results to return. Default &#x3D; 0 | [optional][default to 0] |
-| **count** | **Integer** | For pagination, the number of results to return. Max &#x3D; 100 | [optional][default to 50] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## schedule_campaign
-
-> Hash&lt;String, Object&gt; schedule_campaign(campaign_id, send_time)
-
-Schedule a Campaign
-
-Schedules a campaign for a time in the future
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-campaign_id = 'CAMPAIGN_ID' # String | 
-send_time = 'send_time_example' # String |  A timestamp of the format `%Y-%m-%d %H:%M:%S` in the UTC timezone.  Ex:  `2022-01-13 00:00:00` 
-
-begin
-  # Schedule a Campaign
-  result = api_instance.schedule_campaign(campaign_id, send_time)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->schedule_campaign: #{e}"
-end
-```
-
-#### Using the schedule_campaign_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> schedule_campaign_with_http_info(campaign_id, send_time)
-
-```ruby
-begin
-  # Schedule a Campaign
-  data, status_code, headers = api_instance.schedule_campaign_with_http_info(campaign_id, send_time)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->schedule_campaign_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaign_id** | **String** |  | [default to &#39;CAMPAIGN_ID&#39;] |
-| **send_time** | **String** |  A timestamp of the format &#x60;%Y-%m-%d %H:%M:%S&#x60; in the UTC timezone.  Ex:  &#x60;2022-01-13 00:00:00&#x60;  | [default to &#39;2022-01-13 00:00:00&#39;] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: application/json
-
-
-## send_campaign
-
-> Hash&lt;String, Object&gt; send_campaign(campaign_id)
-
-Send a Campaign Immediately
-
-Queues a campaign for immediate delivery
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-campaign_id = 'CAMPAIGN_ID' # String | 
-
-begin
-  # Send a Campaign Immediately
-  result = api_instance.send_campaign(campaign_id)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->send_campaign: #{e}"
-end
-```
-
-#### Using the send_campaign_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> send_campaign_with_http_info(campaign_id)
-
-```ruby
-begin
-  # Send a Campaign Immediately
-  data, status_code, headers = api_instance.send_campaign_with_http_info(campaign_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->send_campaign_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaign_id** | **String** |  | [default to &#39;CAMPAIGN_ID&#39;] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update_campaign
-
-> <Campaign> update_campaign(campaign_id, opts)
-
-Update Campaign
-
-Updates details of a campaign. You can update a campaign's name, subject, from email address, from name, template or list.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::CampaignsApi.new
-campaign_id = 'CAMPAIGN_ID' # String | 
-opts = {
-  list_id: 'list_id_example', # String | The list you will send the campaign to.
-  template_id: 'template_id_example', # String | The ID of the Email Template object that will be the content of this campaign. Note the Email Template is copied when creating this campaign, so future changes to that Email Template will not alter the content of this campaign.
-  from_email: 'from_email_example', # String | The email address your email will be sent from and will be used in the reply-to header.
-  from_name: 'from_name_example', # String | The name or label associated with the email address you're sending from.
-  subject: 'subject_example', # String | The email subject of the campaign
-  name: 'name_example', # String | A name for this campaign. If not specified, this will default to the subject of the campaign.
-  use_smart_sending: true, # Boolean | If set, limits the number of emails sent to an individual within a short period. Campaigns initially default to `true`.
-  add_google_analytics: true # Boolean | If specified, adds Google Analytics tracking tags to links. Campaigns initially default to `false`.
-}
-
-begin
-  # Update Campaign
-  result = api_instance.update_campaign(campaign_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->update_campaign: #{e}"
-end
-```
-
-#### Using the update_campaign_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Campaign>, Integer, Hash)> update_campaign_with_http_info(campaign_id, opts)
-
-```ruby
-begin
-  # Update Campaign
-  data, status_code, headers = api_instance.update_campaign_with_http_info(campaign_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Campaign>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling CampaignsApi->update_campaign_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaign_id** | **String** |  | [default to &#39;CAMPAIGN_ID&#39;] |
-| **list_id** | **String** | The list you will send the campaign to. | [optional] |
-| **template_id** | **String** | The ID of the Email Template object that will be the content of this campaign. Note the Email Template is copied when creating this campaign, so future changes to that Email Template will not alter the content of this campaign. | [optional] |
-| **from_email** | **String** | The email address your email will be sent from and will be used in the reply-to header. | [optional] |
-| **from_name** | **String** | The name or label associated with the email address you&#39;re sending from. | [optional] |
-| **subject** | **String** | The email subject of the campaign | [optional] |
-| **name** | **String** | A name for this campaign. If not specified, this will default to the subject of the campaign. | [optional] |
-| **use_smart_sending** | **Boolean** | If set, limits the number of emails sent to an individual within a short period. Campaigns initially default to &#x60;true&#x60;. | [optional] |
-| **add_google_analytics** | **Boolean** | If specified, adds Google Analytics tracking tags to links. Campaigns initially default to &#x60;false&#x60;. | [optional] |
-
-### Return type
-
-[**Campaign**](Campaign.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: application/json
-