mt-sdk 0.0.1

data/lib/modern_treasury/models/invoice.rb

@@ -0,0 +1,342 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # Invoice Model.
+  class Invoice < 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 invoicer's contact details displayed at the top of the invoice.
+    # @return [Array[ContactDetail]]
+    attr_accessor :contact_details
+
+    # The ID of the counterparty receiving the invoice.
+    # @return [String]
+    attr_accessor :counterparty_id
+
+    # The counterparty's billing address.
+    # @return [CounterpartyBillingAddress]
+    attr_accessor :counterparty_billing_address
+
+    # The counterparty's shipping address where physical goods should be
+    # delivered.
+    # @return [CounterpartyShippingAddress]
+    attr_accessor :counterparty_shipping_address
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # A free-form description of the invoice.
+    # @return [String]
+    attr_accessor :description
+
+    # A future date by when the invoice needs to be paid.
+    # @return [DateTime]
+    attr_accessor :due_date
+
+    # The invoice issuer's business address.
+    # @return [InvoicerAddress]
+    attr_accessor :invoicer_address
+
+    # The ID of the internal account the invoice should be paid to.
+    # @return [String]
+    attr_accessor :originating_account_id
+
+    # The receiving account ID. Can be an `internal_account`.
+    # @return [UUID | String]
+    attr_accessor :receiving_account_id
+
+    # Date transactions are to be posted to the participants' account. Defaults
+    # to the current business day or the next business day if the current day is
+    # a bank holiday or weekend. Format: yyyy-mm-dd.
+    # @return [Date]
+    attr_accessor :payment_effective_date
+
+    # One of `ach` or `eft`
+    # @return [PaymentType5Enum]
+    attr_accessor :payment_type
+
+    # When opening an invoice, whether to show the embedded payment UI ,
+    # automatically debit the recipient, or rely on manual payment from the
+    # recipient.
+    # @return [PaymentMethodEnum]
+    attr_accessor :payment_method
+
+    # The URL of the hosted web UI where the invoice can be viewed.
+    # @return [String]
+    attr_accessor :hosted_url
+
+    # A unique record number assigned to each invoice that is issued.
+    # @return [String]
+    attr_accessor :number
+
+    # The payment orders created for paying the invoice through the invoice
+    # payment UI.
+    # @return [Array[PaymentOrder]]
+    attr_accessor :payment_orders
+
+    # The URL where the invoice PDF can be downloaded.
+    # @return [String]
+    attr_accessor :pdf_url
+
+    # The status of the invoice.
+    # @return [Status5Enum]
+    attr_accessor :status
+
+    # Total amount due in specified currency's smallest unit, e.g., $10 USD
+    # would be represented as 1000.
+    # @return [Integer]
+    attr_accessor :total_amount
+
+    # 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['contact_details'] = 'contact_details'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['counterparty_billing_address'] = 'counterparty_billing_address'
+      @_hash['counterparty_shipping_address'] =
+        'counterparty_shipping_address'
+      @_hash['currency'] = 'currency'
+      @_hash['description'] = 'description'
+      @_hash['due_date'] = 'due_date'
+      @_hash['invoicer_address'] = 'invoicer_address'
+      @_hash['originating_account_id'] = 'originating_account_id'
+      @_hash['receiving_account_id'] = 'receiving_account_id'
+      @_hash['payment_effective_date'] = 'payment_effective_date'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['hosted_url'] = 'hosted_url'
+      @_hash['number'] = 'number'
+      @_hash['payment_orders'] = 'payment_orders'
+      @_hash['pdf_url'] = 'pdf_url'
+      @_hash['status'] = 'status'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        counterparty_billing_address
+        counterparty_shipping_address
+        invoicer_address
+        receiving_account_id
+        payment_effective_date
+        payment_type
+        payment_method
+        pdf_url
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, contact_details = nil,
+                   counterparty_id = nil, counterparty_billing_address = nil,
+                   counterparty_shipping_address = nil, currency = nil,
+                   description = nil, due_date = nil, invoicer_address = nil,
+                   originating_account_id = nil, receiving_account_id = nil,
+                   payment_effective_date = nil, payment_type = nil,
+                   payment_method = nil, hosted_url = nil, number = nil,
+                   payment_orders = nil, pdf_url = nil, status = nil,
+                   total_amount = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @contact_details = contact_details
+      @counterparty_id = counterparty_id
+      @counterparty_billing_address = counterparty_billing_address
+      @counterparty_shipping_address = counterparty_shipping_address
+      @currency = currency
+      @description = description
+      @due_date = due_date
+      @invoicer_address = invoicer_address
+      @originating_account_id = originating_account_id
+      @receiving_account_id = receiving_account_id
+      @payment_effective_date = payment_effective_date
+      @payment_type = payment_type
+      @payment_method = payment_method
+      @hosted_url = hosted_url
+      @number = number
+      @payment_orders = payment_orders
+      @pdf_url = pdf_url
+      @status = status
+      @total_amount = total_amount
+    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
+      object = hash.key?('object') ? hash['object'] : nil
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      # Parameter is an array, so we need to iterate through it
+      contact_details = nil
+      unless hash['contact_details'].nil?
+        contact_details = []
+        hash['contact_details'].each do |structure|
+          contact_details << (ContactDetail.from_hash(structure) if structure)
+        end
+      end
+
+      contact_details = nil unless hash.key?('contact_details')
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : nil
+      if hash['counterparty_billing_address']
+        counterparty_billing_address = CounterpartyBillingAddress.from_hash(hash['counterparty_billing_address'])
+      end
+      if hash['counterparty_shipping_address']
+        counterparty_shipping_address = CounterpartyShippingAddress.from_hash(hash['counterparty_shipping_address'])
+      end
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      due_date = if hash.key?('due_date')
+                   (DateTimeHelper.from_rfc3339(hash['due_date']) if hash['due_date'])
+                 end
+      invoicer_address = InvoicerAddress.from_hash(hash['invoicer_address']) if
+        hash['invoicer_address']
+      originating_account_id =
+        hash.key?('originating_account_id') ? hash['originating_account_id'] : nil
+      receiving_account_id =
+        hash.key?('receiving_account_id') ? hash['receiving_account_id'] : nil
+      payment_effective_date =
+        hash.key?('payment_effective_date') ? hash['payment_effective_date'] : nil
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
+      payment_method =
+        hash.key?('payment_method') ? hash['payment_method'] : nil
+      hosted_url = hash.key?('hosted_url') ? hash['hosted_url'] : nil
+      number = hash.key?('number') ? hash['number'] : nil
+      # Parameter is an array, so we need to iterate through it
+      payment_orders = nil
+      unless hash['payment_orders'].nil?
+        payment_orders = []
+        hash['payment_orders'].each do |structure|
+          payment_orders << (PaymentOrder.from_hash(structure) if structure)
+        end
+      end
+
+      payment_orders = nil unless hash.key?('payment_orders')
+      pdf_url = hash.key?('pdf_url') ? hash['pdf_url'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : nil
+
+      # Create object from extracted values.
+      Invoice.new(id,
+                  object,
+                  live_mode,
+                  created_at,
+                  updated_at,
+                  contact_details,
+                  counterparty_id,
+                  counterparty_billing_address,
+                  counterparty_shipping_address,
+                  currency,
+                  description,
+                  due_date,
+                  invoicer_address,
+                  originating_account_id,
+                  receiving_account_id,
+                  payment_effective_date,
+                  payment_type,
+                  payment_method,
+                  hosted_url,
+                  number,
+                  payment_orders,
+                  pdf_url,
+                  status,
+                  total_amount)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    def to_custom_due_date
+      DateTimeHelper.to_rfc3339(due_date)
+    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}, contact_details: #{@contact_details},"\
+      " counterparty_id: #{@counterparty_id}, counterparty_billing_address:"\
+      " #{@counterparty_billing_address}, counterparty_shipping_address:"\
+      " #{@counterparty_shipping_address}, currency: #{@currency}, description: #{@description},"\
+      " due_date: #{@due_date}, invoicer_address: #{@invoicer_address}, originating_account_id:"\
+      " #{@originating_account_id}, receiving_account_id: #{@receiving_account_id},"\
+      " payment_effective_date: #{@payment_effective_date}, payment_type: #{@payment_type},"\
+      " payment_method: #{@payment_method}, hosted_url: #{@hosted_url}, number: #{@number},"\
+      " payment_orders: #{@payment_orders}, pdf_url: #{@pdf_url}, status: #{@status},"\
+      " total_amount: #{@total_amount}>"
+    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}, contact_details: #{@contact_details.inspect}, counterparty_id:"\
+      " #{@counterparty_id.inspect}, counterparty_billing_address:"\
+      " #{@counterparty_billing_address.inspect}, counterparty_shipping_address:"\
+      " #{@counterparty_shipping_address.inspect}, currency: #{@currency.inspect}, description:"\
+      " #{@description.inspect}, due_date: #{@due_date.inspect}, invoicer_address:"\
+      " #{@invoicer_address.inspect}, originating_account_id: #{@originating_account_id.inspect},"\
+      " receiving_account_id: #{@receiving_account_id.inspect}, payment_effective_date:"\
+      " #{@payment_effective_date.inspect}, payment_type: #{@payment_type.inspect},"\
+      " payment_method: #{@payment_method.inspect}, hosted_url: #{@hosted_url.inspect}, number:"\
+      " #{@number.inspect}, payment_orders: #{@payment_orders.inspect}, pdf_url:"\
+      " #{@pdf_url.inspect}, status: #{@status.inspect}, total_amount: #{@total_amount.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/invoice_create_request.rb

@@ -0,0 +1,235 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # InvoiceCreateRequest Model.
+  class InvoiceCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The invoicer's contact details displayed at the top of the invoice.
+    # @return [Array[ContactDetail]]
+    attr_accessor :contact_details
+
+    # The ID of the counterparty receiving the invoice.
+    # @return [String]
+    attr_accessor :counterparty_id
+
+    # The counterparty's billing address.
+    # @return [CounterpartyBillingAddress]
+    attr_accessor :counterparty_billing_address
+
+    # The counterparty's shipping address where physical goods should be
+    # delivered.
+    # @return [CounterpartyShippingAddress]
+    attr_accessor :counterparty_shipping_address
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # A free-form description of the invoice.
+    # @return [String]
+    attr_accessor :description
+
+    # A future date by when the invoice needs to be paid.
+    # @return [DateTime]
+    attr_accessor :due_date
+
+    # The invoice issuer's business address.
+    # @return [InvoicerAddress]
+    attr_accessor :invoicer_address
+
+    # The ID of the internal account the invoice should be paid to.
+    # @return [String]
+    attr_accessor :originating_account_id
+
+    # The receiving account ID. Can be an `external_account`.
+    # @return [UUID | String]
+    attr_accessor :receiving_account_id
+
+    # Date transactions are to be posted to the participants' account. Defaults
+    # to the current business day or the next business day if the current day is
+    # a bank holiday or weekend. Format: yyyy-mm-dd.
+    # @return [Date]
+    attr_accessor :payment_effective_date
+
+    # One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
+    # `bacs`, `au_becs`, `interac`, `signet`, `provexchange`.
+    # @return [PaymentType6Enum]
+    attr_accessor :payment_type
+
+    # 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`.
+    # @return [PaymentMethod1Enum]
+    attr_accessor :payment_method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_details'] = 'contact_details'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['counterparty_billing_address'] = 'counterparty_billing_address'
+      @_hash['counterparty_shipping_address'] =
+        'counterparty_shipping_address'
+      @_hash['currency'] = 'currency'
+      @_hash['description'] = 'description'
+      @_hash['due_date'] = 'due_date'
+      @_hash['invoicer_address'] = 'invoicer_address'
+      @_hash['originating_account_id'] = 'originating_account_id'
+      @_hash['receiving_account_id'] = 'receiving_account_id'
+      @_hash['payment_effective_date'] = 'payment_effective_date'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_details
+        counterparty_billing_address
+        counterparty_shipping_address
+        currency
+        description
+        invoicer_address
+        receiving_account_id
+        payment_effective_date
+        payment_type
+        payment_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        counterparty_billing_address
+        counterparty_shipping_address
+        invoicer_address
+      ]
+    end
+
+    def initialize(counterparty_id = nil, due_date = nil,
+                   originating_account_id = nil, contact_details = SKIP,
+                   counterparty_billing_address = SKIP,
+                   counterparty_shipping_address = SKIP, currency = SKIP,
+                   description = SKIP, invoicer_address = SKIP,
+                   receiving_account_id = SKIP, payment_effective_date = SKIP,
+                   payment_type = SKIP, payment_method = SKIP)
+      @contact_details = contact_details unless contact_details == SKIP
+      @counterparty_id = counterparty_id
+      unless counterparty_billing_address == SKIP
+        @counterparty_billing_address =
+          counterparty_billing_address
+      end
+      unless counterparty_shipping_address == SKIP
+        @counterparty_shipping_address =
+          counterparty_shipping_address
+      end
+      @currency = currency unless currency == SKIP
+      @description = description unless description == SKIP
+      @due_date = due_date
+      @invoicer_address = invoicer_address unless invoicer_address == SKIP
+      @originating_account_id = originating_account_id
+      @receiving_account_id = receiving_account_id unless receiving_account_id == SKIP
+      @payment_effective_date = payment_effective_date unless payment_effective_date == SKIP
+      @payment_type = payment_type unless payment_type == SKIP
+      @payment_method = payment_method unless payment_method == 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.
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : nil
+      due_date = if hash.key?('due_date')
+                   (DateTimeHelper.from_rfc3339(hash['due_date']) if hash['due_date'])
+                 end
+      originating_account_id =
+        hash.key?('originating_account_id') ? hash['originating_account_id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      contact_details = nil
+      unless hash['contact_details'].nil?
+        contact_details = []
+        hash['contact_details'].each do |structure|
+          contact_details << (ContactDetail.from_hash(structure) if structure)
+        end
+      end
+
+      contact_details = SKIP unless hash.key?('contact_details')
+      if hash['counterparty_billing_address']
+        counterparty_billing_address = CounterpartyBillingAddress.from_hash(hash['counterparty_billing_address'])
+      end
+      if hash['counterparty_shipping_address']
+        counterparty_shipping_address = CounterpartyShippingAddress.from_hash(hash['counterparty_shipping_address'])
+      end
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      invoicer_address = InvoicerAddress.from_hash(hash['invoicer_address']) if
+        hash['invoicer_address']
+      receiving_account_id =
+        hash.key?('receiving_account_id') ? hash['receiving_account_id'] : SKIP
+      payment_effective_date =
+        hash.key?('payment_effective_date') ? hash['payment_effective_date'] : SKIP
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
+      payment_method =
+        hash.key?('payment_method') ? hash['payment_method'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceCreateRequest.new(counterparty_id,
+                               due_date,
+                               originating_account_id,
+                               contact_details,
+                               counterparty_billing_address,
+                               counterparty_shipping_address,
+                               currency,
+                               description,
+                               invoicer_address,
+                               receiving_account_id,
+                               payment_effective_date,
+                               payment_type,
+                               payment_method)
+    end
+
+    def to_custom_due_date
+      DateTimeHelper.to_rfc3339(due_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_details: #{@contact_details}, counterparty_id: #{@counterparty_id},"\
+      " counterparty_billing_address: #{@counterparty_billing_address},"\
+      " counterparty_shipping_address: #{@counterparty_shipping_address}, currency: #{@currency},"\
+      " description: #{@description}, due_date: #{@due_date}, invoicer_address:"\
+      " #{@invoicer_address}, originating_account_id: #{@originating_account_id},"\
+      " receiving_account_id: #{@receiving_account_id}, payment_effective_date:"\
+      " #{@payment_effective_date}, payment_type: #{@payment_type}, payment_method:"\
+      " #{@payment_method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_details: #{@contact_details.inspect}, counterparty_id:"\
+      " #{@counterparty_id.inspect}, counterparty_billing_address:"\
+      " #{@counterparty_billing_address.inspect}, counterparty_shipping_address:"\
+      " #{@counterparty_shipping_address.inspect}, currency: #{@currency.inspect}, description:"\
+      " #{@description.inspect}, due_date: #{@due_date.inspect}, invoicer_address:"\
+      " #{@invoicer_address.inspect}, originating_account_id: #{@originating_account_id.inspect},"\
+      " receiving_account_id: #{@receiving_account_id.inspect}, payment_effective_date:"\
+      " #{@payment_effective_date.inspect}, payment_type: #{@payment_type.inspect},"\
+      " payment_method: #{@payment_method.inspect}>"
+    end
+  end
+end