constant_contact_client 1.2.0 → 1.5.0

data/lib/constant_contact_client/models/custom_field_choice_request.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
+  # The <code>single_select</code> and <code>multi_select</code> custom field options.
+  class CustomFieldChoiceRequest
+    # Label to display for the choice on the user interface.
+    attr_accessor :choice_label
+
+    # Stores the order for displaying a list of choices.
+    attr_accessor :display_order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'choice_label' => :'choice_label',
+        :'display_order' => :'display_order'
+      }
+    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
+      {
+        :'choice_label' => :'String',
+        :'display_order' => :'Integer'
+      }
+    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::CustomFieldChoiceRequest` 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::CustomFieldChoiceRequest`. 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?(:'choice_label')
+        self.choice_label = attributes[:'choice_label']
+      end
+
+      if attributes.key?(:'display_order')
+        self.display_order = attributes[:'display_order']
+      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 !@choice_label.nil? && @choice_label.to_s.length > 255
+        invalid_properties.push('invalid value for "choice_label", the character length must be smaller than or equal to 255.')
+      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 !@choice_label.nil? && @choice_label.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] choice_label Value to be assigned
+    def choice_label=(choice_label)
+      if choice_label.nil?
+        fail ArgumentError, 'choice_label cannot be nil'
+      end
+
+      if choice_label.to_s.length > 255
+        fail ArgumentError, 'invalid value for "choice_label", the character length must be smaller than or equal to 255.'
+      end
+
+      @choice_label = choice_label
+    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 &&
+          choice_label == o.choice_label &&
+          display_order == o.display_order
+    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
+      [choice_label, display_order].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/custom_field_id100.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

data/lib/constant_contact_client/models/custom_field_metadata.rb

@@ -0,0 +1,266 @@
+=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
+  # Additional details about a custom field in JSON format.
+  class CustomFieldMetadata
+    # Determines how Constant Contact renders a <code>single_select</code> or <code> multi_select</code> field.
+    attr_accessor :display_type
+
+    # For type <code>number</code>, determines if a value can be negative. By default, this value is false for the type <code>number</code>.
+    attr_accessor :allow_negative
+
+    # For types <code>number</code> and <code>currency</code>, determines the number of decimal places possible in the value.
+    attr_accessor :decimal_places
+
+    # For type <code>currency</code>, specifies the three-letter currency code to assign.
+    attr_accessor :currency_code
+
+    # For types <code>number</code> and <code>currency</code>, determines whether the custom field should store only whole numbers (integers) without decimal values. If the <code>integer</code> is set to <code>false</code>, the <code>decimal_places</code> must be between 1 and 4.
+    attr_accessor :integer
+
+    # Specifies the display format for date fields in the user interface. If not specified for a date type field, defaults to <code>YYYY-MM-DD</code> format. Valid only for version 2 type dates (values are stored as actual dates to support date comparisons and validations).
+    attr_accessor :display_format
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'display_type' => :'display_type',
+        :'allow_negative' => :'allow_negative',
+        :'decimal_places' => :'decimal_places',
+        :'currency_code' => :'currency_code',
+        :'integer' => :'integer',
+        :'display_format' => :'display_format'
+      }
+    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
+      {
+        :'display_type' => :'String',
+        :'allow_negative' => :'Boolean',
+        :'decimal_places' => :'Integer',
+        :'currency_code' => :'String',
+        :'integer' => :'Boolean',
+        :'display_format' => :'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::CustomFieldMetadata` 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::CustomFieldMetadata`. 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?(:'display_type')
+        self.display_type = attributes[:'display_type']
+      end
+
+      if attributes.key?(:'allow_negative')
+        self.allow_negative = attributes[:'allow_negative']
+      end
+
+      if attributes.key?(:'decimal_places')
+        self.decimal_places = attributes[:'decimal_places']
+      end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.key?(:'integer')
+        self.integer = attributes[:'integer']
+      end
+
+      if attributes.key?(:'display_format')
+        self.display_format = attributes[:'display_format']
+      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 &&
+          display_type == o.display_type &&
+          allow_negative == o.allow_negative &&
+          decimal_places == o.decimal_places &&
+          currency_code == o.currency_code &&
+          integer == o.integer &&
+          display_format == o.display_format
+    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
+      [display_type, allow_negative, decimal_places, currency_code, integer, display_format].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/{custom_field_input.rb → custom_field_put_request.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
@@ -14,18 +14,18 @@ require 'date'
 require 'time'
 
 module ConstantContactClient
-  class CustomFieldInput
-    # The display name for the custom_field shown in the UI as free-form text
+  class CustomFieldPutRequest
+    # The custom field name to display in the UI (free-form text).
     attr_accessor :label
 
-    # Specifies the type of value the custom_field field accepts: string or date.
-    attr_accessor :type
+    # Array of choices for custom fields of type: <code>single_select</code> or <code>multi_select</code>. Maximum number of elements for <code>checkbox</code> and <code>radio</code> display types is 20. Maximum number of elements for a <code>dropdown</code> is 100.
+    attr_accessor :choices
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'label' => :'label',
-        :'type' => :'type'
+        :'choices' => :'choices'
       }
     end
 
@@ -38,7 +38,7 @@ module ConstantContactClient
     def self.openapi_types
       {
         :'label' => :'String',
-        :'type' => :'String'
+        :'choices' => :'Array<UpdateCustomFieldRequestChoicesInner>'
       }
     end
 
@@ -52,27 +52,25 @@ module ConstantContactClient
     # @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::CustomFieldInput` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ConstantContactClient::CustomFieldPutRequest` 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::CustomFieldInput`. 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 `ConstantContactClient::CustomFieldPutRequest`. 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?(:'label')
         self.label = attributes[:'label']
-      else
-        self.label = nil
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      else
-        self.type = nil
+      if attributes.key?(:'choices')
+        if (value = attributes[:'choices']).is_a?(Array)
+          self.choices = value
+        end
       end
     end
 
@@ -81,16 +79,12 @@ module ConstantContactClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @label.nil?
-        invalid_properties.push('invalid value for "label", label cannot be nil.')
-      end
-
-      if @label.to_s.length > 50
+      if !@label.nil? && @label.to_s.length > 50
         invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 50.')
       end
 
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      if !@choices.nil? && @choices.length > 100
+        invalid_properties.push('invalid value for "choices", number of items must be less than or equal to 100.')
       end
 
       invalid_properties
@@ -100,9 +94,8 @@ module ConstantContactClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @label.nil?
-      return false if @label.to_s.length > 50
-      return false if @type.nil?
+      return false if !@label.nil? && @label.to_s.length > 50
+      return false if !@choices.nil? && @choices.length > 100
       true
     end
 
@@ -120,13 +113,27 @@ module ConstantContactClient
       @label = label
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] choices Value to be assigned
+    def choices=(choices)
+      if choices.nil?
+        fail ArgumentError, 'choices cannot be nil'
+      end
+
+      if choices.length > 100
+        fail ArgumentError, 'invalid value for "choices", number of items must be less than or equal to 100.'
+      end
+
+      @choices = choices
+    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 &&
           label == o.label &&
-          type == o.type
+          choices == o.choices
     end
 
     # @see the `==` method
@@ -138,7 +145,7 @@ module ConstantContactClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [label, type].hash
+      [label, choices].hash
     end
 
     # Builds the object from hash