apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/sharing_access.rb

@@ -0,0 +1,148 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # SharingAccess Model.
+  class SharingAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :shared_by
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :user_or_team_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :user_or_team_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :access_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['shared_by'] = 'shared_by'
+      @_hash['user_or_team_id'] = 'user_or_team_id'
+      @_hash['user_or_team_type'] = 'user_or_team_type'
+      @_hash['access_type'] = 'access_type'
+      @_hash['object_id'] = 'object_id'
+      @_hash['object_type'] = 'object_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        shared_by
+        user_or_team_id
+        user_or_team_type
+        access_type
+        object_id
+        object_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, shared_by: SKIP, user_or_team_id: SKIP,
+                   user_or_team_type: SKIP, access_type: SKIP, object_id: SKIP,
+                   object_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @shared_by = shared_by unless shared_by == SKIP
+      @user_or_team_id = user_or_team_id unless user_or_team_id == SKIP
+      @user_or_team_type = user_or_team_type unless user_or_team_type == SKIP
+      @access_type = access_type unless access_type == SKIP
+      @object_id = object_id unless object_id == SKIP
+      @object_type = object_type unless object_type == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      shared_by = hash.key?('shared_by') ? hash['shared_by'] : SKIP
+      user_or_team_id =
+        hash.key?('user_or_team_id') ? hash['user_or_team_id'] : SKIP
+      user_or_team_type =
+        hash.key?('user_or_team_type') ? hash['user_or_team_type'] : SKIP
+      access_type = hash.key?('access_type') ? hash['access_type'] : SKIP
+      object_id = hash.key?('object_id') ? hash['object_id'] : SKIP
+      object_type = hash.key?('object_type') ? hash['object_type'] : 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.
+      SharingAccess.new(id: id,
+                        shared_by: shared_by,
+                        user_or_team_id: user_or_team_id,
+                        user_or_team_type: user_or_team_type,
+                        access_type: access_type,
+                        object_id: object_id,
+                        object_type: object_type,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SharingAccess | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, shared_by: #{@shared_by}, user_or_team_id: #{@user_or_team_id},"\
+      " user_or_team_type: #{@user_or_team_type}, access_type: #{@access_type}, object_id:"\
+      " #{@object_id}, object_type: #{@object_type}, 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} id: #{@id.inspect}, shared_by: #{@shared_by.inspect}, user_or_team_id:"\
+      " #{@user_or_team_id.inspect}, user_or_team_type: #{@user_or_team_type.inspect},"\
+      " access_type: #{@access_type.inspect}, object_id: #{@object_id.inspect}, object_type:"\
+      " #{@object_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/sharing_permission.rb

@@ -0,0 +1,154 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # SharingPermission Model.
+  class SharingPermission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :visibility
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :access_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_owner
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :owner_id
+
+    # TODO: Write general description for this method
+    # @return [Array[SharingAccess]]
+    attr_accessor :sharing_accesses
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['visibility'] = 'visibility'
+      @_hash['access_type'] = 'access_type'
+      @_hash['object_type'] = 'object_type'
+      @_hash['object_id'] = 'object_id'
+      @_hash['is_owner'] = 'is_owner'
+      @_hash['owner_id'] = 'owner_id'
+      @_hash['sharing_accesses'] = 'sharing_accesses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        visibility
+        access_type
+        object_type
+        object_id
+        is_owner
+        owner_id
+        sharing_accesses
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(visibility: SKIP, access_type: SKIP, object_type: SKIP,
+                   object_id: SKIP, is_owner: SKIP, owner_id: SKIP,
+                   sharing_accesses: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @visibility = visibility unless visibility == SKIP
+      @access_type = access_type unless access_type == SKIP
+      @object_type = object_type unless object_type == SKIP
+      @object_id = object_id unless object_id == SKIP
+      @is_owner = is_owner unless is_owner == SKIP
+      @owner_id = owner_id unless owner_id == SKIP
+      @sharing_accesses = sharing_accesses unless sharing_accesses == 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.
+      visibility = hash.key?('visibility') ? hash['visibility'] : SKIP
+      access_type = hash.key?('access_type') ? hash['access_type'] : SKIP
+      object_type = hash.key?('object_type') ? hash['object_type'] : SKIP
+      object_id = hash.key?('object_id') ? hash['object_id'] : SKIP
+      is_owner = hash.key?('is_owner') ? hash['is_owner'] : SKIP
+      owner_id = hash.key?('owner_id') ? hash['owner_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      sharing_accesses = nil
+      unless hash['sharing_accesses'].nil?
+        sharing_accesses = []
+        hash['sharing_accesses'].each do |structure|
+          sharing_accesses << (SharingAccess.from_hash(structure) if structure)
+        end
+      end
+
+      sharing_accesses = SKIP unless hash.key?('sharing_accesses')
+
+      # 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.
+      SharingPermission.new(visibility: visibility,
+                            access_type: access_type,
+                            object_type: object_type,
+                            object_id: object_id,
+                            is_owner: is_owner,
+                            owner_id: owner_id,
+                            sharing_accesses: sharing_accesses,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SharingPermission | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} visibility: #{@visibility}, access_type: #{@access_type}, object_type:"\
+      " #{@object_type}, object_id: #{@object_id}, is_owner: #{@is_owner}, owner_id: #{@owner_id},"\
+      " sharing_accesses: #{@sharing_accesses}, 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} visibility: #{@visibility.inspect}, access_type: #{@access_type.inspect},"\
+      " object_type: #{@object_type.inspect}, object_id: #{@object_id.inspect}, is_owner:"\
+      " #{@is_owner.inspect}, owner_id: #{@owner_id.inspect}, sharing_accesses:"\
+      " #{@sharing_accesses.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/skipped_contact_ids.rb

@@ -0,0 +1,77 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Hash mapping contact IDs to reasons why they were skipped during the
+  # addition process. Each key is a contact ID and each value is a reason code.
+  class SkippedContactIds < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Reason why this contact was skipped
+    # @return [String]
+    attr_accessor :contact_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_id'] = 'contact_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact_id = contact_id unless contact_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.
+      contact_id = hash.key?('contact_id') ? hash['contact_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.
+      SkippedContactIds.new(contact_id: contact_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} contact_id: #{@contact_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} contact_id: #{@contact_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/smart_datetime_range.rb

@@ -0,0 +1,86 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Required when <code>date_ranges[].modality</code> is
+  # <code>custom_range</code>. Specifies the exact date window as ISO 8601 date
+  # strings.
+  class SmartDatetimeRange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start date (inclusive). Format: <code>YYYY-MM-DD</code>. <br><br>Example:
+    # <code>2024-01-01</code>
+    # @return [String]
+    attr_accessor :min
+
+    # End date (inclusive). Format: <code>YYYY-MM-DD</code>. <br><br>Example:
+    # <code>2024-03-31</code>
+    # @return [String]
+    attr_accessor :max
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['min'] = 'min'
+      @_hash['max'] = 'max'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(min:, max:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @min = min
+      @max = max
+      @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.
+      min = hash.key?('min') ? hash['min'] : nil
+      max = hash.key?('max') ? hash['max'] : nil
+
+      # 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.
+      SmartDatetimeRange.new(min: min,
+                             max: max,
+                             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} min: #{@min}, max: #{@max}, 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} min: #{@min.inspect}, max: #{@max.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/sort.rb

@@ -0,0 +1,85 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Sort Model.
+  class Sort < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Sort ascending (<code>true</code>) or descending (<code>false</code>).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :asc
+
+    # Sort by a metric column. Provide the same structure as a metric entry in
+    # the <code>metrics</code> array.
+    # @return [Metric1]
+    attr_accessor :metric
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asc'] = 'asc'
+      @_hash['metric'] = 'metric'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metric
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asc:, metric: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asc = asc
+      @metric = metric unless metric == 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.
+      asc = hash.key?('asc') ? hash['asc'] : nil
+      metric = Metric1.from_hash(hash['metric']) if hash['metric']
+
+      # 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.
+      Sort.new(asc: asc,
+               metric: metric,
+               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} asc: #{@asc}, metric: #{@metric}, 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} asc: #{@asc.inspect}, metric: #{@metric.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/sort_by_field.rb

@@ -0,0 +1,43 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Sort the matching accounts by 1 of the following options: -
+  # `account_last_activity_date`: The most recent activity date recorded first.
+  # - `account_created_at`: The most recently created first. -
+  # `account_updated_at`: The most recently updated first.
+  class SortByField
+    SORT_BY_FIELD = [
+      # TODO: Write general description for ACCOUNT_LAST_ACTIVITY_DATE
+      ACCOUNT_LAST_ACTIVITY_DATE = 'account_last_activity_date'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CREATED_AT
+      ACCOUNT_CREATED_AT = 'account_created_at'.freeze,
+
+      # TODO: Write general description for ACCOUNT_UPDATED_AT
+      ACCOUNT_UPDATED_AT = 'account_updated_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SORT_BY_FIELD.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCOUNT_LAST_ACTIVITY_DATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account_last_activity_date' then ACCOUNT_LAST_ACTIVITY_DATE
+      when 'account_created_at' then ACCOUNT_CREATED_AT
+      when 'account_updated_at' then ACCOUNT_UPDATED_AT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/sort_by_field1.rb

@@ -0,0 +1,36 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # sort_by_field1.
+  class SortByField1
+    SORT_BY_FIELD1 = [
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SORT_BY_FIELD1.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREATED_AT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created_at' then CREATED_AT
+      when 'updated_at' then UPDATED_AT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/sort_direction.rb

@@ -0,0 +1,36 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # sort_direction.
+  class SortDirection
+    SORT_DIRECTION = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SORT_DIRECTION.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asc' then ASC
+      when 'desc' then DESC
+      else
+        default_value
+      end
+    end
+  end
+end