mt-sdk 0.0.1

data/lib/modern_treasury/models/invoice_line_item.rb

@@ -0,0 +1,171 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # InvoiceLineItem Model.
+  class InvoiceLineItem < 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 name of the line item, typically a product or SKU name.
+    # @return [String]
+    attr_accessor :name
+
+    # An optional free-form description of the line item.
+    # @return [String]
+    attr_accessor :description
+
+    # The number of units of a product or service that this line item is for.
+    #        Must be a whole number. Defaults to 1 if not provided.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The cost per unit of the product or service that this line item is for,
+    #        specified in the invoice currency's smallest unit.
+    # @return [Integer]
+    attr_accessor :unit_amount
+
+    # Either `debit` or `credit`. `debit` indicates that a client owes the
+    # business money           and increases the invoice's `total_amount` due.
+    # `credit` has the opposite intention and effect.
+    # @return [String]
+    attr_accessor :direction
+
+    # The total amount for this line item specified in the invoice currency's
+    # smallest unit.
+    # @return [Integer]
+    attr_accessor :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['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash['direction'] = 'direction'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, name = nil, description = nil,
+                   quantity = nil, unit_amount = nil, direction = nil,
+                   amount = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @name = name
+      @description = description
+      @quantity = quantity
+      @unit_amount = unit_amount
+      @direction = direction
+      @amount = 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
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+
+      # Create object from extracted values.
+      InvoiceLineItem.new(id,
+                          object,
+                          live_mode,
+                          created_at,
+                          updated_at,
+                          name,
+                          description,
+                          quantity,
+                          unit_amount,
+                          direction,
+                          amount)
+    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}, name: #{@name}, description: #{@description},"\
+      " quantity: #{@quantity}, unit_amount: #{@unit_amount}, direction: #{@direction}, amount:"\
+      " #{@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}, name: #{@name.inspect}, description: #{@description.inspect},"\
+      " quantity: #{@quantity.inspect}, unit_amount: #{@unit_amount.inspect}, direction:"\
+      " #{@direction.inspect}, amount: #{@amount.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/invoice_line_item_create_request.rb

@@ -0,0 +1,104 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # InvoiceLineItemCreateRequest Model.
+  class InvoiceLineItemCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the line item, typically a product or SKU name.
+    # @return [String]
+    attr_accessor :name
+
+    # An optional free-form description of the line item.
+    # @return [String]
+    attr_accessor :description
+
+    # The number of units of a product or service that this line item is for.
+    #        Must be a whole number. Defaults to 1 if not provided.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The cost per unit of the product or service that this line item is for,
+    #        specified in the invoice currency's smallest unit.
+    # @return [Integer]
+    attr_accessor :unit_amount
+
+    # Either `debit` or `credit`. `debit` indicates that a client owes the
+    # business money           and increases the invoice's `total_amount` due.
+    # `credit` has the opposite intention and effect.
+    # @return [String]
+    attr_accessor :direction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash['direction'] = 'direction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        quantity
+        direction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, unit_amount = nil, description = SKIP,
+                   quantity = SKIP, direction = SKIP)
+      @name = name
+      @description = description unless description == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @unit_amount = unit_amount
+      @direction = direction unless direction == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceLineItemCreateRequest.new(name,
+                                       unit_amount,
+                                       description,
+                                       quantity,
+                                       direction)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, description: #{@description}, quantity: #{@quantity},"\
+      " unit_amount: #{@unit_amount}, direction: #{@direction}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, description: #{@description.inspect}, quantity:"\
+      " #{@quantity.inspect}, unit_amount: #{@unit_amount.inspect}, direction:"\
+      " #{@direction.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/invoice_line_item_update_request.rb

@@ -0,0 +1,240 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # InvoiceLineItemUpdateRequest Model.
+  class InvoiceLineItemUpdateRequest < 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_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
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        counterparty_billing_address
+        counterparty_shipping_address
+        invoicer_address
+      ]
+    end
+
+    def initialize(contact_details = SKIP, counterparty_id = SKIP,
+                   counterparty_billing_address = SKIP,
+                   counterparty_shipping_address = SKIP, currency = SKIP,
+                   description = SKIP, due_date = SKIP, invoicer_address = SKIP,
+                   originating_account_id = 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_id == SKIP
+      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 unless due_date == SKIP
+      @invoicer_address = invoicer_address unless invoicer_address == SKIP
+      @originating_account_id = originating_account_id unless originating_account_id == SKIP
+      @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.
+      # 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')
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : SKIP
+      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
+      due_date = if hash.key?('due_date')
+                   (DateTimeHelper.from_rfc3339(hash['due_date']) if hash['due_date'])
+                 else
+                   SKIP
+                 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'] : SKIP
+      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.
+      InvoiceLineItemUpdateRequest.new(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)
+    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