constant_contact_client 1.2.0 → 1.5.0

data/lib/constant_contact_client/models/custom_field_request.rb

@@ -0,0 +1,313 @@
+=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 CustomFieldRequest
+    # The custom field name to display in the UI (free-form text).
+    attr_accessor :label
+
+    # The type of data to store in the custom field.
+    attr_accessor :type
+
+    attr_accessor :metadata
+
+    # 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
+
+    # Available if data type is <code>data</code>. Displays <code>1</code> if using legacy date fields where values are stored as strings. Displays <code>2</code> if using new date fields where values are stored as actual dates to support date comparisons and validations.
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'label' => :'label',
+        :'type' => :'type',
+        :'metadata' => :'metadata',
+        :'choices' => :'choices',
+        :'version' => :'version'
+      }
+    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
+      {
+        :'label' => :'String',
+        :'type' => :'String',
+        :'metadata' => :'GetCustomField200ResponseMetadata',
+        :'choices' => :'Array<CreateCustomFieldsRequestChoicesInner>',
+        :'version' => :'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::CustomFieldRequest` 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::CustomFieldRequest`. 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']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'choices')
+        if (value = attributes[:'choices']).is_a?(Array)
+          self.choices = value
+        end
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      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 !@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? && @type.to_s.length > 20
+        invalid_properties.push('invalid value for "type", the character length must be smaller than or equal to 20.')
+      end
+
+      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
+    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 !@label.nil? && @label.to_s.length > 50
+      return false if !@type.nil? && @type.to_s.length > 20
+      return false if !@choices.nil? && @choices.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] label Value to be assigned
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'label cannot be nil'
+      end
+
+      if label.to_s.length > 50
+        fail ArgumentError, 'invalid value for "label", the character length must be smaller than or equal to 50.'
+      end
+
+      @label = label
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      if type.to_s.length > 20
+        fail ArgumentError, 'invalid value for "type", the character length must be smaller than or equal to 20.'
+      end
+
+      @type = type
+    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 &&
+          metadata == o.metadata &&
+          choices == o.choices &&
+          version == o.version
+    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
+      [label, type, metadata, choices, version].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_fields.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,7 +14,6 @@ require 'date'
 require 'time'
 
 module ConstantContactClient
-  # Use this endpoint to retrieve (GET) all custom_fields in the user's account, or to create (POST) a new custom_field.
   class CustomFields
     attr_accessor :custom_fields
 

data/lib/constant_contact_client/models/customer.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
@@ -27,6 +27,9 @@ module ConstantContactClient
     # The readOnly encoded account ID that uniquely identifies the account.
     attr_accessor :encoded_account_id
 
+    # The encoded partner id that identifies which Constant Contact partner provisioned the account.
+    attr_accessor :encoded_partner_id
+
     # The account owner's first name.
     attr_accessor :first_name
 
@@ -59,6 +62,7 @@ module ConstantContactClient
         :'contact_phone' => :'contact_phone',
         :'country_code' => :'country_code',
         :'encoded_account_id' => :'encoded_account_id',
+        :'encoded_partner_id' => :'encoded_partner_id',
         :'first_name' => :'first_name',
         :'last_name' => :'last_name',
         :'organization_name' => :'organization_name',
@@ -83,6 +87,7 @@ module ConstantContactClient
         :'contact_phone' => :'String',
         :'country_code' => :'String',
         :'encoded_account_id' => :'String',
+        :'encoded_partner_id' => :'String',
         :'first_name' => :'String',
         :'last_name' => :'String',
         :'organization_name' => :'String',
@@ -132,6 +137,10 @@ module ConstantContactClient
         self.encoded_account_id = attributes[:'encoded_account_id']
       end
 
+      if attributes.key?(:'encoded_partner_id')
+        self.encoded_partner_id = attributes[:'encoded_partner_id']
+      end
+
       if attributes.key?(:'first_name')
         self.first_name = attributes[:'first_name']
       end
@@ -212,6 +221,7 @@ module ConstantContactClient
           contact_phone == o.contact_phone &&
           country_code == o.country_code &&
           encoded_account_id == o.encoded_account_id &&
+          encoded_partner_id == o.encoded_partner_id &&
           first_name == o.first_name &&
           last_name == o.last_name &&
           organization_name == o.organization_name &&
@@ -232,7 +242,7 @@ module ConstantContactClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [contact_email, contact_phone, country_code, encoded_account_id, first_name, last_name, organization_name, organization_phone, state_code, time_zone_id, website, physical_address, company_logo].hash
+      [contact_email, contact_phone, country_code, encoded_account_id, encoded_partner_id, first_name, last_name, organization_name, organization_phone, state_code, time_zone_id, website, physical_address, company_logo].hash
     end
 
     # Builds the object from hash

data/lib/constant_contact_client/models/customer_put.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/delete_list202_response.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
@@ -21,7 +21,7 @@ module ConstantContactClient
     # The state of the request:  <p><ul>  <li>initialized - request has been received</li>  <li>processing - request is being processed</li>  <li>completed - job completed</li>  <li>cancelled - request was cancelled</li>  <li>failed - job failed to complete</li>  <li>timed_out - the request timed out before completing\"</li>   </ul> </p>
     attr_accessor :state
 
-    # Date and time that the request was received, in ISO-8601 formmat.
+    # Date and time that the request was received, in ISO-8601 format.
     attr_accessor :created_at
 
     # Date and time that the request status was updated, in ISO-8601 format.

data/lib/constant_contact_client/models/delete_tag202_response.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/delete_tag202_response_activity_errors_inner.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/delete_tag202_response_links.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/delete_tag202_response_links_self.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/delete_tag202_response_status.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