mt-sdk 0.0.1

data/lib/modern_treasury/models/payment_flow.rb

@@ -0,0 +1,230 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # PaymentFlow Model.
+  class PaymentFlow < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :live_mode
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # The client token of the payment flow. This token can be used to embed a
+    # payment workflow in your client-side application.
+    # @return [String]
+    attr_accessor :client_token
+
+    # The current status of the payment flow. One of `pending`, `completed`,
+    # `expired`, or `cancelled`.
+    # @return [Status17Enum]
+    attr_accessor :status
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000. Can be any integer up to 36 digits.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The currency of the payment.
+    # @return [String]
+    attr_accessor :currency
+
+    # Describes the direction money is flowing in the transaction. Can only be
+    # `debit`. A `debit` pulls money from someone else's account to your own.
+    # @return [Direction9Enum]
+    attr_accessor :direction
+
+    # The ID of a counterparty associated with the payment. As part of the
+    # payment workflow an external account will be associated with this
+    # counterparty.
+    # @return [UUID | String]
+    attr_accessor :counterparty_id
+
+    # If present, the ID of the external account created using this flow.
+    # @return [UUID | String]
+    attr_accessor :receiving_account_id
+
+    # The ID of one of your organization's internal accounts.
+    # @return [UUID | String]
+    attr_accessor :originating_account_id
+
+    # If present, the ID of the payment order created using this flow.
+    # @return [UUID | String]
+    attr_accessor :payment_order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['live_mode'] = 'live_mode'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['client_token'] = 'client_token'
+      @_hash['status'] = 'status'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['direction'] = 'direction'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['receiving_account_id'] = 'receiving_account_id'
+      @_hash['originating_account_id'] = 'originating_account_id'
+      @_hash['payment_order_id'] = 'payment_order_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        object
+        live_mode
+        created_at
+        updated_at
+        client_token
+        status
+        amount
+        currency
+        direction
+        counterparty_id
+        receiving_account_id
+        originating_account_id
+        payment_order_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        counterparty_id
+        receiving_account_id
+        originating_account_id
+        payment_order_id
+      ]
+    end
+
+    def initialize(id = SKIP, object = SKIP, live_mode = SKIP,
+                   created_at = SKIP, updated_at = SKIP, client_token = SKIP,
+                   status = SKIP, amount = SKIP, currency = SKIP,
+                   direction = SKIP, counterparty_id = SKIP,
+                   receiving_account_id = SKIP, originating_account_id = SKIP,
+                   payment_order_id = SKIP)
+      @id = id unless id == SKIP
+      @object = object unless object == SKIP
+      @live_mode = live_mode unless live_mode == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @client_token = client_token unless client_token == SKIP
+      @status = status unless status == SKIP
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @direction = direction unless direction == SKIP
+      @counterparty_id = counterparty_id unless counterparty_id == SKIP
+      @receiving_account_id = receiving_account_id unless receiving_account_id == SKIP
+      @originating_account_id = originating_account_id unless originating_account_id == SKIP
+      @payment_order_id = payment_order_id unless payment_order_id == SKIP
+    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
+      object = hash.key?('object') ? hash['object'] : SKIP
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : 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
+      client_token = hash.key?('client_token') ? hash['client_token'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : SKIP
+      receiving_account_id =
+        hash.key?('receiving_account_id') ? hash['receiving_account_id'] : SKIP
+      originating_account_id =
+        hash.key?('originating_account_id') ? hash['originating_account_id'] : SKIP
+      payment_order_id =
+        hash.key?('payment_order_id') ? hash['payment_order_id'] : SKIP
+
+      # Create object from extracted values.
+      PaymentFlow.new(id,
+                      object,
+                      live_mode,
+                      created_at,
+                      updated_at,
+                      client_token,
+                      status,
+                      amount,
+                      currency,
+                      direction,
+                      counterparty_id,
+                      receiving_account_id,
+                      originating_account_id,
+                      payment_order_id)
+    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}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
+      " #{@created_at}, updated_at: #{@updated_at}, client_token: #{@client_token}, status:"\
+      " #{@status}, amount: #{@amount}, currency: #{@currency}, direction: #{@direction},"\
+      " counterparty_id: #{@counterparty_id}, receiving_account_id: #{@receiving_account_id},"\
+      " originating_account_id: #{@originating_account_id}, payment_order_id:"\
+      " #{@payment_order_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
+      " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, client_token: #{@client_token.inspect}, status:"\
+      " #{@status.inspect}, amount: #{@amount.inspect}, currency: #{@currency.inspect}, direction:"\
+      " #{@direction.inspect}, counterparty_id: #{@counterparty_id.inspect}, receiving_account_id:"\
+      " #{@receiving_account_id.inspect}, originating_account_id:"\
+      " #{@originating_account_id.inspect}, payment_order_id: #{@payment_order_id.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/payment_flow_create_request.rb

@@ -0,0 +1,103 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # PaymentFlowCreateRequest Model.
+  class PaymentFlowCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required. Value in specified currency's smallest unit. e.g. $10 would be
+    # represented as 1000. Can be any integer up to 36 digits.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Required. The currency of the payment.
+    # @return [String]
+    attr_accessor :currency
+
+    # Required. Describes the direction money is flowing in the transaction. Can
+    # only be `debit`. A `debit` pulls money from someone else's account to your
+    # own.
+    # @return [Direction10Enum]
+    attr_accessor :direction
+
+    # Required. The ID of a counterparty associated with the payment. As part of
+    # the payment workflow an external account will be associated with this
+    # model.
+    # @return [UUID | String]
+    attr_accessor :counterparty_id
+
+    # Required. The ID of one of your organization's internal accounts.
+    # @return [UUID | String]
+    attr_accessor :originating_account_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['direction'] = 'direction'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['originating_account_id'] = 'originating_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil, direction = nil,
+                   counterparty_id = nil, originating_account_id = nil)
+      @amount = amount
+      @currency = currency
+      @direction = direction
+      @counterparty_id = counterparty_id
+      @originating_account_id = originating_account_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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : nil
+      originating_account_id =
+        hash.key?('originating_account_id') ? hash['originating_account_id'] : nil
+
+      # Create object from extracted values.
+      PaymentFlowCreateRequest.new(amount,
+                                   currency,
+                                   direction,
+                                   counterparty_id,
+                                   originating_account_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}, direction: #{@direction},"\
+      " counterparty_id: #{@counterparty_id}, originating_account_id: #{@originating_account_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}, direction:"\
+      " #{@direction.inspect}, counterparty_id: #{@counterparty_id.inspect},"\
+      " originating_account_id: #{@originating_account_id.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/payment_flow_update_request.rb

@@ -0,0 +1,61 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # PaymentFlowUpdateRequest Model.
+  class PaymentFlowUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required. The updated status of the payment flow. Can only be used to mark
+    # a flow as `cancelled`.
+    # @return [String]
+    attr_reader :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize
+      @status = 'cancelled'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+
+
+      # Create object from extracted values.
+      PaymentFlowUpdateRequest.new
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/payment_method1_enum.rb

@@ -0,0 +1,46 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # The method by which the invoice can be paid. `ui` will show the embedded
+  # payment collection flow. `automatic` will automatically initiate payment
+  # based upon the account details of the receiving_account id.\nIf the invoice
+  # amount is positive, the automatically initiated payment order's direction
+  # will be debit. If the invoice amount is negative, the automatically
+  # initiated payment order's direction will be credit. One of `manual`, `ui`,
+  # or `automatic`.
+  class PaymentMethod1Enum
+    PAYMENT_METHOD1_ENUM = [
+      # TODO: Write general description for UI
+      UI = 'ui'.freeze,
+
+      # TODO: Write general description for MANUAL
+      MANUAL = 'manual'.freeze,
+
+      # TODO: Write general description for AUTOMATIC
+      AUTOMATIC = 'automatic'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = UI)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ui' then UI
+      when 'manual' then MANUAL
+      when 'automatic' then AUTOMATIC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/payment_method_enum.rb

@@ -0,0 +1,42 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # When opening an invoice, whether to show the embedded payment UI ,
+  # automatically debit the recipient, or rely on manual payment from the
+  # recipient.
+  class PaymentMethodEnum
+    PAYMENT_METHOD_ENUM = [
+      # TODO: Write general description for UI
+      UI = 'ui'.freeze,
+
+      # TODO: Write general description for MANUAL
+      MANUAL = 'manual'.freeze,
+
+      # TODO: Write general description for AUTOMATIC
+      AUTOMATIC = 'automatic'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = UI)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ui' then UI
+      when 'manual' then MANUAL
+      when 'automatic' then AUTOMATIC
+      else
+        default_value
+      end
+    end
+  end
+end