increase 0.3.2 → 1.0.0

data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundACHTransfers#create
+      class InboundACHTransferCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_number_id
+        #   The identifier of the Account Number the inbound ACH Transfer is for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!attribute amount
+        #   The transfer amount in cents. A positive amount originates a credit transfer
+        #   pushing funds to the receiving account. A negative amount originates a debit
+        #   transfer pulling funds from the receiving account.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute addenda
+        #   Additional information to include in the transfer.
+        #
+        #   @return [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda, nil]
+        optional :addenda, -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda }
+
+        # @!attribute company_descriptive_date
+        #   The description of the date of the transfer.
+        #
+        #   @return [String, nil]
+        optional :company_descriptive_date, String
+
+        # @!attribute company_discretionary_data
+        #   Data associated with the transfer set by the sender.
+        #
+        #   @return [String, nil]
+        optional :company_discretionary_data, String
+
+        # @!attribute company_entry_description
+        #   The description of the transfer set by the sender.
+        #
+        #   @return [String, nil]
+        optional :company_entry_description, String
+
+        # @!attribute company_id
+        #   The sender's company ID.
+        #
+        #   @return [String, nil]
+        optional :company_id, String
+
+        # @!attribute company_name
+        #   The name of the sender.
+        #
+        #   @return [String, nil]
+        optional :company_name, String
+
+        # @!attribute receiver_id_number
+        #   The ID of the receiver of the transfer.
+        #
+        #   @return [String, nil]
+        optional :receiver_id_number, String
+
+        # @!attribute receiver_name
+        #   The name of the receiver of the transfer.
+        #
+        #   @return [String, nil]
+        optional :receiver_name, String
+
+        # @!attribute resolve_at
+        #   The time at which the transfer should be resolved. If not provided will resolve
+        #   immediately.
+        #
+        #   @return [Time, nil]
+        optional :resolve_at, Time
+
+        # @!attribute standard_entry_class_code
+        #   The standard entry class code for the transfer.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode, nil]
+        optional :standard_entry_class_code,
+                 enum: -> { Increase::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode }
+
+        # @!method initialize(account_number_id:, amount:, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_id: nil, company_name: nil, receiver_id_number: nil, receiver_name: nil, resolve_at: nil, standard_entry_class_code: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundACHTransferCreateParams} for more
+        #   details.
+        #
+        #   @param account_number_id [String] The identifier of the Account Number the inbound ACH Transfer is for.
+        #
+        #   @param amount [Integer] The transfer amount in cents. A positive amount originates a credit transfer pus
+        #
+        #   @param addenda [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda] Additional information to include in the transfer.
+        #
+        #   @param company_descriptive_date [String] The description of the date of the transfer.
+        #
+        #   @param company_discretionary_data [String] Data associated with the transfer set by the sender.
+        #
+        #   @param company_entry_description [String] The description of the transfer set by the sender.
+        #
+        #   @param company_id [String] The sender's company ID.
+        #
+        #   @param company_name [String] The name of the sender.
+        #
+        #   @param receiver_id_number [String] The ID of the receiver of the transfer.
+        #
+        #   @param receiver_name [String] The name of the receiver of the transfer.
+        #
+        #   @param resolve_at [Time] The time at which the transfer should be resolved. If not provided will resolve
+        #
+        #   @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] The standard entry class code for the transfer.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        class Addenda < Increase::Internal::Type::BaseModel
+          # @!attribute category
+          #   The type of addenda to simulate being sent with the transfer.
+          #
+          #   @return [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Category]
+          required :category,
+                   enum: -> {
+                     Increase::Simulations::InboundACHTransferCreateParams::Addenda::Category
+                   }
+
+          # @!attribute freeform
+          #   Unstructured `payment_related_information` passed through with the transfer.
+          #
+          #   @return [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform, nil]
+          optional :freeform, -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda::Freeform }
+
+          # @!method initialize(category:, freeform: nil)
+          #   Additional information to include in the transfer.
+          #
+          #   @param category [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Category] The type of addenda to simulate being sent with the transfer.
+          #
+          #   @param freeform [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform] Unstructured `payment_related_information` passed through with the transfer.
+
+          # The type of addenda to simulate being sent with the transfer.
+          #
+          # @see Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda#category
+          module Category
+            extend Increase::Internal::Type::Enum
+
+            # Unstructured `payment_related_information` passed through with the transfer.
+            FREEFORM = :freeform
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda#freeform
+          class Freeform < Increase::Internal::Type::BaseModel
+            # @!attribute entries
+            #   Each entry represents an addendum sent with the transfer.
+            #
+            #   @return [Array<Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry>]
+            required :entries,
+                     -> {
+                       Increase::Internal::Type::ArrayOf[Increase::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry]
+                     }
+
+            # @!method initialize(entries:)
+            #   Unstructured `payment_related_information` passed through with the transfer.
+            #
+            #   @param entries [Array<Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry>] Each entry represents an addendum sent with the transfer.
+
+            class Entry < Increase::Internal::Type::BaseModel
+              # @!attribute payment_related_information
+              #   The payment related information passed in the addendum.
+              #
+              #   @return [String]
+              required :payment_related_information, String
+
+              # @!method initialize(payment_related_information:)
+              #   @param payment_related_information [String] The payment related information passed in the addendum.
+            end
+          end
+        end
+
+        # The standard entry class code for the transfer.
+        module StandardEntryClassCode
+          extend Increase::Internal::Type::Enum
+
+          # Corporate Credit and Debit (CCD).
+          CORPORATE_CREDIT_OR_DEBIT = :corporate_credit_or_debit
+
+          # Corporate Trade Exchange (CTX).
+          CORPORATE_TRADE_EXCHANGE = :corporate_trade_exchange
+
+          # Prearranged Payments and Deposits (PPD).
+          PREARRANGED_PAYMENTS_AND_DEPOSIT = :prearranged_payments_and_deposit
+
+          # Internet Initiated (WEB).
+          INTERNET_INITIATED = :internet_initiated
+
+          # Point of Sale (POS).
+          POINT_OF_SALE = :point_of_sale
+
+          # Telephone Initiated (TEL).
+          TELEPHONE_INITIATED = :telephone_initiated
+
+          # Customer Initiated (CIE).
+          CUSTOMER_INITIATED = :customer_initiated
+
+          # Accounts Receivable (ARC).
+          ACCOUNTS_RECEIVABLE = :accounts_receivable
+
+          # Machine Transfer (MTE).
+          MACHINE_TRANSFER = :machine_transfer
+
+          # Shared Network Transaction (SHR).
+          SHARED_NETWORK_TRANSACTION = :shared_network_transaction
+
+          # Represented Check (RCK).
+          REPRESENTED_CHECK = :represented_check
+
+          # Back Office Conversion (BOC).
+          BACK_OFFICE_CONVERSION = :back_office_conversion
+
+          # Point of Purchase (POP).
+          POINT_OF_PURCHASE = :point_of_purchase
+
+          # Check Truncation (TRC).
+          CHECK_TRUNCATION = :check_truncation
+
+          # Destroyed Check (XCK).
+          DESTROYED_CHECK = :destroyed_check
+
+          # International ACH Transaction (IAT).
+          INTERNATIONAL_ACH_TRANSACTION = :international_ach_transaction
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundCheckDeposits#create
+      class InboundCheckDepositCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_number_id
+        #   The identifier of the Account Number the Inbound Check Deposit will be against.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!attribute amount
+        #   The check amount in cents.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute check_number
+        #   The check number on the check to be deposited.
+        #
+        #   @return [String]
+        required :check_number, String
+
+        # @!method initialize(account_number_id:, amount:, check_number:, request_options: {})
+        #   @param account_number_id [String] The identifier of the Account Number the Inbound Check Deposit will be against.
+        #
+        #   @param amount [Integer] The check amount in cents.
+        #
+        #   @param check_number [String] The check number on the check to be deposited.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/inbound_funds_hold_release_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundFundsHolds#release
+      class InboundFundsHoldReleaseParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/inbound_funds_hold_release_response.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundFundsHolds#release
+      class InboundFundsHoldReleaseResponse < Increase::Internal::Type::BaseModel
+        # @!attribute id
+        #   The Inbound Funds Hold identifier.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #   The held amount in the minor unit of the account's currency. For dollars, for
+        #   example, this is cents.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute automatically_releases_at
+        #   When the hold will be released automatically. Certain conditions may cause it to
+        #   be released before this time.
+        #
+        #   @return [Time]
+        required :automatically_releases_at, Time
+
+        # @!attribute created_at
+        #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
+        #   was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute currency
+        #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
+        #   currency.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency]
+        required :currency, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency }
+
+        # @!attribute held_transaction_id
+        #   The ID of the Transaction for which funds were held.
+        #
+        #   @return [String, nil]
+        required :held_transaction_id, String, nil?: true
+
+        # @!attribute pending_transaction_id
+        #   The ID of the Pending Transaction representing the held funds.
+        #
+        #   @return [String, nil]
+        required :pending_transaction_id, String, nil?: true
+
+        # @!attribute released_at
+        #   When the hold was released (if it has been released).
+        #
+        #   @return [Time, nil]
+        required :released_at, Time, nil?: true
+
+        # @!attribute status
+        #   The status of the hold.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status]
+        required :status, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status }
+
+        # @!attribute type
+        #   A constant representing the object's type. For this resource it will always be
+        #   `inbound_funds_hold`.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type]
+        required :type, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type }
+
+        # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundFundsHoldReleaseResponse} for more
+        #   details.
+        #
+        #   We hold funds for certain transaction types to account for return windows where
+        #   funds might still be clawed back by the sending institution.
+        #
+        #   @param id [String] The Inbound Funds Hold identifier.
+        #
+        #   @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex
+        #
+        #   @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to
+        #
+        #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa
+        #
+        #   @param currency [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre
+        #
+        #   @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held.
+        #
+        #   @param pending_transaction_id [String, nil] The ID of the Pending Transaction representing the held funds.
+        #
+        #   @param released_at [Time, nil] When the hold was released (if it has been released).
+        #
+        #   @param status [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status] The status of the hold.
+        #
+        #   @param type [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type] A constant representing the object's type. For this resource it will always be `
+
+        # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
+        # currency.
+        #
+        # @see Increase::Models::Simulations::InboundFundsHoldReleaseResponse#currency
+        module Currency
+          extend Increase::Internal::Type::Enum
+
+          # Canadian Dollar (CAD)
+          CAD = :CAD
+
+          # Swiss Franc (CHF)
+          CHF = :CHF
+
+          # Euro (EUR)
+          EUR = :EUR
+
+          # British Pound (GBP)
+          GBP = :GBP
+
+          # Japanese Yen (JPY)
+          JPY = :JPY
+
+          # US Dollar (USD)
+          USD = :USD
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the hold.
+        #
+        # @see Increase::Models::Simulations::InboundFundsHoldReleaseResponse#status
+        module Status
+          extend Increase::Internal::Type::Enum
+
+          # Funds are still being held.
+          HELD = :held
+
+          # Funds have been released.
+          COMPLETE = :complete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # A constant representing the object's type. For this resource it will always be
+        # `inbound_funds_hold`.
+        #
+        # @see Increase::Models::Simulations::InboundFundsHoldReleaseResponse#type
+        module Type
+          extend Increase::Internal::Type::Enum
+
+          INBOUND_FUNDS_HOLD = :inbound_funds_hold
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/inbound_mail_item_create_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundMailItems#create
+      class InboundMailItemCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute amount
+        #   The amount of the check to be simulated, in cents.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute lockbox_id
+        #   The identifier of the Lockbox to simulate inbound mail to.
+        #
+        #   @return [String]
+        required :lockbox_id, String
+
+        # @!attribute contents_file_id
+        #   The file containing the PDF contents. If not present, a default check image file
+        #   will be used.
+        #
+        #   @return [String, nil]
+        optional :contents_file_id, String
+
+        # @!method initialize(amount:, lockbox_id:, contents_file_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
+        #
+        #   @param amount [Integer] The amount of the check to be simulated, in cents.
+        #
+        #   @param lockbox_id [String] The identifier of the Lockbox to simulate inbound mail to.
+        #
+        #   @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundRealTimePaymentsTransfers#create
+      class InboundRealTimePaymentsTransferCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_number_id
+        #   The identifier of the Account Number the inbound Real-Time Payments Transfer is
+        #   for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!attribute amount
+        #   The transfer amount in USD cents. Must be positive.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute debtor_account_number
+        #   The account number of the account that sent the transfer.
+        #
+        #   @return [String, nil]
+        optional :debtor_account_number, String
+
+        # @!attribute debtor_name
+        #   The name provided by the sender of the transfer.
+        #
+        #   @return [String, nil]
+        optional :debtor_name, String
+
+        # @!attribute debtor_routing_number
+        #   The routing number of the account that sent the transfer.
+        #
+        #   @return [String, nil]
+        optional :debtor_routing_number, String
+
+        # @!attribute remittance_information
+        #   Additional information included with the transfer.
+        #
+        #   @return [String, nil]
+        optional :remittance_information, String
+
+        # @!attribute request_for_payment_id
+        #   The identifier of a pending Request for Payment that this transfer will fulfill.
+        #
+        #   @return [String, nil]
+        optional :request_for_payment_id, String
+
+        # @!method initialize(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, remittance_information: nil, request_for_payment_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundRealTimePaymentsTransferCreateParams} for
+        #   more details.
+        #
+        #   @param account_number_id [String] The identifier of the Account Number the inbound Real-Time Payments Transfer is
+        #
+        #   @param amount [Integer] The transfer amount in USD cents. Must be positive.
+        #
+        #   @param debtor_account_number [String] The account number of the account that sent the transfer.
+        #
+        #   @param debtor_name [String] The name provided by the sender of the transfer.
+        #
+        #   @param debtor_routing_number [String] The routing number of the account that sent the transfer.
+        #
+        #   @param remittance_information [String] Additional information included with the transfer.
+        #
+        #   @param request_for_payment_id [String] The identifier of a pending Request for Payment that this transfer will fulfill.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end