apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/phone_number5.rb

@@ -0,0 +1,127 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # PhoneNumber5 Model.
+  class PhoneNumber5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :raw_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :sanitized_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :position
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :source_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['raw_number'] = 'raw_number'
+      @_hash['sanitized_number'] = 'sanitized_number'
+      @_hash['type'] = 'type'
+      @_hash['position'] = 'position'
+      @_hash['status'] = 'status'
+      @_hash['source_name'] = 'source_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        raw_number
+        sanitized_number
+        type
+        position
+        status
+        source_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(raw_number: SKIP, sanitized_number: SKIP, type: SKIP,
+                   position: SKIP, status: SKIP, source_name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @raw_number = raw_number unless raw_number == SKIP
+      @sanitized_number = sanitized_number unless sanitized_number == SKIP
+      @type = type unless type == SKIP
+      @position = position unless position == SKIP
+      @status = status unless status == SKIP
+      @source_name = source_name unless source_name == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      raw_number = hash.key?('raw_number') ? hash['raw_number'] : SKIP
+      sanitized_number =
+        hash.key?('sanitized_number') ? hash['sanitized_number'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      source_name = hash.key?('source_name') ? hash['source_name'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PhoneNumber5.new(raw_number: raw_number,
+                       sanitized_number: sanitized_number,
+                       type: type,
+                       position: position,
+                       status: status,
+                       source_name: source_name,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} raw_number: #{@raw_number}, sanitized_number: #{@sanitized_number}, type:"\
+      " #{@type}, position: #{@position}, status: #{@status}, source_name: #{@source_name},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} raw_number: #{@raw_number.inspect}, sanitized_number:"\
+      " #{@sanitized_number.inspect}, type: #{@type.inspect}, position: #{@position.inspect},"\
+      " status: #{@status.inspect}, source_name: #{@source_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/pivot_group_by.rb

@@ -0,0 +1,85 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # PivotGroupBy Model.
+  class PivotGroupBy < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The dimension name to pivot on. <br><br>Example:
+    # <code>emailer_campaign_id</code>
+    # @return [String]
+    attr_accessor :name
+
+    # Maximum number of pivot column values to return.
+    # @return [Integer]
+    attr_accessor :limit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['limit'] = 'limit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, limit: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @limit = limit unless limit == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PivotGroupBy.new(name: name,
+                       limit: limit,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, limit: #{@limit}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, limit: #{@limit.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/primary_phone.rb

@@ -0,0 +1,96 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # PrimaryPhone Model.
+  class PrimaryPhone < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :source
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :sanitized_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['source'] = 'source'
+      @_hash['sanitized_number'] = 'sanitized_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        source
+        sanitized_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number: SKIP, source: SKIP, sanitized_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @number = number unless number == SKIP
+      @source = source unless source == SKIP
+      @sanitized_number = sanitized_number unless sanitized_number == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      number = hash.key?('number') ? hash['number'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      sanitized_number =
+        hash.key?('sanitized_number') ? hash['sanitized_number'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PrimaryPhone.new(number: number,
+                       source: source,
+                       sanitized_number: sanitized_number,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, source: #{@source}, sanitized_number:"\
+      " #{@sanitized_number}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, source: #{@source.inspect}, sanitized_number:"\
+      " #{@sanitized_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/priority.rb

@@ -0,0 +1,40 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Priority.
+  class Priority
+    PRIORITY = [
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'medium'.freeze,
+
+      # TODO: Write general description for LOW
+      LOW = 'low'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRIORITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'high' then HIGH
+      when 'medium' then MEDIUM
+      when 'low' then LOW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/recipient.rb

@@ -0,0 +1,100 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Recipient Model.
+  class Recipient < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The email address of the recipient. <br><br>Example:
+    # `ava.ruiz@sumware.com`
+    # @return [String]
+    attr_accessor :email
+
+    # The Apollo ID for the contact associated with this recipient.
+    # <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @return [String]
+    attr_accessor :contact_id
+
+    # The type of recipient. <ul> <li> `to` </li> <li> `cc` </li> <li> `bcc`
+    # </li> </ul>
+    # @return [String]
+    attr_accessor :recipient_type_cd
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['recipient_type_cd'] = 'recipient_type_cd'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        contact_id
+        recipient_type_cd
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email: SKIP, contact_id: SKIP, recipient_type_cd: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email = email unless email == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @recipient_type_cd = recipient_type_cd unless recipient_type_cd == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      email = hash.key?('email') ? hash['email'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      recipient_type_cd =
+        hash.key?('recipient_type_cd') ? hash['recipient_type_cd'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Recipient.new(email: email,
+                    contact_id: contact_id,
+                    recipient_type_cd: recipient_type_cd,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, contact_id: #{@contact_id}, recipient_type_cd:"\
+      " #{@recipient_type_cd}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, contact_id: #{@contact_id.inspect},"\
+      " recipient_type_cd: #{@recipient_type_cd.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/recipient1.rb

@@ -0,0 +1,116 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Recipient1 Model.
+  class Recipient1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :raw_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :recipient_type_cd
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :contact_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['raw_name'] = 'raw_name'
+      @_hash['recipient_type_cd'] = 'recipient_type_cd'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['user_id'] = 'user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        raw_name
+        recipient_type_cd
+        contact_id
+        user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email: SKIP, raw_name: SKIP, recipient_type_cd: SKIP,
+                   contact_id: SKIP, user_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email = email unless email == SKIP
+      @raw_name = raw_name unless raw_name == SKIP
+      @recipient_type_cd = recipient_type_cd unless recipient_type_cd == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      email = hash.key?('email') ? hash['email'] : SKIP
+      raw_name = hash.key?('raw_name') ? hash['raw_name'] : SKIP
+      recipient_type_cd =
+        hash.key?('recipient_type_cd') ? hash['recipient_type_cd'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Recipient1.new(email: email,
+                     raw_name: raw_name,
+                     recipient_type_cd: recipient_type_cd,
+                     contact_id: contact_id,
+                     user_id: user_id,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, raw_name: #{@raw_name}, recipient_type_cd:"\
+      " #{@recipient_type_cd}, contact_id: #{@contact_id}, user_id: #{@user_id},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, raw_name: #{@raw_name.inspect},"\
+      " recipient_type_cd: #{@recipient_type_cd.inspect}, contact_id: #{@contact_id.inspect},"\
+      " user_id: #{@user_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end