constant_contact_client 1.2.0 → 1.5.0

data/lib/constant_contact_client/models/jmml_sms_channel_consents.rb

@@ -0,0 +1,310 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.161
+
+The version of the OpenAPI document: 1.0.220
+Contact: webservices@constantcontact.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ConstantContactClient
+  class JmmlSmsChannelConsents
+    # The current consent status of the SMS Channel.
+    attr_accessor :sms_consent_permission
+
+    # The type of consent provided.
+    attr_accessor :consent_type
+
+    # A code representing where the consent was retrieved.
+    attr_accessor :consent_medium_type
+
+    # The URL for which the consent was gathered, such as a landing page.
+    attr_accessor :consent_medium_url
+
+    # Additional information for the consent
+    attr_accessor :consent_medium_details
+
+    # The numeric component used to indicate how often to send advertising. For example, <code>1</code> indicates once. Use with <code>advertised_internal</code> property to indicate when on the calender to send it. For example, to send once (<code>1</code>) daily, weekly, or monthly.
+    attr_accessor :advertised_frequency
+
+    # The calender interval used to indicate when advertising is sent. For example <code>weekly</code>.
+    attr_accessor :advertised_interval
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sms_consent_permission' => :'sms_consent_permission',
+        :'consent_type' => :'consent_type',
+        :'consent_medium_type' => :'consent_medium_type',
+        :'consent_medium_url' => :'consent_medium_url',
+        :'consent_medium_details' => :'consent_medium_details',
+        :'advertised_frequency' => :'advertised_frequency',
+        :'advertised_interval' => :'advertised_interval'
+      }
+    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
+      {
+        :'sms_consent_permission' => :'String',
+        :'consent_type' => :'String',
+        :'consent_medium_type' => :'String',
+        :'consent_medium_url' => :'String',
+        :'consent_medium_details' => :'String',
+        :'advertised_frequency' => :'Integer',
+        :'advertised_interval' => :'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 `ConstantContactClient::JmmlSmsChannelConsents` 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 `ConstantContactClient::JmmlSmsChannelConsents`. 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?(:'sms_consent_permission')
+        self.sms_consent_permission = attributes[:'sms_consent_permission']
+      else
+        self.sms_consent_permission = nil
+      end
+
+      if attributes.key?(:'consent_type')
+        self.consent_type = attributes[:'consent_type']
+      else
+        self.consent_type = nil
+      end
+
+      if attributes.key?(:'consent_medium_type')
+        self.consent_medium_type = attributes[:'consent_medium_type']
+      else
+        self.consent_medium_type = nil
+      end
+
+      if attributes.key?(:'consent_medium_url')
+        self.consent_medium_url = attributes[:'consent_medium_url']
+      else
+        self.consent_medium_url = nil
+      end
+
+      if attributes.key?(:'consent_medium_details')
+        self.consent_medium_details = attributes[:'consent_medium_details']
+      else
+        self.consent_medium_details = nil
+      end
+
+      if attributes.key?(:'advertised_frequency')
+        self.advertised_frequency = attributes[:'advertised_frequency']
+      end
+
+      if attributes.key?(:'advertised_interval')
+        self.advertised_interval = attributes[:'advertised_interval']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @sms_consent_permission.nil?
+        invalid_properties.push('invalid value for "sms_consent_permission", sms_consent_permission cannot be nil.')
+      end
+
+      if @consent_type.nil?
+        invalid_properties.push('invalid value for "consent_type", consent_type cannot be nil.')
+      end
+
+      if @consent_medium_type.nil?
+        invalid_properties.push('invalid value for "consent_medium_type", consent_medium_type cannot be nil.')
+      end
+
+      if @consent_medium_url.nil?
+        invalid_properties.push('invalid value for "consent_medium_url", consent_medium_url cannot be nil.')
+      end
+
+      if @consent_medium_details.nil?
+        invalid_properties.push('invalid value for "consent_medium_details", consent_medium_details 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @sms_consent_permission.nil?
+      return false if @consent_type.nil?
+      return false if @consent_medium_type.nil?
+      return false if @consent_medium_url.nil?
+      return false if @consent_medium_details.nil?
+      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 &&
+          sms_consent_permission == o.sms_consent_permission &&
+          consent_type == o.consent_type &&
+          consent_medium_type == o.consent_medium_type &&
+          consent_medium_url == o.consent_medium_url &&
+          consent_medium_details == o.consent_medium_details &&
+          advertised_frequency == o.advertised_frequency &&
+          advertised_interval == o.advertised_interval
+    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
+      [sms_consent_permission, consent_type, consent_medium_type, consent_medium_url, consent_medium_details, advertised_frequency, advertised_interval].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = ConstantContactClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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/constant_contact_client/models/json_import_contact.rb

@@ -1,9 +1,9 @@
 =begin
 #Constant Contact API v3
 
-#Swagger build version 3.0.2475
+#Swagger build version 3.0.161
 
-The version of the OpenAPI document: 1.0.109
+The version of the OpenAPI document: 1.0.220
 Contact: webservices@constantcontact.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.2.0
@@ -15,7 +15,7 @@ require 'time'
 
 module ConstantContactClient
   class JsonImportContact
-    # The email address of the contact. This method identifies each unique contact using their email address.
+    # The email address of the contact. This method identifies each unique contact using their email address. Required if `sms_number` is not specified.
     attr_accessor :email
 
     # The first name of the contact.
@@ -129,10 +129,10 @@ module ConstantContactClient
     # The name of this property is dynamic based on the custom fields you want to import. Use a key-value pair where the key is an existing custom field name prefixed with <code>cf:</code>, and the value is a custom field string value. For example, if you have a custom field named <code>first_name</code> you can use <code>\"cf:first_name\":\"Joe\"</code>. Each contact can contain up to 25 different custom fields.
     attr_accessor :cfcustom_field_name
 
-    # The US phone number to associate with the contact's SMS-enabled phone. The country code must be valid. Valid formats are <code>1231231234</code> or <code>123-123-1234</code>.
+    # The US phone number to associate with the contact's SMS-enabled phone. The country code must be valid. Valid formats are <code>1231231234</code> or <code>123-123-1234</code>. Required if `email` is not specified.
     attr_accessor :sms_number
 
-    # Required if the SMS permission is set to `explict`. The date that the contact consented to receiving SMS messages. Valid date formats are MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY .
+    # Required if the SMS permission is set to `explicit`. The date that the contact consented to receiving SMS messages. Valid date formats are MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY.
     attr_accessor :sms_consent_date
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -255,8 +255,6 @@ module ConstantContactClient
 
       if attributes.key?(:'email')
         self.email = attributes[:'email']
-      else
-        self.email = nil
       end
 
       if attributes.key?(:'first_name')
@@ -421,11 +419,7 @@ module ConstantContactClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @email.nil?
-        invalid_properties.push('invalid value for "email", email cannot be nil.')
-      end
-
-      if @email.to_s.length > 50
+      if !@email.nil? && @email.to_s.length > 50
         invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 50.')
       end
 
@@ -580,8 +574,7 @@ module ConstantContactClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @email.nil?
-      return false if @email.to_s.length > 50
+      return false if !@email.nil? && @email.to_s.length > 50
       return false if !@first_name.nil? && @first_name.to_s.length > 50
       return false if !@last_name.nil? && @last_name.to_s.length > 50
       return false if !@job_title.nil? && @job_title.to_s.length > 50

data/lib/constant_contact_client/models/line_item_details_dto.rb

@@ -0,0 +1,245 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.161
+
+The version of the OpenAPI document: 1.0.220
+Contact: webservices@constantcontact.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ConstantContactClient
+  class LineItemDetailsDto
+    # The formatted amount of the line item.
+    attr_accessor :amount
+
+    # The unformatted amount of the line item.
+    attr_accessor :amount_unformatted
+
+    # Type of line item.
+    attr_accessor :line_item_type
+
+    # The name of the line item.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'amount_unformatted' => :'amount_unformatted',
+        :'line_item_type' => :'line_item_type',
+        :'name' => :'name'
+      }
+    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
+      {
+        :'amount' => :'String',
+        :'amount_unformatted' => :'Float',
+        :'line_item_type' => :'String',
+        :'name' => :'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 `ConstantContactClient::LineItemDetailsDto` 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 `ConstantContactClient::LineItemDetailsDto`. 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?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'amount_unformatted')
+        self.amount_unformatted = attributes[:'amount_unformatted']
+      end
+
+      if attributes.key?(:'line_item_type')
+        self.line_item_type = attributes[:'line_item_type']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          amount == o.amount &&
+          amount_unformatted == o.amount_unformatted &&
+          line_item_type == o.line_item_type &&
+          name == o.name
+    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
+      [amount, amount_unformatted, line_item_type, name].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = ConstantContactClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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/constant_contact_client/models/link.rb

@@ -1,9 +1,9 @@
 =begin
 #Constant Contact API v3
 
-#Swagger build version 3.0.2475
+#Swagger build version 3.0.161
 
-The version of the OpenAPI document: 1.0.109
+The version of the OpenAPI document: 1.0.220
 Contact: webservices@constantcontact.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.2.0