mt-sdk 0.0.1

data/lib/modern_treasury/models/payment_order_update_request.rb

@@ -0,0 +1,543 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # PaymentOrderUpdateRequest Model.
+  class PaymentOrderUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
+    # `bacs`, `au_becs`, `interac`, `signet`, `provexchange`.
+    # @return [Type5Enum]
+    attr_accessor :type
+
+    # An additional layer of classification for the type of payment order you
+    # are doing. This field is only used for `ach` payment orders currently. For
+    # `ach`  payment orders, the `subtype`  represents the SEC code. We
+    # currently support `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
+    # @return [SubtypeEnum]
+    attr_accessor :subtype
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000 (cents). For RTP, the maximum amount allowed by the network is
+    # $100,000.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # One of `credit`, `debit`. Describes the direction money is flowing in the
+    # transaction. A `credit` moves money from your account to someone else's. A
+    # `debit` pulls money from someone else's account to your own. Note that
+    # wire, rtp, and check payments will always be `credit`.
+    # @return [Direction5Enum]
+    attr_accessor :direction
+
+    # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
+    # same-day ACH or EFT transfer, respectively. For check payments, `high` can
+    # mean an overnight check rather than standard mail.
+    # @return [PriorityEnum]
+    attr_accessor :priority
+
+    # The ID of one of your organization's internal accounts.
+    # @return [UUID | String]
+    attr_accessor :originating_account_id
+
+    # Either `receiving_account` or `receiving_account_id` must be present. When
+    # using `receiving_account_id`, you may pass the id of an external account
+    # or an internal account.
+    # @return [UUID | String]
+    attr_accessor :receiving_account_id
+
+    # Either `receiving_account` or `receiving_account_id` must be present. When
+    # using `receiving_account_id`, you may pass the id of an external account
+    # or an internal account.
+    # @return [Accounting]
+    attr_accessor :accounting
+
+    # The ID of one of your accounting categories. Note that these will only be
+    # accessible if your accounting system has been connected.
+    # @return [UUID | String]
+    attr_accessor :accounting_category_id
+
+    # The ID of one of your accounting ledger classes. Note that these will only
+    # be accessible if your accounting system has been connected.
+    # @return [UUID | String]
+    attr_accessor :accounting_ledger_class_id
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # 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 :effective_date
+
+    # An optional description for internal use.
+    # @return [String]
+    attr_accessor :description
+
+    # An optional descriptor which will appear in the receiver's statement. For
+    # `check` payments this field will be used as the memo line. For `ach` the
+    # maximum length is 10 characters. Note that for ACH payments, the name on
+    # your bank account will be included automatically by the bank, so you can
+    # use the characters for other useful information. For `eft` the maximum
+    # length is 15 characters.
+    # @return [String]
+    attr_accessor :statement_descriptor
+
+    # For `ach`, this field will be passed through on an addenda record. For
+    # `wire` payments the field will be passed through as the "Originator to
+    # Beneficiary Information", also known as OBI or Fedwire tag 6000.
+    # @return [String]
+    attr_accessor :remittance_information
+
+    # For `wire`, this is usually the purpose which is transmitted via the
+    # "InstrForDbtrAgt" field in the ISO20022 file. If you are using
+    # Currencycloud, this is the `payment.purpose_code` field. For `eft`, this
+    # field is the 3 digit CPA Code that will be attached to the payment.
+    # @return [String]
+    attr_accessor :purpose
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The party that will pay the fees for the payment order. Only applies to
+    # wire payment orders. Can be one of shared, sender, or receiver, which
+    # correspond respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+    # @return [ChargeBearerEnum]
+    attr_accessor :charge_bearer
+
+    # Indicates the type of FX transfer to initiate, can be either
+    # `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
+    # currency matches the originating account currency.
+    # @return [ForeignExchangeIndicatorEnum]
+    attr_accessor :foreign_exchange_indicator
+
+    # If present, indicates a specific foreign exchange contract number that has
+    # been generated by your financial institution.
+    # @return [String]
+    attr_accessor :foreign_exchange_contract
+
+    # A boolean to determine if NSF Protection is enabled for this payment
+    # order. Note that this setting must also be turned on in your organization
+    # settings page.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :nsf_protected
+
+    # If present, this will replace your default company name on receiver's bank
+    # statement. This field can only be used for ACH payments currently. For
+    # ACH, only the first 16 characters of this string will be used. Any
+    # additional characters will be truncated.
+    # @return [String]
+    attr_accessor :originating_party_name
+
+    # This represents the name of the person that the payment is on behalf of
+    # when using the CIE subtype for ACH payments. Only the first 15 characters
+    # of this string will be used. Any additional characters will be truncated.
+    # @return [String]
+    attr_accessor :ultimate_originating_party_name
+
+    # This represents the identifier by which the person is known to the
+    # receiver when using the CIE subtype for ACH payments. Only the first 22
+    # characters of this string will be used. Any additional characters will be
+    # truncated.
+    # @return [String]
+    attr_accessor :ultimate_originating_party_identifier
+
+    # This represents the identifier by which the merchant is known to the
+    # person initiating an ACH payment with CIE subtype. Only the first 15
+    # characters of this string will be used. Any additional characters will be
+    # truncated.
+    # @return [String]
+    attr_accessor :ultimate_receiving_party_name
+
+    # This represents the name of the merchant that the payment is being sent to
+    # when using the CIE subtype for ACH payments. Only the first 22 characters
+    # of this string will be used. Any additional characters will be truncated.
+    # @return [String]
+    attr_accessor :ultimate_receiving_party_identifier
+
+    # Send an email to the counterparty when the payment order is sent to the
+    # bank. If `null`, `send_remittance_advice` on the Counterparty is used.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_remittance_advice
+
+    # RFP payments require an expires_at. This value must be past the
+    # effective_date.
+    # @return [DateTime]
+    attr_accessor :expires_at
+
+    # To cancel a payment order, use `cancelled`. To redraft a returned payment
+    # order, use `approved`. To undo approval on a denied or approved payment
+    # order, use `needs_approval`.
+    # @return [Status18Enum]
+    attr_accessor :status
+
+    # Required when receiving_account_id is passed the ID of an external
+    # account.
+    # @return [UUID | String]
+    attr_accessor :counterparty_id
+
+    # A payment type to fallback to if the original type is not valid for the
+    # receiving account. Currently, this only supports falling back from RTP to
+    # ACH (type=rtp and fallback_type=ach)
+    # @return [FallbackTypeEnum]
+    attr_accessor :fallback_type
+
+    # Either `receiving_account` or `receiving_account_id` must be present. When
+    # using `receiving_account_id`, you may pass the id of an external account
+    # or an internal account.
+    # @return [ReceivingAccount1]
+    attr_accessor :receiving_account
+
+    # An array of line items that must sum up to the amount of the payment
+    # order.
+    # @return [Array[LineItemRequest]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['subtype'] = 'subtype'
+      @_hash['amount'] = 'amount'
+      @_hash['direction'] = 'direction'
+      @_hash['priority'] = 'priority'
+      @_hash['originating_account_id'] = 'originating_account_id'
+      @_hash['receiving_account_id'] = 'receiving_account_id'
+      @_hash['accounting'] = 'accounting'
+      @_hash['accounting_category_id'] = 'accounting_category_id'
+      @_hash['accounting_ledger_class_id'] = 'accounting_ledger_class_id'
+      @_hash['currency'] = 'currency'
+      @_hash['effective_date'] = 'effective_date'
+      @_hash['description'] = 'description'
+      @_hash['statement_descriptor'] = 'statement_descriptor'
+      @_hash['remittance_information'] = 'remittance_information'
+      @_hash['purpose'] = 'purpose'
+      @_hash['metadata'] = 'metadata'
+      @_hash['charge_bearer'] = 'charge_bearer'
+      @_hash['foreign_exchange_indicator'] = 'foreign_exchange_indicator'
+      @_hash['foreign_exchange_contract'] = 'foreign_exchange_contract'
+      @_hash['nsf_protected'] = 'nsf_protected'
+      @_hash['originating_party_name'] = 'originating_party_name'
+      @_hash['ultimate_originating_party_name'] =
+        'ultimate_originating_party_name'
+      @_hash['ultimate_originating_party_identifier'] =
+        'ultimate_originating_party_identifier'
+      @_hash['ultimate_receiving_party_name'] =
+        'ultimate_receiving_party_name'
+      @_hash['ultimate_receiving_party_identifier'] =
+        'ultimate_receiving_party_identifier'
+      @_hash['send_remittance_advice'] = 'send_remittance_advice'
+      @_hash['expires_at'] = 'expires_at'
+      @_hash['status'] = 'status'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['fallback_type'] = 'fallback_type'
+      @_hash['receiving_account'] = 'receiving_account'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        subtype
+        amount
+        direction
+        priority
+        originating_account_id
+        receiving_account_id
+        accounting
+        accounting_category_id
+        accounting_ledger_class_id
+        currency
+        effective_date
+        description
+        statement_descriptor
+        remittance_information
+        purpose
+        metadata
+        charge_bearer
+        foreign_exchange_indicator
+        foreign_exchange_contract
+        nsf_protected
+        originating_party_name
+        ultimate_originating_party_name
+        ultimate_originating_party_identifier
+        ultimate_receiving_party_name
+        ultimate_receiving_party_identifier
+        send_remittance_advice
+        expires_at
+        status
+        counterparty_id
+        fallback_type
+        receiving_account
+        line_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        subtype
+        accounting_category_id
+        accounting_ledger_class_id
+        description
+        statement_descriptor
+        remittance_information
+        purpose
+        charge_bearer
+        foreign_exchange_indicator
+        foreign_exchange_contract
+        originating_party_name
+        ultimate_originating_party_name
+        ultimate_originating_party_identifier
+        ultimate_receiving_party_name
+        ultimate_receiving_party_identifier
+        send_remittance_advice
+        expires_at
+        counterparty_id
+      ]
+    end
+
+    def initialize(type = SKIP, subtype = SKIP, amount = SKIP, direction = SKIP,
+                   priority = SKIP, originating_account_id = SKIP,
+                   receiving_account_id = SKIP, accounting = SKIP,
+                   accounting_category_id = SKIP,
+                   accounting_ledger_class_id = SKIP, currency = SKIP,
+                   effective_date = SKIP, description = SKIP,
+                   statement_descriptor = SKIP, remittance_information = SKIP,
+                   purpose = SKIP, metadata = SKIP, charge_bearer = SKIP,
+                   foreign_exchange_indicator = SKIP,
+                   foreign_exchange_contract = SKIP, nsf_protected = SKIP,
+                   originating_party_name = SKIP,
+                   ultimate_originating_party_name = SKIP,
+                   ultimate_originating_party_identifier = SKIP,
+                   ultimate_receiving_party_name = SKIP,
+                   ultimate_receiving_party_identifier = SKIP,
+                   send_remittance_advice = SKIP, expires_at = SKIP,
+                   status = SKIP, counterparty_id = SKIP, fallback_type = SKIP,
+                   receiving_account = SKIP, line_items = SKIP)
+      @type = type unless type == SKIP
+      @subtype = subtype unless subtype == SKIP
+      @amount = amount unless amount == SKIP
+      @direction = direction unless direction == SKIP
+      @priority = priority unless priority == SKIP
+      @originating_account_id = originating_account_id unless originating_account_id == SKIP
+      @receiving_account_id = receiving_account_id unless receiving_account_id == SKIP
+      @accounting = accounting unless accounting == SKIP
+      @accounting_category_id = accounting_category_id unless accounting_category_id == SKIP
+      unless accounting_ledger_class_id == SKIP
+        @accounting_ledger_class_id =
+          accounting_ledger_class_id
+      end
+      @currency = currency unless currency == SKIP
+      @effective_date = effective_date unless effective_date == SKIP
+      @description = description unless description == SKIP
+      @statement_descriptor = statement_descriptor unless statement_descriptor == SKIP
+      @remittance_information = remittance_information unless remittance_information == SKIP
+      @purpose = purpose unless purpose == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @charge_bearer = charge_bearer unless charge_bearer == SKIP
+      unless foreign_exchange_indicator == SKIP
+        @foreign_exchange_indicator =
+          foreign_exchange_indicator
+      end
+      unless foreign_exchange_contract == SKIP
+        @foreign_exchange_contract =
+          foreign_exchange_contract
+      end
+      @nsf_protected = nsf_protected unless nsf_protected == SKIP
+      @originating_party_name = originating_party_name unless originating_party_name == SKIP
+      unless ultimate_originating_party_name == SKIP
+        @ultimate_originating_party_name =
+          ultimate_originating_party_name
+      end
+      unless ultimate_originating_party_identifier == SKIP
+        @ultimate_originating_party_identifier =
+          ultimate_originating_party_identifier
+      end
+      unless ultimate_receiving_party_name == SKIP
+        @ultimate_receiving_party_name =
+          ultimate_receiving_party_name
+      end
+      unless ultimate_receiving_party_identifier == SKIP
+        @ultimate_receiving_party_identifier =
+          ultimate_receiving_party_identifier
+      end
+      @send_remittance_advice = send_remittance_advice unless send_remittance_advice == SKIP
+      @expires_at = expires_at unless expires_at == SKIP
+      @status = status unless status == SKIP
+      @counterparty_id = counterparty_id unless counterparty_id == SKIP
+      @fallback_type = fallback_type unless fallback_type == SKIP
+      @receiving_account = receiving_account unless receiving_account == SKIP
+      @line_items = line_items unless line_items == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      subtype = hash.key?('subtype') ? hash['subtype'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
+      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
+      accounting = Accounting.from_hash(hash['accounting']) if hash['accounting']
+      accounting_category_id =
+        hash.key?('accounting_category_id') ? hash['accounting_category_id'] : SKIP
+      accounting_ledger_class_id =
+        hash.key?('accounting_ledger_class_id') ? hash['accounting_ledger_class_id'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      effective_date =
+        hash.key?('effective_date') ? hash['effective_date'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      statement_descriptor =
+        hash.key?('statement_descriptor') ? hash['statement_descriptor'] : SKIP
+      remittance_information =
+        hash.key?('remittance_information') ? hash['remittance_information'] : SKIP
+      purpose = hash.key?('purpose') ? hash['purpose'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      charge_bearer = hash.key?('charge_bearer') ? hash['charge_bearer'] : SKIP
+      foreign_exchange_indicator =
+        hash.key?('foreign_exchange_indicator') ? hash['foreign_exchange_indicator'] : SKIP
+      foreign_exchange_contract =
+        hash.key?('foreign_exchange_contract') ? hash['foreign_exchange_contract'] : SKIP
+      nsf_protected = hash.key?('nsf_protected') ? hash['nsf_protected'] : SKIP
+      originating_party_name =
+        hash.key?('originating_party_name') ? hash['originating_party_name'] : SKIP
+      ultimate_originating_party_name =
+        hash.key?('ultimate_originating_party_name') ? hash['ultimate_originating_party_name'] : SKIP
+      ultimate_originating_party_identifier =
+        hash.key?('ultimate_originating_party_identifier') ? hash['ultimate_originating_party_identifier'] : SKIP
+      ultimate_receiving_party_name =
+        hash.key?('ultimate_receiving_party_name') ? hash['ultimate_receiving_party_name'] : SKIP
+      ultimate_receiving_party_identifier =
+        hash.key?('ultimate_receiving_party_identifier') ? hash['ultimate_receiving_party_identifier'] : SKIP
+      send_remittance_advice =
+        hash.key?('send_remittance_advice') ? hash['send_remittance_advice'] : SKIP
+      expires_at = if hash.key?('expires_at')
+                     (DateTimeHelper.from_rfc3339(hash['expires_at']) if hash['expires_at'])
+                   else
+                     SKIP
+                   end
+      status = hash.key?('status') ? hash['status'] : SKIP
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : SKIP
+      fallback_type = hash.key?('fallback_type') ? hash['fallback_type'] : SKIP
+      receiving_account = ReceivingAccount1.from_hash(hash['receiving_account']) if
+        hash['receiving_account']
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (LineItemRequest.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+
+      # Create object from extracted values.
+      PaymentOrderUpdateRequest.new(type,
+                                    subtype,
+                                    amount,
+                                    direction,
+                                    priority,
+                                    originating_account_id,
+                                    receiving_account_id,
+                                    accounting,
+                                    accounting_category_id,
+                                    accounting_ledger_class_id,
+                                    currency,
+                                    effective_date,
+                                    description,
+                                    statement_descriptor,
+                                    remittance_information,
+                                    purpose,
+                                    metadata,
+                                    charge_bearer,
+                                    foreign_exchange_indicator,
+                                    foreign_exchange_contract,
+                                    nsf_protected,
+                                    originating_party_name,
+                                    ultimate_originating_party_name,
+                                    ultimate_originating_party_identifier,
+                                    ultimate_receiving_party_name,
+                                    ultimate_receiving_party_identifier,
+                                    send_remittance_advice,
+                                    expires_at,
+                                    status,
+                                    counterparty_id,
+                                    fallback_type,
+                                    receiving_account,
+                                    line_items)
+    end
+
+    def to_custom_expires_at
+      DateTimeHelper.to_rfc3339(expires_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, subtype: #{@subtype}, amount: #{@amount}, direction:"\
+      " #{@direction}, priority: #{@priority}, originating_account_id: #{@originating_account_id},"\
+      " receiving_account_id: #{@receiving_account_id}, accounting: #{@accounting},"\
+      " accounting_category_id: #{@accounting_category_id}, accounting_ledger_class_id:"\
+      " #{@accounting_ledger_class_id}, currency: #{@currency}, effective_date:"\
+      " #{@effective_date}, description: #{@description}, statement_descriptor:"\
+      " #{@statement_descriptor}, remittance_information: #{@remittance_information}, purpose:"\
+      " #{@purpose}, metadata: #{@metadata}, charge_bearer: #{@charge_bearer},"\
+      " foreign_exchange_indicator: #{@foreign_exchange_indicator}, foreign_exchange_contract:"\
+      " #{@foreign_exchange_contract}, nsf_protected: #{@nsf_protected}, originating_party_name:"\
+      " #{@originating_party_name}, ultimate_originating_party_name:"\
+      " #{@ultimate_originating_party_name}, ultimate_originating_party_identifier:"\
+      " #{@ultimate_originating_party_identifier}, ultimate_receiving_party_name:"\
+      " #{@ultimate_receiving_party_name}, ultimate_receiving_party_identifier:"\
+      " #{@ultimate_receiving_party_identifier}, send_remittance_advice:"\
+      " #{@send_remittance_advice}, expires_at: #{@expires_at}, status: #{@status},"\
+      " counterparty_id: #{@counterparty_id}, fallback_type: #{@fallback_type}, receiving_account:"\
+      " #{@receiving_account}, line_items: #{@line_items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, subtype: #{@subtype.inspect}, amount:"\
+      " #{@amount.inspect}, direction: #{@direction.inspect}, priority: #{@priority.inspect},"\
+      " originating_account_id: #{@originating_account_id.inspect}, receiving_account_id:"\
+      " #{@receiving_account_id.inspect}, accounting: #{@accounting.inspect},"\
+      " accounting_category_id: #{@accounting_category_id.inspect}, accounting_ledger_class_id:"\
+      " #{@accounting_ledger_class_id.inspect}, currency: #{@currency.inspect}, effective_date:"\
+      " #{@effective_date.inspect}, description: #{@description.inspect}, statement_descriptor:"\
+      " #{@statement_descriptor.inspect}, remittance_information:"\
+      " #{@remittance_information.inspect}, purpose: #{@purpose.inspect}, metadata:"\
+      " #{@metadata.inspect}, charge_bearer: #{@charge_bearer.inspect},"\
+      " foreign_exchange_indicator: #{@foreign_exchange_indicator.inspect},"\
+      " foreign_exchange_contract: #{@foreign_exchange_contract.inspect}, nsf_protected:"\
+      " #{@nsf_protected.inspect}, originating_party_name: #{@originating_party_name.inspect},"\
+      " ultimate_originating_party_name: #{@ultimate_originating_party_name.inspect},"\
+      " ultimate_originating_party_identifier: #{@ultimate_originating_party_identifier.inspect},"\
+      " ultimate_receiving_party_name: #{@ultimate_receiving_party_name.inspect},"\
+      " ultimate_receiving_party_identifier: #{@ultimate_receiving_party_identifier.inspect},"\
+      " send_remittance_advice: #{@send_remittance_advice.inspect}, expires_at:"\
+      " #{@expires_at.inspect}, status: #{@status.inspect}, counterparty_id:"\
+      " #{@counterparty_id.inspect}, fallback_type: #{@fallback_type.inspect}, receiving_account:"\
+      " #{@receiving_account.inspect}, line_items: #{@line_items.inspect}>"
+    end
+  end
+end