klaviyo_sdk 1.0.1.20220329 → 1.0.2.20220329

data/docs/Campaign.md

@@ -1,4 +1,4 @@
-# Client::Campaign
+# Klaviyo::Campaign
 
 ## Properties
 
@@ -21,7 +21,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::Campaign.new(
+instance = Klaviyo::Campaign.new(
   object: campaign,
   id: CAMPAIGN_ID,
   name: Campaign Name,

data/docs/CampaignsApi.md

@@ -1,4 +1,4 @@
-# Client::CampaignsApi
+# Klaviyo::CampaignsApi
 
 All URIs are relative to *https://a.klaviyo.com/api*
 
@@ -29,21 +29,21 @@ Cancels a campaign send. Marks a campaign as cancelled regardless of it's curren
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+api_instance = Klaviyo::CampaignsApi.new
 campaign_id = 'CAMPAIGN_ID' # String | 
 
 begin
   # Cancel a Campaign
   result = api_instance.cancel_campaign(campaign_id)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->cancel_campaign: #{e}"
 end
 ```
@@ -61,7 +61,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Campaign>
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->cancel_campaign_with_http_info: #{e}"
 end
 ```
@@ -100,14 +100,14 @@ Creates a copy of a campaign. The new campaign starts as a draft.
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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.
@@ -116,7 +116,7 @@ begin
   # Clone a Campaign
   result = api_instance.clone_campaign(campaign_id, name, list_id)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->clone_campaign: #{e}"
 end
 ```
@@ -134,7 +134,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Campaign>
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->clone_campaign_with_http_info: #{e}"
 end
 ```
@@ -175,14 +175,14 @@ Creates a new campaign. The created campaign is a draft and is not automatically
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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.
@@ -198,7 +198,7 @@ begin
   # Create New Campaign
   result = api_instance.create_campaign(list_id, template_id, from_email, from_name, subject, opts)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->create_campaign: #{e}"
 end
 ```
@@ -216,7 +216,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Campaign>
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->create_campaign_with_http_info: #{e}"
 end
 ```
@@ -262,21 +262,21 @@ Returns summary information for the campaign specified.
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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 Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->get_campaign_info: #{e}"
 end
 ```
@@ -294,7 +294,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Campaign>
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->get_campaign_info_with_http_info: #{e}"
 end
 ```
@@ -333,14 +333,14 @@ Returns summary information about email recipients for the campaign specified th
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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
@@ -352,7 +352,7 @@ begin
   # Get Campaign Recipients
   result = api_instance.get_campaign_recipients(campaign_id, opts)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->get_campaign_recipients: #{e}"
 end
 ```
@@ -370,7 +370,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->get_campaign_recipients_with_http_info: #{e}"
 end
 ```
@@ -412,14 +412,14 @@ Returns a list of all the campaigns you've created. The campaigns are returned i
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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
@@ -429,7 +429,7 @@ begin
   # Get Campaigns
   result = api_instance.get_campaigns(opts)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->get_campaigns: #{e}"
 end
 ```
@@ -447,7 +447,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->get_campaigns_with_http_info: #{e}"
 end
 ```
@@ -487,14 +487,14 @@ Schedules a campaign for a time in the future
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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` 
 
@@ -502,7 +502,7 @@ begin
   # Schedule a Campaign
   result = api_instance.schedule_campaign(campaign_id, send_time)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->schedule_campaign: #{e}"
 end
 ```
@@ -520,7 +520,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->schedule_campaign_with_http_info: #{e}"
 end
 ```
@@ -560,21 +560,21 @@ Queues a campaign for immediate delivery
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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 Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->send_campaign: #{e}"
 end
 ```
@@ -592,7 +592,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->send_campaign_with_http_info: #{e}"
 end
 ```
@@ -631,14 +631,14 @@ Updates details of a campaign. You can update a campaign's name, subject, from e
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::CampaignsApi.new
+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.
@@ -655,7 +655,7 @@ begin
   # Update Campaign
   result = api_instance.update_campaign(campaign_id, opts)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->update_campaign: #{e}"
 end
 ```
@@ -673,7 +673,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Campaign>
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling CampaignsApi->update_campaign_with_http_info: #{e}"
 end
 ```

data/docs/CheckMembershipRequest.md

@@ -1,4 +1,4 @@
-# Client::CheckMembershipRequest
+# Klaviyo::CheckMembershipRequest
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::CheckMembershipRequest.new(
+instance = Klaviyo::CheckMembershipRequest.new(
   emails: ["george.washington@klaviyo.com","abraham.lincoln@klaviyo.com"],
   phone_numbers: ["+13239169023","+12028837032"],
   push_tokens: ["PUSH_TOKEN_1","PUSH_TOKEN_2"]

data/docs/DataPrivacyApi.md

@@ -1,4 +1,4 @@
-# Client::DataPrivacyApi
+# Klaviyo::DataPrivacyApi
 
 All URIs are relative to *https://a.klaviyo.com/api*
 
@@ -21,14 +21,14 @@ Request a data privacy-compliant deletion for the person record corresponding to
 require 'time'
 require 'klaviyo_sdk'
 # setup authorization
-Client.configure do |config|
+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 = Client::DataPrivacyApi.new
+api_instance = Klaviyo::DataPrivacyApi.new
 opts = {
   body: '{"email":"abraham.lincoln@klaviyo.com"}' # String | 
 }
@@ -37,7 +37,7 @@ begin
   # Request a Deletion
   result = api_instance.request_deletion(opts)
   p result
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling DataPrivacyApi->request_deletion: #{e}"
 end
 ```
@@ -55,7 +55,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => String
-rescue Client::ApiError => e
+rescue Klaviyo::ApiError => e
   puts "Error when calling DataPrivacyApi->request_deletion_with_http_info: #{e}"
 end
 ```

data/docs/DeleteEmail.md

@@ -1,4 +1,4 @@
-# Client::DeleteEmail
+# Klaviyo::DeleteEmail
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::DeleteEmail.new(
+instance = Klaviyo::DeleteEmail.new(
   email: example@klaviyo.com
 )
 ```

data/docs/DeletePerson.md

@@ -1,4 +1,4 @@
-# Client::DeletePerson
+# Klaviyo::DeletePerson
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::DeletePerson.new(
+instance = Klaviyo::DeletePerson.new(
   person_id: PERSON_ID
 )
 ```

data/docs/DeletePhone.md

@@ -1,4 +1,4 @@
-# Client::DeletePhone
+# Klaviyo::DeletePhone
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::DeletePhone.new(
+instance = Klaviyo::DeletePhone.new(
   phone_number: +13239169023
 )
 ```

data/docs/DeprecatedGetListResponse.md

@@ -1,4 +1,4 @@
-# Client::DeprecatedGetListResponse
+# Klaviyo::DeprecatedGetListResponse
 
 ## Properties
 
@@ -17,7 +17,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::DeprecatedGetListResponse.new(
+instance = Klaviyo::DeprecatedGetListResponse.new(
   object: null,
   start: null,
   _end: null,

data/docs/DeprecatedGetListResponseData.md

@@ -1,4 +1,4 @@
-# Client::DeprecatedGetListResponseData
+# Klaviyo::DeprecatedGetListResponseData
 
 ## Properties
 
@@ -16,7 +16,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::DeprecatedGetListResponseData.new(
+instance = Klaviyo::DeprecatedGetListResponseData.new(
   object: null,
   id: null,
   type: null,

data/docs/GlobalExclusionResponseData.md

@@ -1,4 +1,4 @@
-# Client::GlobalExclusionResponseData
+# Klaviyo::GlobalExclusionResponseData
 
 ## Properties
 
@@ -17,7 +17,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::GlobalExclusionResponseData.new(
+instance = Klaviyo::GlobalExclusionResponseData.new(
   object: $list,
   data: null,
   page: 0,

data/docs/IdentifyPayload.md

@@ -1,4 +1,4 @@
-# Client::IdentifyPayload
+# Klaviyo::IdentifyPayload
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::IdentifyPayload.new(
+instance = Klaviyo::IdentifyPayload.new(
   token: null,
   properties: null
 )

data/docs/IdentifyPayloadProperties.md

@@ -1,4 +1,4 @@
-# Client::IdentifyPayloadProperties
+# Klaviyo::IdentifyPayloadProperties
 
 ## Properties
 
@@ -23,7 +23,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::IdentifyPayloadProperties.new(
+instance = Klaviyo::IdentifyPayloadProperties.new(
   _email: null,
   _first_name: null,
   _last_name: null,

data/docs/InlineObject.md

@@ -1,4 +1,4 @@
-# Client::InlineObject
+# Klaviyo::InlineObject
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::InlineObject.new(
+instance = Klaviyo::InlineObject.new(
   exchange_id: EXCHANGE_ID
 )
 ```

data/docs/InlineObject3.md

@@ -1,4 +1,4 @@
-# Client::InlineObject3
+# Klaviyo::InlineObject3
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::InlineObject3.new(
+instance = Klaviyo::InlineObject3.new(
   profiles: [{"email":"george.washington@klaviyo.com"},{"phone_number":"+13239169023","sms_consent":true}]
 )
 ```

data/docs/InlineObject4.md

@@ -1,4 +1,4 @@
-# Client::InlineObject4
+# Klaviyo::InlineObject4
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::InlineObject4.new(
+instance = Klaviyo::InlineObject4.new(
   profiles: [{"email":"george.washington@klaviyo.com"},{"phone_number":"+13239169023"}]
 )
 ```

data/docs/InlineObject5.md

@@ -1,4 +1,4 @@
-# Client::InlineObject5
+# Klaviyo::InlineObject5
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'klaviyo_sdk'
 
-instance = Client::InlineObject5.new(
+instance = Klaviyo::InlineObject5.new(
   emails: ["george.washington@klaviyo.com","abraham.lincoln@klaviyo.com"],
   phone_numbers: ["+13239169023"],
   push_tokens: ["PUSH_TOKEN"]