apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/field.rb

@@ -0,0 +1,181 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApolloRestApi
+  # Field Model.
+  class Field < 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 :label
+
+    # Entity type this field belongs to (contact, account, opportunity, lead,
+    # custom_object)
+    # @return [String]
+    attr_accessor :modality
+
+    # High‑level context for the field (contact, account, opportunity, lead,
+    # custom_object)
+    # @return [String]
+    attr_accessor :context
+
+    # Field data type (text, number, date, datetime, boolean, picklist,
+    # multi_select, url, email, phone, currency)
+    # @return [String]
+    attr_accessor :type
+
+    # Field source (system, custom, crm_synced)
+    # @return [String]
+    attr_accessor :source
+
+    # Field source (system, custom, crm_synced)
+    # @return [String]
+    attr_accessor :project_workspace_id
+
+    # Extended configuration for the field
+    # @return [Object]
+    attr_accessor :meta
+
+    # Extended configuration for the field
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Extended configuration for the field
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['label'] = 'label'
+      @_hash['modality'] = 'modality'
+      @_hash['context'] = 'context'
+      @_hash['type'] = 'type'
+      @_hash['source'] = 'source'
+      @_hash['project_workspace_id'] = 'project_workspace_id'
+      @_hash['meta'] = 'meta'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        context
+        source
+        project_workspace_id
+        meta
+        created_at
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, label:, modality:, type:, context: SKIP, source: SKIP,
+                   project_workspace_id: SKIP, meta: SKIP, created_at: SKIP,
+                   updated_at: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @label = label
+      @modality = modality
+      @context = context unless context == SKIP
+      @type = type
+      @source = source unless source == SKIP
+      @project_workspace_id = project_workspace_id unless project_workspace_id == SKIP
+      @meta = meta unless meta == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == 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'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+      modality = hash.key?('modality') ? hash['modality'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      context = hash.key?('context') ? hash['context'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      project_workspace_id =
+        hash.key?('project_workspace_id') ? hash['project_workspace_id'] : SKIP
+      meta = hash.key?('meta') ? hash['meta'] : SKIP
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+
+      # 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.
+      Field.new(id: id,
+                label: label,
+                modality: modality,
+                type: type,
+                context: context,
+                source: source,
+                project_workspace_id: project_workspace_id,
+                meta: meta,
+                created_at: created_at,
+                updated_at: updated_at,
+                additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, label: #{@label}, modality: #{@modality}, context: #{@context},"\
+      " type: #{@type}, source: #{@source}, project_workspace_id: #{@project_workspace_id}, meta:"\
+      " #{@meta}, created_at: #{@created_at}, updated_at: #{@updated_at}, 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}, label: #{@label.inspect}, modality:"\
+      " #{@modality.inspect}, context: #{@context.inspect}, type: #{@type.inspect}, source:"\
+      " #{@source.inspect}, project_workspace_id: #{@project_workspace_id.inspect}, meta:"\
+      " #{@meta.inspect}, created_at: #{@created_at.inspect}, updated_at: #{@updated_at.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/fields_request.rb

@@ -0,0 +1,105 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # FieldsRequest Model.
+  class FieldsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the custom field you want to create. Example: `Test Name`
+    # @return [String]
+    attr_accessor :label
+
+    # The modality of the custom field you want to create.  Example: `contact`
+    # @return [Modality3]
+    attr_accessor :modality
+
+    # What kind of custom field you want to create. Example: `textarea`
+    # @return [Type2]
+    attr_accessor :type
+
+    # What kind of custom field you want to create. Example: `textarea`
+    # @return [Meta]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['label'] = 'label'
+      @_hash['modality'] = 'modality'
+      @_hash['type'] = 'type'
+      @_hash['meta'] = 'meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label
+        modality
+        type
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(label: SKIP, modality: SKIP, type: SKIP, meta: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @label = label unless label == SKIP
+      @modality = modality unless modality == SKIP
+      @type = type unless type == SKIP
+      @meta = meta unless meta == 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.
+      label = hash.key?('label') ? hash['label'] : SKIP
+      modality = hash.key?('modality') ? hash['modality'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      meta = Meta.from_hash(hash['meta']) if hash['meta']
+
+      # 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.
+      FieldsRequest.new(label: label,
+                        modality: modality,
+                        type: type,
+                        meta: meta,
+                        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} label: #{@label}, modality: #{@modality}, type: #{@type}, meta: #{@meta},"\
+      " 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} label: #{@label.inspect}, modality: #{@modality.inspect}, type:"\
+      " #{@type.inspect}, meta: #{@meta.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/fields_response.rb

@@ -0,0 +1,84 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # FieldsResponse Model.
+  class FieldsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Field]]
+    attr_accessor :fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fields'] = 'fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fields: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fields = fields unless fields == 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.
+      # Parameter is an array, so we need to iterate through it
+      fields = nil
+      unless hash['fields'].nil?
+        fields = []
+        hash['fields'].each do |structure|
+          fields << (Field.from_hash(structure) if structure)
+        end
+      end
+
+      fields = SKIP unless hash.key?('fields')
+
+      # 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.
+      FieldsResponse.new(fields: fields,
+                         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} fields: #{@fields}, 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} fields: #{@fields.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/fields_response1.rb

@@ -0,0 +1,85 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # FieldsResponse1 Model.
+  class FieldsResponse1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TypedCustomFields6]]
+    attr_accessor :typed_custom_fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['typed_custom_fields'] = 'typed_custom_fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        typed_custom_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(typed_custom_fields: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @typed_custom_fields = typed_custom_fields unless typed_custom_fields == 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.
+      # Parameter is an array, so we need to iterate through it
+      typed_custom_fields = nil
+      unless hash['typed_custom_fields'].nil?
+        typed_custom_fields = []
+        hash['typed_custom_fields'].each do |structure|
+          typed_custom_fields << (TypedCustomFields6.from_hash(structure) if structure)
+        end
+      end
+
+      typed_custom_fields = SKIP unless hash.key?('typed_custom_fields')
+
+      # 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.
+      FieldsResponse1.new(typed_custom_fields: typed_custom_fields,
+                          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} typed_custom_fields: #{@typed_custom_fields}, 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} typed_custom_fields: #{@typed_custom_fields.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/filters.rb

@@ -0,0 +1,165 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Key/value filter map to narrow the result set. Pass an empty object
+  # <code>{}</code> for no filters. Common filter keys are documented in the
+  # <code>properties</code> below; additional dimension-based filters may also
+  # be passed using the same key names as <code>group_by[].name</code> values.
+  # Refer to the <a href="https://docs.apollo.io/reference/sync-report-metrics"
+  # target="_blank">Metrics and Dimensions Reference</a> for a complete list.
+  class Filters < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Filter to specific team member IDs. Use <code>"current"</code> for the
+    # authenticated user. <br><br>Example: <code>["current"]</code>
+    # @return [Array[String]]
+    attr_accessor :smart_user_id
+
+    # Filter to specific sub-team IDs.
+    # @return [Array[String]]
+    attr_accessor :smart_subteam_id
+
+    # Filter to specific sequence IDs.
+    # @return [Array[String]]
+    attr_accessor :emailer_campaign_ids
+
+    # Filter to specific contact stage IDs.
+    # @return [Array[String]]
+    attr_accessor :contact_stage_ids
+
+    # Filter to specific account stage IDs.
+    # @return [Array[String]]
+    attr_accessor :account_stage_ids
+
+    # Filter to specific opportunity stage IDs.
+    # @return [Array[String]]
+    attr_accessor :opportunity_stage_ids
+
+    # Filter to specific sender mailbox IDs.
+    # @return [Array[String]]
+    attr_accessor :email_account_ids
+
+    # Required when <code>date_ranges[].modality</code> is
+    # <code>custom_range</code>. Specifies the exact date window as ISO 8601
+    # date strings.
+    # @return [SmartDatetimeRange]
+    attr_accessor :smart_datetime_range
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['smart_user_id'] = 'smart_user_id'
+      @_hash['smart_subteam_id'] = 'smart_subteam_id'
+      @_hash['emailer_campaign_ids'] = 'emailer_campaign_ids'
+      @_hash['contact_stage_ids'] = 'contact_stage_ids'
+      @_hash['account_stage_ids'] = 'account_stage_ids'
+      @_hash['opportunity_stage_ids'] = 'opportunity_stage_ids'
+      @_hash['email_account_ids'] = 'email_account_ids'
+      @_hash['smart_datetime_range'] = 'smart_datetime_range'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        smart_user_id
+        smart_subteam_id
+        emailer_campaign_ids
+        contact_stage_ids
+        account_stage_ids
+        opportunity_stage_ids
+        email_account_ids
+        smart_datetime_range
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(smart_user_id: SKIP, smart_subteam_id: SKIP,
+                   emailer_campaign_ids: SKIP, contact_stage_ids: SKIP,
+                   account_stage_ids: SKIP, opportunity_stage_ids: SKIP,
+                   email_account_ids: SKIP, smart_datetime_range: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @smart_user_id = smart_user_id unless smart_user_id == SKIP
+      @smart_subteam_id = smart_subteam_id unless smart_subteam_id == SKIP
+      @emailer_campaign_ids = emailer_campaign_ids unless emailer_campaign_ids == SKIP
+      @contact_stage_ids = contact_stage_ids unless contact_stage_ids == SKIP
+      @account_stage_ids = account_stage_ids unless account_stage_ids == SKIP
+      @opportunity_stage_ids = opportunity_stage_ids unless opportunity_stage_ids == SKIP
+      @email_account_ids = email_account_ids unless email_account_ids == SKIP
+      @smart_datetime_range = smart_datetime_range unless smart_datetime_range == 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.
+      smart_user_id = hash.key?('smart_user_id') ? hash['smart_user_id'] : SKIP
+      smart_subteam_id =
+        hash.key?('smart_subteam_id') ? hash['smart_subteam_id'] : SKIP
+      emailer_campaign_ids =
+        hash.key?('emailer_campaign_ids') ? hash['emailer_campaign_ids'] : SKIP
+      contact_stage_ids =
+        hash.key?('contact_stage_ids') ? hash['contact_stage_ids'] : SKIP
+      account_stage_ids =
+        hash.key?('account_stage_ids') ? hash['account_stage_ids'] : SKIP
+      opportunity_stage_ids =
+        hash.key?('opportunity_stage_ids') ? hash['opportunity_stage_ids'] : SKIP
+      email_account_ids =
+        hash.key?('email_account_ids') ? hash['email_account_ids'] : SKIP
+      smart_datetime_range = SmartDatetimeRange.from_hash(hash['smart_datetime_range']) if
+        hash['smart_datetime_range']
+
+      # 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.
+      Filters.new(smart_user_id: smart_user_id,
+                  smart_subteam_id: smart_subteam_id,
+                  emailer_campaign_ids: emailer_campaign_ids,
+                  contact_stage_ids: contact_stage_ids,
+                  account_stage_ids: account_stage_ids,
+                  opportunity_stage_ids: opportunity_stage_ids,
+                  email_account_ids: email_account_ids,
+                  smart_datetime_range: smart_datetime_range,
+                  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} smart_user_id: #{@smart_user_id}, smart_subteam_id: #{@smart_subteam_id},"\
+      " emailer_campaign_ids: #{@emailer_campaign_ids}, contact_stage_ids: #{@contact_stage_ids},"\
+      " account_stage_ids: #{@account_stage_ids}, opportunity_stage_ids:"\
+      " #{@opportunity_stage_ids}, email_account_ids: #{@email_account_ids}, smart_datetime_range:"\
+      " #{@smart_datetime_range}, 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} smart_user_id: #{@smart_user_id.inspect}, smart_subteam_id:"\
+      " #{@smart_subteam_id.inspect}, emailer_campaign_ids: #{@emailer_campaign_ids.inspect},"\
+      " contact_stage_ids: #{@contact_stage_ids.inspect}, account_stage_ids:"\
+      " #{@account_stage_ids.inspect}, opportunity_stage_ids: #{@opportunity_stage_ids.inspect},"\
+      " email_account_ids: #{@email_account_ids.inspect}, smart_datetime_range:"\
+      " #{@smart_datetime_range.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/finished.rb

@@ -0,0 +1,26 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Finished.
+  class Finished
+    FINISHED = [
+      # TODO: Write general description for LOADING
+      LOADING = 'loading'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FINISHED.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOADING)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end