klaviyo-api-sdk 18.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb

@@ -0,0 +1,440 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class TollFreeRegistrationDetailsResourceObjectAttributes
+    # Contact first name.
+    attr_accessor :first_name
+
+    # Contact last name.
+    attr_accessor :last_name
+
+    # Contact phone number in E.164 format.
+    attr_accessor :phone_number
+
+    # Contact email address.
+    attr_accessor :email
+
+    attr_accessor :address
+
+    # Legal structure of the business.
+    attr_accessor :business_type
+
+    # Legal business name.
+    attr_accessor :business_name
+
+    # Public website URL for the business.
+    attr_accessor :business_website
+
+    # DBA name if different from the legal business name.
+    attr_accessor :doing_business_as
+
+    # ISO 3166-1 alpha-2 country in which the business is registered. Required for all businesses; must be `US` for a sole proprietor omitting the registration authority and number.
+    attr_accessor :business_registration_country
+
+    # Authority that issued the business registration number. Required unless the business is a US sole proprietor without a registration number.
+    attr_accessor :business_registration_authority
+
+    # Business registration number. Required unless the business is a US sole proprietor.
+    attr_accessor :business_registration_number
+
+    # Public URL of the business's privacy policy.
+    attr_accessor :privacy_policy_url
+
+    # Public URL of the business's terms of service.
+    attr_accessor :terms_of_service_url
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'phone_number' => :'phone_number',
+        :'email' => :'email',
+        :'address' => :'address',
+        :'business_type' => :'business_type',
+        :'business_name' => :'business_name',
+        :'business_website' => :'business_website',
+        :'doing_business_as' => :'doing_business_as',
+        :'business_registration_country' => :'business_registration_country',
+        :'business_registration_authority' => :'business_registration_authority',
+        :'business_registration_number' => :'business_registration_number',
+        :'privacy_policy_url' => :'privacy_policy_url',
+        :'terms_of_service_url' => :'terms_of_service_url'
+      }
+    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
+      {
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'phone_number' => :'String',
+        :'email' => :'String',
+        :'address' => :'Address',
+        :'business_type' => :'String',
+        :'business_name' => :'String',
+        :'business_website' => :'String',
+        :'doing_business_as' => :'String',
+        :'business_registration_country' => :'String',
+        :'business_registration_authority' => :'String',
+        :'business_registration_number' => :'String',
+        :'privacy_policy_url' => :'String',
+        :'terms_of_service_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'doing_business_as',
+        :'business_registration_country',
+        :'business_registration_authority',
+        :'business_registration_number',
+        :'privacy_policy_url',
+        :'terms_of_service_url'
+      ])
+    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 `KlaviyoAPI::TollFreeRegistrationDetailsResourceObjectAttributes` 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 `KlaviyoAPI::TollFreeRegistrationDetailsResourceObjectAttributes`. 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?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'business_type')
+        self.business_type = attributes[:'business_type']
+      end
+
+      if attributes.key?(:'business_name')
+        self.business_name = attributes[:'business_name']
+      end
+
+      if attributes.key?(:'business_website')
+        self.business_website = attributes[:'business_website']
+      end
+
+      if attributes.key?(:'doing_business_as')
+        self.doing_business_as = attributes[:'doing_business_as']
+      end
+
+      if attributes.key?(:'business_registration_country')
+        self.business_registration_country = attributes[:'business_registration_country']
+      end
+
+      if attributes.key?(:'business_registration_authority')
+        self.business_registration_authority = attributes[:'business_registration_authority']
+      end
+
+      if attributes.key?(:'business_registration_number')
+        self.business_registration_number = attributes[:'business_registration_number']
+      end
+
+      if attributes.key?(:'privacy_policy_url')
+        self.privacy_policy_url = attributes[:'privacy_policy_url']
+      end
+
+      if attributes.key?(:'terms_of_service_url')
+        self.terms_of_service_url = attributes[:'terms_of_service_url']
+      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
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @phone_number.nil?
+        invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
+      end
+
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @address.nil?
+        invalid_properties.push('invalid value for "address", address cannot be nil.')
+      end
+
+      if @business_type.nil?
+        invalid_properties.push('invalid value for "business_type", business_type cannot be nil.')
+      end
+
+      if @business_name.nil?
+        invalid_properties.push('invalid value for "business_name", business_name cannot be nil.')
+      end
+
+      if @business_website.nil?
+        invalid_properties.push('invalid value for "business_website", business_website cannot be nil.')
+      end
+
+      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?
+      return false if @first_name.nil?
+      return false if @last_name.nil?
+      return false if @phone_number.nil?
+      return false if @email.nil?
+      return false if @address.nil?
+      return false if @business_type.nil?
+      business_type_validator = EnumAttributeValidator.new('String', ["GOVERNMENT", "NON_PROFIT", "PRIVATE_PROFIT", "PUBLIC_PROFIT", "SOLE_PROPRIETOR"])
+      return false unless business_type_validator.valid?(@business_type)
+      return false if @business_name.nil?
+      return false if @business_website.nil?
+      business_registration_authority_validator = EnumAttributeValidator.new('String', ["ABN", "ACN", "BRN", "CBN", "CIF", "CNPJ", "CRN", "EIN", "NEQ", "NIF", "NZBN", "OTHER", "PROVINCIAL_NUMBER", "SIREN", "SIRET", "UID", "USt-IdNr", "VAT"])
+      return false unless business_registration_authority_validator.valid?(@business_registration_authority)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] business_type Object to be assigned
+    def business_type=(business_type)
+      validator = EnumAttributeValidator.new('String', ["GOVERNMENT", "NON_PROFIT", "PRIVATE_PROFIT", "PUBLIC_PROFIT", "SOLE_PROPRIETOR"])
+      unless validator.valid?(business_type)
+        fail ArgumentError, "invalid value for \"business_type\", must be one of #{validator.allowable_values}."
+      end
+      @business_type = business_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] business_registration_authority Object to be assigned
+    def business_registration_authority=(business_registration_authority)
+      validator = EnumAttributeValidator.new('String', ["ABN", "ACN", "BRN", "CBN", "CIF", "CNPJ", "CRN", "EIN", "NEQ", "NIF", "NZBN", "OTHER", "PROVINCIAL_NUMBER", "SIREN", "SIRET", "UID", "USt-IdNr", "VAT"])
+      unless validator.valid?(business_registration_authority)
+        fail ArgumentError, "invalid value for \"business_registration_authority\", must be one of #{validator.allowable_values}."
+      end
+      @business_registration_authority = business_registration_authority
+    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 &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          phone_number == o.phone_number &&
+          email == o.email &&
+          address == o.address &&
+          business_type == o.business_type &&
+          business_name == o.business_name &&
+          business_website == o.business_website &&
+          doing_business_as == o.doing_business_as &&
+          business_registration_country == o.business_registration_country &&
+          business_registration_authority == o.business_registration_authority &&
+          business_registration_number == o.business_registration_number &&
+          privacy_policy_url == o.privacy_policy_url &&
+          terms_of_service_url == o.terms_of_service_url
+    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
+      [first_name, last_name, phone_number, email, address, business_type, business_name, business_website, doing_business_as, business_registration_country, business_registration_authority, business_registration_number, privacy_policy_url, terms_of_service_url].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = KlaviyoAPI.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-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb}

@@ -13,8 +13,9 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class ImmediateSendStrategy
-    attr_accessor :method
+  class TollFreeSenderDetails
+    # ISO 3166-1 alpha-2 country code for the sender. Supported values: `US` and `CA`.
+    attr_accessor :country
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -41,7 +42,7 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'method' => :'method'
+        :'country' => :'country'
       }
     end
 
@@ -53,7 +54,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'method' => :'String'
+        :'country' => :'String'
       }
     end
 
@@ -67,19 +68,19 @@ module KlaviyoAPI
     # @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 `KlaviyoAPI::ImmediateSendStrategy` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::TollFreeSenderDetails` 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 `KlaviyoAPI::ImmediateSendStrategy`. 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 `KlaviyoAPI::TollFreeSenderDetails`. 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?(:'method')
-        self.method = attributes[:'method']
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
       end
     end
 
@@ -87,8 +88,8 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @method.nil?
-        invalid_properties.push('invalid value for "method", method cannot be nil.')
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
       end
 
       invalid_properties
@@ -97,20 +98,20 @@ module KlaviyoAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @method.nil?
-      method_validator = EnumAttributeValidator.new('String', ["immediate"])
-      return false unless method_validator.valid?(@method)
+      return false if @country.nil?
+      country_validator = EnumAttributeValidator.new('String', ["CA", "US"])
+      return false unless country_validator.valid?(@country)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] method Object to be assigned
-    def method=(method)
-      validator = EnumAttributeValidator.new('String', ["immediate"])
-      unless validator.valid?(method)
-        fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
+    # @param [Object] country Object to be assigned
+    def country=(country)
+      validator = EnumAttributeValidator.new('String', ["CA", "US"])
+      unless validator.valid?(country)
+        fail ArgumentError, "invalid value for \"country\", must be one of #{validator.allowable_values}."
       end
-      @method = method
+      @country = country
     end
 
     # Checks equality by comparing each attribute.
@@ -118,7 +119,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          method == o.method
+          country == o.country
     end
 
     # @see the `==` method
@@ -130,7 +131,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [method].hash
+      [country].hash
     end
 
     # Builds the object from hash