reacon-sdk 0.1.0.beta.4

data/lib/reacon-sdk/models/mail_post_cadence_runs_request.rb

@@ -0,0 +1,533 @@
+=begin
+#Reacon API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Reacon
+  # Additional server validation applies; this structural schema does not express every contextual or cross-field rule.
+  class MailPostCadenceRunsRequest < ApiModelBase
+    attr_accessor :audience_list_id
+
+    attr_accessor :cadence_id
+
+    attr_accessor :cadence_version
+
+    attr_accessor :campaign_id
+
+    attr_accessor :campaign_name
+
+    attr_accessor :contact_ids
+
+    attr_accessor :enrollment_mode
+
+    attr_accessor :idempotency_key
+
+    attr_accessor :mailbox_id
+
+    attr_accessor :mailbox_pool_id
+
+    attr_accessor :scheduled_at
+
+    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
+      {
+        :'audience_list_id' => :'audienceListId',
+        :'cadence_id' => :'cadenceId',
+        :'cadence_version' => :'cadenceVersion',
+        :'campaign_id' => :'campaignId',
+        :'campaign_name' => :'campaignName',
+        :'contact_ids' => :'contactIds',
+        :'enrollment_mode' => :'enrollmentMode',
+        :'idempotency_key' => :'idempotencyKey',
+        :'mailbox_id' => :'mailboxId',
+        :'mailbox_pool_id' => :'mailboxPoolId',
+        :'scheduled_at' => :'scheduledAt'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'audience_list_id' => :'String',
+        :'cadence_id' => :'String',
+        :'cadence_version' => :'Integer',
+        :'campaign_id' => :'String',
+        :'campaign_name' => :'String',
+        :'contact_ids' => :'Array<String>',
+        :'enrollment_mode' => :'String',
+        :'idempotency_key' => :'String',
+        :'mailbox_id' => :'String',
+        :'mailbox_pool_id' => :'String',
+        :'scheduled_at' => :'Time'
+      }
+    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 `Reacon::MailPostCadenceRunsRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Reacon::MailPostCadenceRunsRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'audience_list_id')
+        self.audience_list_id = attributes[:'audience_list_id']
+      end
+
+      if attributes.key?(:'cadence_id')
+        self.cadence_id = attributes[:'cadence_id']
+      else
+        self.cadence_id = nil
+      end
+
+      if attributes.key?(:'cadence_version')
+        self.cadence_version = attributes[:'cadence_version']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'campaign_name')
+        self.campaign_name = attributes[:'campaign_name']
+      end
+
+      if attributes.key?(:'contact_ids')
+        if (value = attributes[:'contact_ids']).is_a?(Array)
+          self.contact_ids = value
+        end
+      end
+
+      if attributes.key?(:'enrollment_mode')
+        self.enrollment_mode = attributes[:'enrollment_mode']
+      else
+        self.enrollment_mode = 'new_only'
+      end
+
+      if attributes.key?(:'idempotency_key')
+        self.idempotency_key = attributes[:'idempotency_key']
+      else
+        self.idempotency_key = nil
+      end
+
+      if attributes.key?(:'mailbox_id')
+        self.mailbox_id = attributes[:'mailbox_id']
+      end
+
+      if attributes.key?(:'mailbox_pool_id')
+        self.mailbox_pool_id = attributes[:'mailbox_pool_id']
+      end
+
+      if attributes.key?(:'scheduled_at')
+        self.scheduled_at = attributes[:'scheduled_at']
+      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 !@audience_list_id.nil? && @audience_list_id.to_s.length > 200
+        invalid_properties.push('invalid value for "audience_list_id", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@audience_list_id.nil? && @audience_list_id.to_s.length < 1
+        invalid_properties.push('invalid value for "audience_list_id", the character length must be greater than or equal to 1.')
+      end
+
+      if @cadence_id.nil?
+        invalid_properties.push('invalid value for "cadence_id", cadence_id cannot be nil.')
+      end
+
+      if @cadence_id.to_s.length > 200
+        invalid_properties.push('invalid value for "cadence_id", the character length must be smaller than or equal to 200.')
+      end
+
+      if @cadence_id.to_s.length < 1
+        invalid_properties.push('invalid value for "cadence_id", the character length must be greater than or equal to 1.')
+      end
+
+      if !@cadence_version.nil? && @cadence_version <= 0
+        invalid_properties.push('invalid value for "cadence_version", must be greater than 0.')
+      end
+
+      if !@campaign_id.nil? && @campaign_id.to_s.length > 200
+        invalid_properties.push('invalid value for "campaign_id", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@campaign_id.nil? && @campaign_id.to_s.length < 1
+        invalid_properties.push('invalid value for "campaign_id", the character length must be greater than or equal to 1.')
+      end
+
+      if !@campaign_name.nil? && @campaign_name.to_s.length > 200
+        invalid_properties.push('invalid value for "campaign_name", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@campaign_name.nil? && @campaign_name.to_s.length < 1
+        invalid_properties.push('invalid value for "campaign_name", the character length must be greater than or equal to 1.')
+      end
+
+      if !@contact_ids.nil? && @contact_ids.length > 500
+        invalid_properties.push('invalid value for "contact_ids", number of items must be less than or equal to 500.')
+      end
+
+      if !@contact_ids.nil? && @contact_ids.length < 1
+        invalid_properties.push('invalid value for "contact_ids", number of items must be greater than or equal to 1.')
+      end
+
+      if @idempotency_key.nil?
+        invalid_properties.push('invalid value for "idempotency_key", idempotency_key cannot be nil.')
+      end
+
+      if @idempotency_key.to_s.length > 200
+        invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 200.')
+      end
+
+      if @idempotency_key.to_s.length < 1
+        invalid_properties.push('invalid value for "idempotency_key", the character length must be greater than or equal to 1.')
+      end
+
+      if !@mailbox_id.nil? && @mailbox_id.to_s.length > 200
+        invalid_properties.push('invalid value for "mailbox_id", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@mailbox_id.nil? && @mailbox_id.to_s.length < 1
+        invalid_properties.push('invalid value for "mailbox_id", the character length must be greater than or equal to 1.')
+      end
+
+      if !@mailbox_pool_id.nil? && @mailbox_pool_id.to_s.length > 200
+        invalid_properties.push('invalid value for "mailbox_pool_id", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@mailbox_pool_id.nil? && @mailbox_pool_id.to_s.length < 1
+        invalid_properties.push('invalid value for "mailbox_pool_id", the character length must be greater than or equal to 1.')
+      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 !@audience_list_id.nil? && @audience_list_id.to_s.length > 200
+      return false if !@audience_list_id.nil? && @audience_list_id.to_s.length < 1
+      return false if @cadence_id.nil?
+      return false if @cadence_id.to_s.length > 200
+      return false if @cadence_id.to_s.length < 1
+      return false if !@cadence_version.nil? && @cadence_version <= 0
+      return false if !@campaign_id.nil? && @campaign_id.to_s.length > 200
+      return false if !@campaign_id.nil? && @campaign_id.to_s.length < 1
+      return false if !@campaign_name.nil? && @campaign_name.to_s.length > 200
+      return false if !@campaign_name.nil? && @campaign_name.to_s.length < 1
+      return false if !@contact_ids.nil? && @contact_ids.length > 500
+      return false if !@contact_ids.nil? && @contact_ids.length < 1
+      enrollment_mode_validator = EnumAttributeValidator.new('String', ["new_only", "reenroll"])
+      return false unless enrollment_mode_validator.valid?(@enrollment_mode)
+      return false if @idempotency_key.nil?
+      return false if @idempotency_key.to_s.length > 200
+      return false if @idempotency_key.to_s.length < 1
+      return false if !@mailbox_id.nil? && @mailbox_id.to_s.length > 200
+      return false if !@mailbox_id.nil? && @mailbox_id.to_s.length < 1
+      return false if !@mailbox_pool_id.nil? && @mailbox_pool_id.to_s.length > 200
+      return false if !@mailbox_pool_id.nil? && @mailbox_pool_id.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] audience_list_id Value to be assigned
+    def audience_list_id=(audience_list_id)
+      if audience_list_id.nil?
+        fail ArgumentError, 'audience_list_id cannot be nil'
+      end
+
+      if audience_list_id.to_s.length > 200
+        fail ArgumentError, 'invalid value for "audience_list_id", the character length must be smaller than or equal to 200.'
+      end
+
+      if audience_list_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "audience_list_id", the character length must be greater than or equal to 1.'
+      end
+
+      @audience_list_id = audience_list_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cadence_id Value to be assigned
+    def cadence_id=(cadence_id)
+      if cadence_id.nil?
+        fail ArgumentError, 'cadence_id cannot be nil'
+      end
+
+      if cadence_id.to_s.length > 200
+        fail ArgumentError, 'invalid value for "cadence_id", the character length must be smaller than or equal to 200.'
+      end
+
+      if cadence_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "cadence_id", the character length must be greater than or equal to 1.'
+      end
+
+      @cadence_id = cadence_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cadence_version Value to be assigned
+    def cadence_version=(cadence_version)
+      if cadence_version.nil?
+        fail ArgumentError, 'cadence_version cannot be nil'
+      end
+
+      if cadence_version <= 0
+        fail ArgumentError, 'invalid value for "cadence_version", must be greater than 0.'
+      end
+
+      @cadence_version = cadence_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_id Value to be assigned
+    def campaign_id=(campaign_id)
+      if campaign_id.nil?
+        fail ArgumentError, 'campaign_id cannot be nil'
+      end
+
+      if campaign_id.to_s.length > 200
+        fail ArgumentError, 'invalid value for "campaign_id", the character length must be smaller than or equal to 200.'
+      end
+
+      if campaign_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "campaign_id", the character length must be greater than or equal to 1.'
+      end
+
+      @campaign_id = campaign_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_name Value to be assigned
+    def campaign_name=(campaign_name)
+      if campaign_name.nil?
+        fail ArgumentError, 'campaign_name cannot be nil'
+      end
+
+      if campaign_name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "campaign_name", the character length must be smaller than or equal to 200.'
+      end
+
+      if campaign_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "campaign_name", the character length must be greater than or equal to 1.'
+      end
+
+      @campaign_name = campaign_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contact_ids Value to be assigned
+    def contact_ids=(contact_ids)
+      if contact_ids.nil?
+        fail ArgumentError, 'contact_ids cannot be nil'
+      end
+
+      if contact_ids.length > 500
+        fail ArgumentError, 'invalid value for "contact_ids", number of items must be less than or equal to 500.'
+      end
+
+      if contact_ids.length < 1
+        fail ArgumentError, 'invalid value for "contact_ids", number of items must be greater than or equal to 1.'
+      end
+
+      @contact_ids = contact_ids
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] enrollment_mode Object to be assigned
+    def enrollment_mode=(enrollment_mode)
+      validator = EnumAttributeValidator.new('String', ["new_only", "reenroll"])
+      unless validator.valid?(enrollment_mode)
+        fail ArgumentError, "invalid value for \"enrollment_mode\", must be one of #{validator.allowable_values}."
+      end
+      @enrollment_mode = enrollment_mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] idempotency_key Value to be assigned
+    def idempotency_key=(idempotency_key)
+      if idempotency_key.nil?
+        fail ArgumentError, 'idempotency_key cannot be nil'
+      end
+
+      if idempotency_key.to_s.length > 200
+        fail ArgumentError, 'invalid value for "idempotency_key", the character length must be smaller than or equal to 200.'
+      end
+
+      if idempotency_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "idempotency_key", the character length must be greater than or equal to 1.'
+      end
+
+      @idempotency_key = idempotency_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mailbox_id Value to be assigned
+    def mailbox_id=(mailbox_id)
+      if mailbox_id.nil?
+        fail ArgumentError, 'mailbox_id cannot be nil'
+      end
+
+      if mailbox_id.to_s.length > 200
+        fail ArgumentError, 'invalid value for "mailbox_id", the character length must be smaller than or equal to 200.'
+      end
+
+      if mailbox_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "mailbox_id", the character length must be greater than or equal to 1.'
+      end
+
+      @mailbox_id = mailbox_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mailbox_pool_id Value to be assigned
+    def mailbox_pool_id=(mailbox_pool_id)
+      if mailbox_pool_id.nil?
+        fail ArgumentError, 'mailbox_pool_id cannot be nil'
+      end
+
+      if mailbox_pool_id.to_s.length > 200
+        fail ArgumentError, 'invalid value for "mailbox_pool_id", the character length must be smaller than or equal to 200.'
+      end
+
+      if mailbox_pool_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "mailbox_pool_id", the character length must be greater than or equal to 1.'
+      end
+
+      @mailbox_pool_id = mailbox_pool_id
+    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 &&
+          audience_list_id == o.audience_list_id &&
+          cadence_id == o.cadence_id &&
+          cadence_version == o.cadence_version &&
+          campaign_id == o.campaign_id &&
+          campaign_name == o.campaign_name &&
+          contact_ids == o.contact_ids &&
+          enrollment_mode == o.enrollment_mode &&
+          idempotency_key == o.idempotency_key &&
+          mailbox_id == o.mailbox_id &&
+          mailbox_pool_id == o.mailbox_pool_id &&
+          scheduled_at == o.scheduled_at
+    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
+      [audience_list_id, cadence_id, cadence_version, campaign_id, campaign_name, contact_ids, enrollment_mode, idempotency_key, mailbox_id, mailbox_pool_id, scheduled_at].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
+
+    # 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
+
+  end
+
+end

data/lib/reacon-sdk/models/mail_post_cadence_runs_response200.rb

@@ -0,0 +1,166 @@
+=begin
+#Reacon API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Reacon
+  class MailPostCadenceRunsResponse200 < ApiModelBase
+    attr_accessor :runs
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'runs' => :'runs'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'runs' => :'Array<MailCadenceRunRecord>'
+      }
+    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 `Reacon::MailPostCadenceRunsResponse200` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Reacon::MailPostCadenceRunsResponse200`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'runs')
+        if (value = attributes[:'runs']).is_a?(Array)
+          self.runs = value
+        end
+      else
+        self.runs = nil
+      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 @runs.nil?
+        invalid_properties.push('invalid value for "runs", runs 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 @runs.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] runs Value to be assigned
+    def runs=(runs)
+      if runs.nil?
+        fail ArgumentError, 'runs cannot be nil'
+      end
+
+      @runs = runs
+    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 &&
+          runs == o.runs
+    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
+      [runs].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
+
+    # 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
+
+  end
+
+end