orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/pagination_metadata.rb

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

data/lib/api_reference/models/pay_invoice_params.rb

@@ -0,0 +1,62 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PayInvoiceParams Model.
+  class PayInvoiceParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of a shared payment token granted by an agent to use for this
+    # payment.
+    # @return [String]
+    attr_accessor :shared_payment_token_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shared_payment_token_id'] = 'shared_payment_token_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shared_payment_token_id:)
+      @shared_payment_token_id = shared_payment_token_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      shared_payment_token_id =
+        hash.key?('shared_payment_token_id') ? hash['shared_payment_token_id'] : nil
+
+      # Create object from extracted values.
+      PayInvoiceParams.new(shared_payment_token_id: shared_payment_token_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} shared_payment_token_id: #{@shared_payment_token_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} shared_payment_token_id: #{@shared_payment_token_id.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/payment_attempt.rb

@@ -0,0 +1,184 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # PaymentAttempt Model.
+  class PaymentAttempt < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the payment attempt.
+    # @return [String]
+    attr_accessor :id
+
+    # The payment provider that attempted to collect the payment.
+    # @return [PaymentProvider]
+    attr_accessor :payment_provider
+
+    # The ID of the payment attempt in the payment provider.
+    # @return [String]
+    attr_accessor :payment_provider_id
+
+    # The amount of the payment attempt.
+    # @return [String]
+    attr_accessor :amount
+
+    # Whether the payment attempt succeeded.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :succeeded
+
+    # The time at which the payment attempt was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # URL to the downloadable PDF version of the receipt. This field will be
+    # `null` for payment attempts that did not succeed.
+    # @return [String]
+    attr_accessor :receipt_pdf
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['payment_provider'] = 'payment_provider'
+      @_hash['payment_provider_id'] = 'payment_provider_id'
+      @_hash['amount'] = 'amount'
+      @_hash['succeeded'] = 'succeeded'
+      @_hash['created_at'] = 'created_at'
+      @_hash['receipt_pdf'] = 'receipt_pdf'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payment_provider
+        payment_provider_id
+        receipt_pdf
+      ]
+    end
+
+    def initialize(id:, payment_provider:, payment_provider_id:, amount:,
+                   succeeded:, created_at:, receipt_pdf:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @payment_provider = payment_provider
+      @payment_provider_id = payment_provider_id
+      @amount = amount
+      @succeeded = succeeded
+      @created_at = created_at
+      @receipt_pdf = receipt_pdf
+      @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
+      payment_provider =
+        hash.key?('payment_provider') ? hash['payment_provider'] : nil
+      payment_provider_id =
+        hash.key?('payment_provider_id') ? hash['payment_provider_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      succeeded = hash.key?('succeeded') ? hash['succeeded'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      receipt_pdf = hash.key?('receipt_pdf') ? hash['receipt_pdf'] : 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.
+      PaymentAttempt.new(id: id,
+                         payment_provider: payment_provider,
+                         payment_provider_id: payment_provider_id,
+                         amount: amount,
+                         succeeded: succeeded,
+                         created_at: created_at,
+                         receipt_pdf: receipt_pdf,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentAttempt | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.payment_provider,
+                                  ->(val) { PaymentProvider.validate(val) }) and
+            APIHelper.valid_type?(value.payment_provider_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.succeeded,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.receipt_pdf,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['payment_provider'],
+                                ->(val) { PaymentProvider.validate(val) }) and
+          APIHelper.valid_type?(value['payment_provider_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['succeeded'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['receipt_pdf'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, payment_provider: #{@payment_provider}, payment_provider_id:"\
+      " #{@payment_provider_id}, amount: #{@amount}, succeeded: #{@succeeded}, created_at:"\
+      " #{@created_at}, receipt_pdf: #{@receipt_pdf}, 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}, payment_provider: #{@payment_provider.inspect},"\
+      " payment_provider_id: #{@payment_provider_id.inspect}, amount: #{@amount.inspect},"\
+      " succeeded: #{@succeeded.inspect}, created_at: #{@created_at.inspect}, receipt_pdf:"\
+      " #{@receipt_pdf.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/payment_configuration.rb

@@ -0,0 +1,95 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PaymentConfiguration Model.
+  class PaymentConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Provider-specific payment configuration.
+    # @return [Array[PaymentConfigurationItem]]
+    attr_accessor :payment_providers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_providers'] = 'payment_providers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_providers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_providers: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_providers = payment_providers unless payment_providers == 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
+      payment_providers = nil
+      unless hash['payment_providers'].nil?
+        payment_providers = []
+        hash['payment_providers'].each do |structure|
+          payment_providers << (PaymentConfigurationItem.from_hash(structure) if structure)
+        end
+      end
+
+      payment_providers = SKIP unless hash.key?('payment_providers')
+
+      # 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.
+      PaymentConfiguration.new(payment_providers: payment_providers,
+                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentConfiguration | 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} payment_providers: #{@payment_providers}, 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} payment_providers: #{@payment_providers.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/payment_configuration_item.rb

@@ -0,0 +1,126 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PaymentConfigurationItem Model.
+  class PaymentConfigurationItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment provider to configure.
+    # @return [String]
+    attr_reader :provider_type
+
+    # List of Stripe payment method types to exclude for this customer. Excluded
+    # payment methods will not be available for the customer to select during
+    # payment, and will not be used for auto-collection. If a customer's default
+    # payment method becomes excluded, Orb will attempt to use the next
+    # available compatible payment method for auto-collection.
+    # @return [Array[String]]
+    attr_accessor :excluded_payment_method_types
+
+    # The ID of a shared payment token granted by an agent to use as the default
+    # payment instrument for this customer. When set, auto-collection will use
+    # this token instead of the customer's default payment method.
+    # @return [String]
+    attr_accessor :default_shared_payment_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['provider_type'] = 'provider_type'
+      @_hash['excluded_payment_method_types'] =
+        'excluded_payment_method_types'
+      @_hash['default_shared_payment_token'] = 'default_shared_payment_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        excluded_payment_method_types
+        default_shared_payment_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        default_shared_payment_token
+      ]
+    end
+
+    def initialize(excluded_payment_method_types:,
+                   default_shared_payment_token: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @provider_type = 'stripe'
+      unless excluded_payment_method_types == SKIP
+        @excluded_payment_method_types =
+          excluded_payment_method_types
+      end
+      unless default_shared_payment_token == SKIP
+        @default_shared_payment_token =
+          default_shared_payment_token
+      end
+      @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.
+      excluded_payment_method_types = hash['excluded_payment_method_types'] ||= 
+      default_shared_payment_token =
+        hash.key?('default_shared_payment_token') ? hash['default_shared_payment_token'] : 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.
+      PaymentConfigurationItem.new(excluded_payment_method_types: excluded_payment_method_types,
+                                   default_shared_payment_token: default_shared_payment_token,
+                                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentConfigurationItem | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.provider_type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['provider_type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} provider_type: #{@provider_type}, excluded_payment_method_types:"\
+      " #{@excluded_payment_method_types}, default_shared_payment_token:"\
+      " #{@default_shared_payment_token}, 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} provider_type: #{@provider_type.inspect}, excluded_payment_method_types:"\
+      " #{@excluded_payment_method_types.inspect}, default_shared_payment_token:"\
+      " #{@default_shared_payment_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end