klaviyo_sdk 1.0.1.20220329 → 1.0.4.20220329

data/lib/klaviyo_sdk/models/person.rb.bak

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class Person
     attr_accessor :object
 
@@ -122,13 +122,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::Person` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::Person` 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::Person`. 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::Person`. 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
       }
@@ -333,7 +333,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/privacy_email.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class PrivacyEmail
     attr_accessor :email
 
@@ -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::PrivacyEmail` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::PrivacyEmail` 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::PrivacyEmail`. 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::PrivacyEmail`. 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/privacy_id.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.4.0
 require 'date'
 require 'time'
 
-module Client
+module Klaviyo
   class PrivacyId
     attr_accessor :person_id
 
@@ -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::PrivacyId` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::PrivacyId` 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::PrivacyId`. 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::PrivacyId`. 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/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

@@ -18,6 +18,8 @@ require 'klaviyo_sdk/configuration'
 
 # Models
 require 'klaviyo_sdk/models/campaign'
+require 'klaviyo_sdk/models/campaign_lists'
+require 'klaviyo_sdk/models/campaigns'
 require 'klaviyo_sdk/models/check_membership_request'
 require 'klaviyo_sdk/models/delete_email'
 require 'klaviyo_sdk/models/delete_person'
@@ -31,6 +33,7 @@ require 'klaviyo_sdk/models/inline_object'
 require 'klaviyo_sdk/models/inline_object3'
 require 'klaviyo_sdk/models/inline_object4'
 require 'klaviyo_sdk/models/inline_object5'
+require 'klaviyo_sdk/models/inline_response200'
 require 'klaviyo_sdk/models/metric'
 require 'klaviyo_sdk/models/metric_export'
 require 'klaviyo_sdk/models/metric_timeline'
@@ -57,12 +60,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 +88,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 +106,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
               }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1.20220329
+  version: 1.0.4.20220329
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retriable
@@ -55,42 +55,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- docs/Campaign.md
-- docs/CampaignsApi.md
-- docs/CheckMembershipRequest.md
-- docs/DataPrivacyApi.md
-- docs/DeleteEmail.md
-- docs/DeletePerson.md
-- docs/DeletePhone.md
-- docs/DeprecatedGetListResponse.md
-- docs/DeprecatedGetListResponseData.md
-- docs/GlobalExclusionResponseData.md
-- docs/IdentifyPayload.md
-- docs/IdentifyPayloadProperties.md
-- docs/InlineObject.md
-- docs/InlineObject3.md
-- docs/InlineObject4.md
-- docs/InlineObject5.md
-- docs/ListsSegmentsApi.md
-- docs/Metric.md
-- docs/MetricExport.md
-- docs/MetricTimeline.md
-- docs/MetricTimelineData.md
-- docs/MetricsApi.md
-- docs/Person.md
-- docs/PrivacyEmail.md
-- docs/PrivacyId.md
-- docs/PrivacyPhone.md
-- docs/ProfilesApi.md
-- docs/RenderedTemplate.md
-- docs/Template.md
-- docs/TemplatesApi.md
-- docs/TrackIdentifyApi.md
-- docs/TrackPayload.md
-- docs/TrackPayloadCustomerProperties.md
-- docs/TrackPayloadProperties.md
-- git_push.sh
-- klaviyo_sdk-1.0.0.20220329.gem
 - klaviyo_sdk.gemspec
 - lib/klaviyo_sdk.rb
 - lib/klaviyo_sdk/api/campaigns_api.rb
@@ -104,6 +68,8 @@ files:
 - lib/klaviyo_sdk/api_error.rb
 - lib/klaviyo_sdk/configuration.rb
 - lib/klaviyo_sdk/models/campaign.rb
+- lib/klaviyo_sdk/models/campaign_lists.rb
+- lib/klaviyo_sdk/models/campaigns.rb
 - lib/klaviyo_sdk/models/check_membership_request.rb
 - lib/klaviyo_sdk/models/delete_email.rb
 - lib/klaviyo_sdk/models/delete_person.rb
@@ -117,6 +83,7 @@ files:
 - lib/klaviyo_sdk/models/inline_object3.rb
 - lib/klaviyo_sdk/models/inline_object4.rb
 - lib/klaviyo_sdk/models/inline_object5.rb
+- lib/klaviyo_sdk/models/inline_response200.rb
 - lib/klaviyo_sdk/models/metric.rb
 - lib/klaviyo_sdk/models/metric_export.rb
 - lib/klaviyo_sdk/models/metric_timeline.rb
@@ -132,43 +99,6 @@ files:
 - lib/klaviyo_sdk/models/track_payload_customer_properties.rb
 - lib/klaviyo_sdk/models/track_payload_properties.rb
 - lib/klaviyo_sdk/version.rb
-- spec/api/campaigns_api_spec.rb
-- spec/api/data_privacy_api_spec.rb
-- spec/api/lists_segments_api_spec.rb
-- spec/api/metrics_api_spec.rb
-- spec/api/profiles_api_spec.rb
-- spec/api/templates_api_spec.rb
-- spec/api/track_identify_api_spec.rb
-- spec/api_client_spec.rb
-- spec/configuration_spec.rb
-- spec/models/campaign_spec.rb
-- spec/models/check_membership_request_spec.rb
-- spec/models/delete_email_spec.rb
-- spec/models/delete_person_spec.rb
-- spec/models/delete_phone_spec.rb
-- spec/models/deprecated_get_list_response_data_spec.rb
-- spec/models/deprecated_get_list_response_spec.rb
-- spec/models/global_exclusion_response_data_spec.rb
-- spec/models/identify_payload_properties_spec.rb
-- spec/models/identify_payload_spec.rb
-- spec/models/inline_object3_spec.rb
-- spec/models/inline_object4_spec.rb
-- spec/models/inline_object5_spec.rb
-- spec/models/inline_object_spec.rb
-- spec/models/metric_export_spec.rb
-- spec/models/metric_spec.rb
-- spec/models/metric_timeline_data_spec.rb
-- spec/models/metric_timeline_spec.rb
-- spec/models/person_spec.rb
-- spec/models/privacy_email_spec.rb
-- spec/models/privacy_id_spec.rb
-- spec/models/privacy_phone_spec.rb
-- spec/models/rendered_template_spec.rb
-- spec/models/template_spec.rb
-- spec/models/track_payload_customer_properties_spec.rb
-- spec/models/track_payload_properties_spec.rb
-- spec/models/track_payload_spec.rb
-- spec/spec_helper.rb
 homepage: https://www.klaviyo.com/
 licenses:
 - Unlicense
@@ -190,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: You heard us, a Ruby wrapper for the Klaviyo API

data/docs/Campaign.md

@@ -1,38 +0,0 @@
-# Client::Campaign
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **object** | **String** |  | [optional] |
-| **id** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **subject** | **String** |  | [optional] |
-| **from_email** | **String** |  | [optional] |
-| **from_name** | **String** |  | [optional] |
-| **list_id** | **String** |  | [optional] |
-| **template** | **Hash<String, Object>** |  | [optional] |
-| **status** | **String** |  | [optional] |
-| **sent_at** | **String** |  | [optional] |
-| **created** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::Campaign.new(
-  object: campaign,
-  id: CAMPAIGN_ID,
-  name: Campaign Name,
-  subject: Company Monthly Newsletter,
-  from_email: george.washington@klaviyo.com,
-  from_name: George Washington,
-  list_id: erRoOX,
-  template: null,
-  status: draft,
-  sent_at: 2020-12-02 18:45:04,
-  created: 2020-12-01 18:45:04
-)
-```
-