apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/notes_response.rb

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

data/lib/apollo_rest_api/models/opportunities_request.rb

@@ -0,0 +1,175 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # OpportunitiesRequest Model.
+  class OpportunitiesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name the deal you are creating. This should be a human-readable name.
+    # <br><br>Example: `Massive Q3 Deal`
+    # @return [String]
+    attr_accessor :name
+
+    # The ID for the deal owner within your team's Apollo account. <br><br>Use
+    # the <a href="https://docs.apollo.io/reference/get-a-list-of-users"
+    # target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
+    # of the users within your Apollo account. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @return [String]
+    attr_accessor :owner_id
+
+    # The ID for the account within your Apollo instance. This is the company
+    # that you are targeting as part of the deal being created. <br><br>Each
+    # company in the Apollo database is assigned a unique ID. To find IDs, call
+    # the <a href="https://docs.apollo.io/reference/organization-search"
+    # target="_blank">Organization Search endpoint</a> and identify the values
+    # for `organization_id`. <br><br>Example: `5e66b6381e05b4008c8331b8`
+    # @return [String]
+    attr_accessor :account_id
+
+    # The monetary value of the deal being created. <br><br>Do not enter commas
+    # or currency symbols for the value. The currency is automatically populated
+    # by the settings within your Apollo account. Commas are not accepted and
+    # result in the deal amount being left blank. <br><br>Example: `55123478`
+    # (results in a deal value of `$55,123,478` if the default currency is USD)
+    # @return [String]
+    attr_accessor :amount
+
+    # The ID for the deal stage within your team's Apollo account. <br><br>Each
+    # deal stage is assigned a unique ID. To find deal stage IDs, call the <a
+    # href="https://docs.apollo.io/reference/list-deal-stages"
+    # target="_blank">List Deal Stages endpoint</a> and identify the value for
+    # `id` for each stage. <br><br>Example: `6095a710bd01d100a506d4bd`
+    # @return [String]
+    attr_accessor :opportunity_stage_id
+
+    # The estimated close date for the deal. This can be a future or past date.
+    # <br><br>The date should be formatted as `YYYY-MM-DD`. <br><br>Example:
+    # `2025-10-30`
+    # @return [Date]
+    attr_accessor :closed_date
+
+    # Add information to <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4415062486669-Create-a
+    # -Deal" target="_blank">custom fields</a> in Apollo. <br><br><b>Your custom
+    # fields are unique to your team's Apollo account. This means that the
+    # examples in this documentation may not work for your testing purposes.</b>
+    # <br><br>To utilize this parameter successfully, call the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
+    # t a List of All Custom Fields</a> endpoint and identify the `id` value for
+    # the custom field, as well as the appropriate data type. For example, if a
+    # custom field accepts picklist entries, you need to pass the accompanying
+    # `id` value for the picklist entry that you want to use as the input value.
+    # <br><br><b>Example</b>: When the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
+    # t a List of All Custom Fields</a> endpoint returns an `id` of field: 
+    #  * `"60c39ed82bd02f01154c470a"` (datetime) 
+    #  
+    #  then the value passed should be: 
+    #  `{"60c39ed82bd02f01154c470a": "2025-08-07"}`
+    # @return [Hash[String, String]]
+    attr_accessor :typed_custom_fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['owner_id'] = 'owner_id'
+      @_hash['account_id'] = 'account_id'
+      @_hash['amount'] = 'amount'
+      @_hash['opportunity_stage_id'] = 'opportunity_stage_id'
+      @_hash['closed_date'] = 'closed_date'
+      @_hash['typed_custom_fields'] = 'typed_custom_fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        owner_id
+        account_id
+        amount
+        opportunity_stage_id
+        closed_date
+        typed_custom_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, owner_id: SKIP, account_id: SKIP, amount: SKIP,
+                   opportunity_stage_id: SKIP, closed_date: SKIP,
+                   typed_custom_fields: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @owner_id = owner_id unless owner_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @amount = amount unless amount == SKIP
+      @opportunity_stage_id = opportunity_stage_id unless opportunity_stage_id == SKIP
+      @closed_date = closed_date unless closed_date == SKIP
+      @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.
+      name = hash.key?('name') ? hash['name'] : nil
+      owner_id = hash.key?('owner_id') ? hash['owner_id'] : SKIP
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      opportunity_stage_id =
+        hash.key?('opportunity_stage_id') ? hash['opportunity_stage_id'] : SKIP
+      closed_date = hash.key?('closed_date') ? hash['closed_date'] : SKIP
+      typed_custom_fields =
+        hash.key?('typed_custom_fields') ? hash['typed_custom_fields'] : 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.
+      OpportunitiesRequest.new(name: name,
+                               owner_id: owner_id,
+                               account_id: account_id,
+                               amount: amount,
+                               opportunity_stage_id: opportunity_stage_id,
+                               closed_date: closed_date,
+                               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} name: #{@name}, owner_id: #{@owner_id}, account_id: #{@account_id}, amount:"\
+      " #{@amount}, opportunity_stage_id: #{@opportunity_stage_id}, closed_date: #{@closed_date},"\
+      " 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} name: #{@name.inspect}, owner_id: #{@owner_id.inspect}, account_id:"\
+      " #{@account_id.inspect}, amount: #{@amount.inspect}, opportunity_stage_id:"\
+      " #{@opportunity_stage_id.inspect}, closed_date: #{@closed_date.inspect},"\
+      " typed_custom_fields: #{@typed_custom_fields.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/opportunities_request1.rb

@@ -0,0 +1,164 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # OpportunitiesRequest1 Model.
+  class OpportunitiesRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for the deal owner within your team's Apollo account. Enter a
+    # different ID to update the owner of the deal. <br><br>Use the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-users"
+    # target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
+    # of the users within your Apollo account. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @return [String]
+    attr_accessor :owner_id
+
+    # Update the name of the deal. This should be a human-readable name.
+    # <br><br>Example: `Massive Q3 Deal`
+    # @return [String]
+    attr_accessor :name
+
+    # The monetary value of the deal. Enter a different value to update the deal
+    # amount. <br><br>Do not enter commas or currency symbols for the value. The
+    # currency is automatically populated by the settings within your Apollo
+    # account. Commas are not accepted and result in the deal amount being left
+    # blank. <br><br>Example: `55123478` (results in a deal value of
+    # `$55,123,478` if the default currency is USD)
+    # @return [String]
+    attr_accessor :amount
+
+    # The ID for the deal stage within your team's Apollo account. Enter a
+    # different ID to update the deal stage. <br><br>Each deal stage is assigned
+    # a unique ID. To find deal stage IDs, call the <a
+    # href="https://docs.apollo.io/reference/list-deal-stages"
+    # target="_blank">List Deal Stages endpoint</a> and identify the value for
+    # `id` for each stage. <br><br>Example: `6095a710bd01d100a506d4bd`
+    # @return [String]
+    attr_accessor :opportunity_stage_id
+
+    # Update the estimated close date for the deal. This can be a future or past
+    # date. <br><br>The date should be formatted as `YYYY-MM-DD`.
+    # <br><br>Example: `2025-10-30`
+    # @return [Date]
+    attr_accessor :closed_date
+
+    # Add information to <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4415062486669-Create-a
+    # -Deal" target="_blank">custom fields</a> in Apollo. <br><br><b>Your custom
+    # fields are unique to your team's Apollo account. This means that the
+    # examples in this documentation may not work for your testing purposes.</b>
+    # <br><br>To utilize this parameter successfully, call the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
+    # t a List of All Custom Fields</a> endpoint and identify the `id` value for
+    # the custom field, as well as the appropriate data type. For example, if a
+    # custom field accepts picklist entries, you need to pass the accompanying
+    # `id` value for the picklist entry that you want to use as the input value.
+    # <br><br><b>Example</b>: When the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-all-custom-fields">Ge
+    # t a List of All Custom Fields</a> endpoint returns an `id` of field: 
+    #  * `"60c39ed82bd02f01154c470a"` (datetime) 
+    #  
+    #  then the value passed should be: 
+    #  `{"60c39ed82bd02f01154c470a": "2025-08-07"}`
+    # @return [Hash[String, String]]
+    attr_accessor :typed_custom_fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['owner_id'] = 'owner_id'
+      @_hash['name'] = 'name'
+      @_hash['amount'] = 'amount'
+      @_hash['opportunity_stage_id'] = 'opportunity_stage_id'
+      @_hash['closed_date'] = 'closed_date'
+      @_hash['typed_custom_fields'] = 'typed_custom_fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        owner_id
+        name
+        amount
+        opportunity_stage_id
+        closed_date
+        typed_custom_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(owner_id: SKIP, name: SKIP, amount: SKIP,
+                   opportunity_stage_id: SKIP, closed_date: SKIP,
+                   typed_custom_fields: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @owner_id = owner_id unless owner_id == SKIP
+      @name = name unless name == SKIP
+      @amount = amount unless amount == SKIP
+      @opportunity_stage_id = opportunity_stage_id unless opportunity_stage_id == SKIP
+      @closed_date = closed_date unless closed_date == SKIP
+      @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.
+      owner_id = hash.key?('owner_id') ? hash['owner_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      opportunity_stage_id =
+        hash.key?('opportunity_stage_id') ? hash['opportunity_stage_id'] : SKIP
+      closed_date = hash.key?('closed_date') ? hash['closed_date'] : SKIP
+      typed_custom_fields =
+        hash.key?('typed_custom_fields') ? hash['typed_custom_fields'] : 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.
+      OpportunitiesRequest1.new(owner_id: owner_id,
+                                name: name,
+                                amount: amount,
+                                opportunity_stage_id: opportunity_stage_id,
+                                closed_date: closed_date,
+                                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} owner_id: #{@owner_id}, name: #{@name}, amount: #{@amount},"\
+      " opportunity_stage_id: #{@opportunity_stage_id}, closed_date: #{@closed_date},"\
+      " 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} owner_id: #{@owner_id.inspect}, name: #{@name.inspect}, amount:"\
+      " #{@amount.inspect}, opportunity_stage_id: #{@opportunity_stage_id.inspect}, closed_date:"\
+      " #{@closed_date.inspect}, typed_custom_fields: #{@typed_custom_fields.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/opportunities_response.rb

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

data/lib/apollo_rest_api/models/opportunities_response1.rb

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

data/lib/apollo_rest_api/models/opportunities_response2.rb

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