klaviyo_sdk 1.0.3.20220329 → 1.0.5.20220329

data/lib/klaviyo_sdk/models/inline_response200.rb

@@ -0,0 +1,218 @@
+=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 'date'
+require 'time'
+
+module Klaviyo
+  class InlineResponse200
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @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 `Klaviyo::InlineResponse200` 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 `Klaviyo::InlineResponse200`. 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
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Klaviyo.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/klaviyo_sdk.rb

@@ -16,35 +16,6 @@ require 'klaviyo_sdk/api_error'
 require 'klaviyo_sdk/version'
 require 'klaviyo_sdk/configuration'
 
-# Models
-require 'klaviyo_sdk/models/campaign'
-require 'klaviyo_sdk/models/check_membership_request'
-require 'klaviyo_sdk/models/delete_email'
-require 'klaviyo_sdk/models/delete_person'
-require 'klaviyo_sdk/models/delete_phone'
-require 'klaviyo_sdk/models/deprecated_get_list_response'
-require 'klaviyo_sdk/models/deprecated_get_list_response_data'
-require 'klaviyo_sdk/models/global_exclusion_response_data'
-require 'klaviyo_sdk/models/identify_payload'
-require 'klaviyo_sdk/models/identify_payload_properties'
-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/metric'
-require 'klaviyo_sdk/models/metric_export'
-require 'klaviyo_sdk/models/metric_timeline'
-require 'klaviyo_sdk/models/metric_timeline_data'
-require 'klaviyo_sdk/models/person'
-require 'klaviyo_sdk/models/privacy_email'
-require 'klaviyo_sdk/models/privacy_id'
-require 'klaviyo_sdk/models/privacy_phone'
-require 'klaviyo_sdk/models/rendered_template'
-require 'klaviyo_sdk/models/template'
-require 'klaviyo_sdk/models/track_payload'
-require 'klaviyo_sdk/models/track_payload_customer_properties'
-require 'klaviyo_sdk/models/track_payload_properties'
-
 # APIs
 require 'klaviyo_sdk/api/campaigns_api'
 require 'klaviyo_sdk/api/data_privacy_api'

data/test.rb

@@ -0,0 +1,9 @@
+# Load the gem
+require 'klaviyo_sdk'
+
+# Setup authorization
+Klaviyo.configure do |config|
+  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
+  #config.max_retries = 5 # optional
+  #config.max_delay = 60 # optional
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.3.20220329
+  version: 1.0.5.20220329
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-10-24 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.3.2022.03.29.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,7 @@ 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
+- test.rb
 homepage: https://www.klaviyo.com/
 licenses:
 - Unlicense
@@ -190,7 +121,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 @@
-# Klaviyo::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 = Klaviyo::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
-)
-```
-