constant_contact_client 1.0.0

data/lib/constant_contact_client/models/email_campaign_activity_input.rb

@@ -0,0 +1,402 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.2475
+
+The version of the OpenAPI document: 1.0.101
+Contact: webservices@constantcontact.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ConstantContactClient
+  class EmailCampaignActivityInput
+    # The email format you are using to create the email campaign activity. The V3 API supports creating emails using <code>format_type</code> 5 (custom code emails). 
+    attr_accessor :format_type
+
+    # The email sender's name to display for the email campaign activity.
+    attr_accessor :from_name
+
+    # The sender's email address to use for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
+    attr_accessor :from_email
+
+    # The sender's email address to use if the contact replies to the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
+    attr_accessor :reply_to_email
+
+    # The text to display in the subject line that describes the email campaign activity.
+    attr_accessor :subject
+
+    # The email preheader for the email campaign activity. Contacts will view your preheader as a short summary that follows the subject line in their email client. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property.
+    attr_accessor :preheader
+
+    # The HTML content for the email campaign activity. Only <code>format_type</code> 5 (custom code emails) can contain <code>html_content</code>. When creating a <code>format_type</code> 5 custom code email, make sure that you include <code>[[trackingImage]]</code> in the <code>&lt;body&gt;</code> element of your HTML. 
+    attr_accessor :html_content
+
+    attr_accessor :physical_address_in_footer
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'format_type' => :'format_type',
+        :'from_name' => :'from_name',
+        :'from_email' => :'from_email',
+        :'reply_to_email' => :'reply_to_email',
+        :'subject' => :'subject',
+        :'preheader' => :'preheader',
+        :'html_content' => :'html_content',
+        :'physical_address_in_footer' => :'physical_address_in_footer'
+      }
+    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
+      {
+        :'format_type' => :'Integer',
+        :'from_name' => :'String',
+        :'from_email' => :'String',
+        :'reply_to_email' => :'String',
+        :'subject' => :'String',
+        :'preheader' => :'String',
+        :'html_content' => :'String',
+        :'physical_address_in_footer' => :'CreateEmailCampaignRequestEmailCampaignActivitiesInnerPhysicalAddressInFooter'
+      }
+    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::EmailCampaignActivityInput` 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::EmailCampaignActivityInput`. 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?(:'format_type')
+        self.format_type = attributes[:'format_type']
+      else
+        self.format_type = nil
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      else
+        self.from_name = nil
+      end
+
+      if attributes.key?(:'from_email')
+        self.from_email = attributes[:'from_email']
+      else
+        self.from_email = nil
+      end
+
+      if attributes.key?(:'reply_to_email')
+        self.reply_to_email = attributes[:'reply_to_email']
+      else
+        self.reply_to_email = nil
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      else
+        self.subject = nil
+      end
+
+      if attributes.key?(:'preheader')
+        self.preheader = attributes[:'preheader']
+      end
+
+      if attributes.key?(:'html_content')
+        self.html_content = attributes[:'html_content']
+      else
+        self.html_content = nil
+      end
+
+      if attributes.key?(:'physical_address_in_footer')
+        self.physical_address_in_footer = attributes[:'physical_address_in_footer']
+      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 @format_type.nil?
+        invalid_properties.push('invalid value for "format_type", format_type cannot be nil.')
+      end
+
+      if @from_name.nil?
+        invalid_properties.push('invalid value for "from_name", from_name cannot be nil.')
+      end
+
+      if @from_name.to_s.length > 100
+        invalid_properties.push('invalid value for "from_name", the character length must be smaller than or equal to 100.')
+      end
+
+      if @from_email.nil?
+        invalid_properties.push('invalid value for "from_email", from_email cannot be nil.')
+      end
+
+      if @from_email.to_s.length > 80
+        invalid_properties.push('invalid value for "from_email", the character length must be smaller than or equal to 80.')
+      end
+
+      if @reply_to_email.nil?
+        invalid_properties.push('invalid value for "reply_to_email", reply_to_email cannot be nil.')
+      end
+
+      if @reply_to_email.to_s.length > 80
+        invalid_properties.push('invalid value for "reply_to_email", the character length must be smaller than or equal to 80.')
+      end
+
+      if @subject.nil?
+        invalid_properties.push('invalid value for "subject", subject cannot be nil.')
+      end
+
+      if @html_content.nil?
+        invalid_properties.push('invalid value for "html_content", html_content cannot be nil.')
+      end
+
+      if @html_content.to_s.length > 150000
+        invalid_properties.push('invalid value for "html_content", the character length must be smaller than or equal to 150000.')
+      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 @format_type.nil?
+      return false if @from_name.nil?
+      return false if @from_name.to_s.length > 100
+      return false if @from_email.nil?
+      return false if @from_email.to_s.length > 80
+      return false if @reply_to_email.nil?
+      return false if @reply_to_email.to_s.length > 80
+      return false if @subject.nil?
+      return false if @html_content.nil?
+      return false if @html_content.to_s.length > 150000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_name Value to be assigned
+    def from_name=(from_name)
+      if from_name.nil?
+        fail ArgumentError, 'from_name cannot be nil'
+      end
+
+      if from_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "from_name", the character length must be smaller than or equal to 100.'
+      end
+
+      @from_name = from_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_email Value to be assigned
+    def from_email=(from_email)
+      if from_email.nil?
+        fail ArgumentError, 'from_email cannot be nil'
+      end
+
+      if from_email.to_s.length > 80
+        fail ArgumentError, 'invalid value for "from_email", the character length must be smaller than or equal to 80.'
+      end
+
+      @from_email = from_email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reply_to_email Value to be assigned
+    def reply_to_email=(reply_to_email)
+      if reply_to_email.nil?
+        fail ArgumentError, 'reply_to_email cannot be nil'
+      end
+
+      if reply_to_email.to_s.length > 80
+        fail ArgumentError, 'invalid value for "reply_to_email", the character length must be smaller than or equal to 80.'
+      end
+
+      @reply_to_email = reply_to_email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] html_content Value to be assigned
+    def html_content=(html_content)
+      if html_content.nil?
+        fail ArgumentError, 'html_content cannot be nil'
+      end
+
+      if html_content.to_s.length > 150000
+        fail ArgumentError, 'invalid value for "html_content", the character length must be smaller than or equal to 150000.'
+      end
+
+      @html_content = html_content
+    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 &&
+          format_type == o.format_type &&
+          from_name == o.from_name &&
+          from_email == o.from_email &&
+          reply_to_email == o.reply_to_email &&
+          subject == o.subject &&
+          preheader == o.preheader &&
+          html_content == o.html_content &&
+          physical_address_in_footer == o.physical_address_in_footer
+    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
+      [format_type, from_name, from_email, reply_to_email, subject, preheader, html_content, physical_address_in_footer].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/email_campaign_activity_preview.rb

@@ -0,0 +1,285 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.2475
+
+The version of the OpenAPI document: 1.0.101
+Contact: webservices@constantcontact.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ConstantContactClient
+  class EmailCampaignActivityPreview
+    # The unique ID for an email campaign activity.
+    attr_accessor :campaign_activity_id
+
+    # The \"from email\" email header for the email campaign activity.
+    attr_accessor :from_email
+
+    # The \"from name\" email header for the email campaign activity.
+    attr_accessor :from_name
+
+    # The email preheader for the email campaign activity. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property.
+    attr_accessor :preheader
+
+    # An HTML preview of the email campaign activity.
+    attr_accessor :preview_html_content
+
+    # A plain text preview of the email campaign activity.
+    attr_accessor :preview_text_content
+
+    # The email \"Reply To Email\" field for the email campaign activity.
+    attr_accessor :reply_to_email
+
+    # The email \"Subject\" field for the email campaign activity.
+    attr_accessor :subject
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_activity_id' => :'campaign_activity_id',
+        :'from_email' => :'from_email',
+        :'from_name' => :'from_name',
+        :'preheader' => :'preheader',
+        :'preview_html_content' => :'preview_html_content',
+        :'preview_text_content' => :'preview_text_content',
+        :'reply_to_email' => :'reply_to_email',
+        :'subject' => :'subject'
+      }
+    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
+      {
+        :'campaign_activity_id' => :'String',
+        :'from_email' => :'String',
+        :'from_name' => :'String',
+        :'preheader' => :'String',
+        :'preview_html_content' => :'String',
+        :'preview_text_content' => :'String',
+        :'reply_to_email' => :'String',
+        :'subject' => :'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::EmailCampaignActivityPreview` 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::EmailCampaignActivityPreview`. 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?(:'campaign_activity_id')
+        self.campaign_activity_id = attributes[:'campaign_activity_id']
+      end
+
+      if attributes.key?(:'from_email')
+        self.from_email = attributes[:'from_email']
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'preheader')
+        self.preheader = attributes[:'preheader']
+      end
+
+      if attributes.key?(:'preview_html_content')
+        self.preview_html_content = attributes[:'preview_html_content']
+      end
+
+      if attributes.key?(:'preview_text_content')
+        self.preview_text_content = attributes[:'preview_text_content']
+      end
+
+      if attributes.key?(:'reply_to_email')
+        self.reply_to_email = attributes[:'reply_to_email']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      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 &&
+          campaign_activity_id == o.campaign_activity_id &&
+          from_email == o.from_email &&
+          from_name == o.from_name &&
+          preheader == o.preheader &&
+          preview_html_content == o.preview_html_content &&
+          preview_text_content == o.preview_text_content &&
+          reply_to_email == o.reply_to_email &&
+          subject == o.subject
+    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
+      [campaign_activity_id, from_email, from_name, preheader, preview_html_content, preview_text_content, reply_to_email, subject].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