klaviyo_sdk 1.0.0.20220329 → 1.0.3.20220329

data/lib/klaviyo_sdk/models/privacy_phone.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class PrivacyPhone
     attr_accessor :phone_number
 
@@ -46,13 +46,13 @@ module Client
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Client::PrivacyPhone` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::PrivacyPhone` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Client::PrivacyPhone`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::PrivacyPhone`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -162,7 +162,7 @@ module Client
         end
       else # model
         # models (e.g. Pet) or oneOf
-        klass = Client.const_get(type)
+        klass = Klaviyo.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end

data/lib/klaviyo_sdk/models/rendered_template.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class RenderedTemplate
     attr_accessor :object
 
@@ -58,13 +58,13 @@ module Client
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Client::RenderedTemplate` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::RenderedTemplate` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Client::RenderedTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::RenderedTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -191,7 +191,7 @@ module Client
         end
       else # model
         # models (e.g. Pet) or oneOf
-        klass = Client.const_get(type)
+        klass = Klaviyo.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end

data/lib/klaviyo_sdk/models/template.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class Template
     attr_accessor :object
 
@@ -70,13 +70,13 @@ module Client
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Client::Template` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::Template` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Client::Template`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::Template`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -216,7 +216,7 @@ module Client
         end
       else # model
         # models (e.g. Pet) or oneOf
-        klass = Client.const_get(type)
+        klass = Klaviyo.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end

data/lib/klaviyo_sdk/models/track_payload.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class TrackPayload
     attr_accessor :token
 
@@ -59,13 +59,13 @@ module Client
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Client::TrackPayload` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::TrackPayload` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Client::TrackPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::TrackPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -205,7 +205,7 @@ module Client
         end
       else # model
         # models (e.g. Pet) or oneOf
-        klass = Client.const_get(type)
+        klass = Klaviyo.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end

data/lib/klaviyo_sdk/models/track_payload_customer_properties.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class TrackPayloadCustomerProperties
     attr_accessor :_email
 
@@ -50,13 +50,13 @@ module Client
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Client::TrackPayloadCustomerProperties` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::TrackPayloadCustomerProperties` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Client::TrackPayloadCustomerProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::TrackPayloadCustomerProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -171,7 +171,7 @@ module Client
         end
       else # model
         # models (e.g. Pet) or oneOf
-        klass = Client.const_get(type)
+        klass = Klaviyo.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end

data/lib/klaviyo_sdk/models/track_payload_properties.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class TrackPayloadProperties
     attr_accessor :event_id
 
@@ -55,13 +55,13 @@ module Client
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Client::TrackPayloadProperties` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::TrackPayloadProperties` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Client::TrackPayloadProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::TrackPayloadProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -181,7 +181,7 @@ module Client
         end
       else # model
         # models (e.g. Pet) or oneOf
-        klass = Client.const_get(type)
+        klass = Klaviyo.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end

data/lib/klaviyo_sdk/version.rb

@@ -10,6 +10,6 @@ OpenAPI Generator version: 5.4.0
 
 =end
 
-module Client
+module Klaviyo
   VERSION = '1.0.0'
 end

data/lib/klaviyo_sdk.rb

@@ -57,12 +57,12 @@ require 'klaviyo_sdk/api/track_identify_api'
 # retry logic
 require 'retriable'
 
-module Client
+module Klaviyo
   @is_initialized = false
 
   class << self
     # Customize default settings for the SDK using block.
-    #   Client.configure do |config|
+    #   Klaviyo.configure do |config|
     #     config.username = "xxx"
     #     config.password = "xxx"
     #   end
@@ -85,8 +85,8 @@ module Client
         self.constants.each do |c|
           if c[-3..-1] == "Api"
             attributes = [:attr1]
-            wrapper_class = Client.const_set(c[0..-4], Struct.new(*attributes))
-            original_class = Client.const_get(c)
+            wrapper_class = Klaviyo.const_set(c[0..-4], Struct.new(*attributes))
+            original_class = Klaviyo.const_get(c)
             
             # recreate methods
             original_class.public_instance_methods(false).each do |m|
@@ -103,14 +103,14 @@ module Client
                       c.tries = max_retries
                       c.max_elapsed_time = max_delay
                       c.on = {
-                        Client::ApiError => [/400/, /503/, /504/]
+                        Klaviyo::ApiError => [/429/, /503/, /504/]
                       }
                     end
                     Retriable.retriable do
-                      Client.const_get(c).new.send(m, *arg)
+                      Klaviyo.const_get(c).new.send(m, *arg)
                     end
                   else
-                    Client.const_get(c).new.send(m, *arg)
+                    Klaviyo.const_get(c).new.send(m, *arg)
                   end
                 end
               }

data/spec/api/campaigns_api_spec.rb

@@ -0,0 +1,165 @@
+=begin
+#Klaviyo API
+
+#Empowering creators to own their destiny
+
+The version of the OpenAPI document: 2022.03.29
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Klaviyo::CampaignsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CampaignsApi' do
+  before do
+    # run before each test
+    @api_instance = Klaviyo::CampaignsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CampaignsApi' do
+    it 'should create an instance of CampaignsApi' do
+      expect(@api_instance).to be_instance_of(Klaviyo::CampaignsApi)
+    end
+  end
+
+  # unit tests for cancel_campaign
+  # Cancel a Campaign
+  # Cancels a campaign send. Marks a campaign as cancelled regardless of it's current status.
+  # @param campaign_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'cancel_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for clone_campaign
+  # Clone a Campaign
+  # Creates a copy of a campaign. The new campaign starts as a draft.
+  # @param campaign_id 
+  # @param name 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.
+  # @param list_id The list you will send the campaign to.
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'clone_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_campaign
+  # Create New Campaign
+  # Creates a new campaign. The created campaign is a draft and is not automatically sent.
+  # @param list_id The list you will send the campaign to.
+  # @param template_id  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. 
+  # @param from_email The email address your email will be sent from and will be used in the `reply-to` header.
+  # @param from_name The name or label associated with the email address you're sending from.
+  # @param subject The email subject of the campaign
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name If not specified, this will default to the subject of the campaign.
+  # @option opts [Boolean] :use_smart_sending 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`.
+  # @option opts [Boolean] :add_google_analytics If specified, adds Google Analytics tracking tags to links. Valid values are `true` and `false`. If not specified, defaults to `false`.
+  # @return [Campaign]
+  describe 'create_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_campaign_info
+  # Get Campaign Info
+  # Returns summary information for the campaign specified.
+  # @param campaign_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'get_campaign_info test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_campaign_recipients
+  # Get Campaign Recipients
+  # Returns summary information about email recipients for the campaign specified that includes each recipients email, customer ID, and status.
+  # @param campaign_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :count For pagination, the number of results to return. Max = 25,000
+  # @option opts [String] :sort Sort order to apply to results, either ascending or descending. Valid values are `asc` or `desc`. Defaults to `asc`.
+  # @option opts [String] :offset For pagination, if a response to this endpoint includes a `next_offset`, use that value to get the next page of recipients.
+  # @return [Hash<String, Object>]
+  describe 'get_campaign_recipients test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_campaigns
+  # Get Campaigns
+  # Returns a list of all the campaigns you&#39;ve created. The campaigns are returned in reverse sorted order by the time they were created.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page For pagination, which page of results to return. Default &#x3D; 0
+  # @option opts [Integer] :count For pagination, the number of results to return. Max &#x3D; 100
+  # @return [Hash<String, Object>]
+  describe 'get_campaigns test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for schedule_campaign
+  # Schedule a Campaign
+  # Schedules a campaign for a time in the future
+  # @param campaign_id 
+  # @param send_time  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; 
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'schedule_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for send_campaign
+  # Send a Campaign Immediately
+  # Queues a campaign for immediate delivery
+  # @param campaign_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'send_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_campaign
+  # Update Campaign
+  # Updates details of a campaign. You can update a campaign&#39;s name, subject, from email address, from name, template or list.
+  # @param campaign_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :list_id The list you will send the campaign to.
+  # @option opts [String] :template_id 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.
+  # @option opts [String] :from_email The email address your email will be sent from and will be used in the reply-to header.
+  # @option opts [String] :from_name The name or label associated with the email address you&#39;re sending from.
+  # @option opts [String] :subject The email subject of the campaign
+  # @option opts [String] :name A name for this campaign. If not specified, this will default to the subject of the campaign.
+  # @option opts [Boolean] :use_smart_sending If set, limits the number of emails sent to an individual within a short period. Campaigns initially default to &#x60;true&#x60;.
+  # @option opts [Boolean] :add_google_analytics If specified, adds Google Analytics tracking tags to links. Campaigns initially default to &#x60;false&#x60;.
+  # @return [Campaign]
+  describe 'update_campaign test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/data_privacy_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#Klaviyo API
+
+#Empowering creators to own their destiny
+
+The version of the OpenAPI document: 2022.03.29
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Klaviyo::DataPrivacyApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DataPrivacyApi' do
+  before do
+    # run before each test
+    @api_instance = Klaviyo::DataPrivacyApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DataPrivacyApi' do
+    it 'should create an instance of DataPrivacyApi' do
+      expect(@api_instance).to be_instance_of(Klaviyo::DataPrivacyApi)
+    end
+  end
+
+  # unit tests for request_deletion
+  # Request a Deletion
+  # Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier.   **If multiple person records exist for the provided identifier, only one of them will be deleted.**  The arguments should be sent as content type application/json.           Note that only **one** identifier (email, phone_number, or person_id) can be specified.  In addition to your API key, you need to set exactly one of the following parameters: `email`, `phone_number`, `or person_id`, along with the associated `string` value.   Examples:  Email:    `{\"email\":\"abraham.lincoln@klaviyo.com\"}`    Phone Number:      `{\"phone_number\":\"+13239169023\"}`    Person ID:      `{\"person_id\":\"PERSON_ID\"}` 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :body 
+  # @return [String]
+  describe 'request_deletion test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end