increase 0.3.2 → 1.0.0

data/lib/increase/resources/simulations/card_increments.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CardIncrements
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CardIncrementCreateParams} for more details.
+        #
+        # Simulates the increment of an authorization by a card acquirer. An authorization
+        # can be incremented multiple times.
+        #
+        # @overload create(amount:, card_payment_id:, event_subscription_id: nil, request_options: {})
+        #
+        # @param amount [Integer] The amount of the increment in minor units in the card authorization's currency.
+        #
+        # @param card_payment_id [String] The identifier of the Card Payment to create a increment on.
+        #
+        # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CardPayment]
+        #
+        # @see Increase::Models::Simulations::CardIncrementCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::CardIncrementCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/card_increments",
+            body: parsed,
+            model: Increase::CardPayment,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/card_refunds.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CardRefunds
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CardRefundCreateParams} for more details.
+        #
+        # Simulates refunding a card transaction. The full value of the original sandbox
+        # transaction is refunded.
+        #
+        # @overload create(transaction_id:, request_options: {})
+        #
+        # @param transaction_id [String] The identifier for the Transaction to refund. The Transaction's source must have
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Transaction]
+        #
+        # @see Increase::Models::Simulations::CardRefundCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::CardRefundCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/card_refunds",
+            body: parsed,
+            model: Increase::Transaction,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/card_reversals.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CardReversals
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CardReversalCreateParams} for more details.
+        #
+        # Simulates the reversal of an authorization by a card acquirer. An authorization
+        # can be partially reversed multiple times, up until the total authorized amount.
+        # Marks the pending transaction as complete if the authorization is fully
+        # reversed.
+        #
+        # @overload create(card_payment_id:, amount: nil, request_options: {})
+        #
+        # @param card_payment_id [String] The identifier of the Card Payment to create a reversal on.
+        #
+        # @param amount [Integer] The amount of the reversal in minor units in the card authorization's currency.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CardPayment]
+        #
+        # @see Increase::Models::Simulations::CardReversalCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::CardReversalCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/card_reversals",
+            body: parsed,
+            model: Increase::CardPayment,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/card_settlements.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CardSettlements
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CardSettlementCreateParams} for more details.
+        #
+        # Simulates the settlement of an authorization by a card acquirer. After a card
+        # authorization is created, the merchant will eventually send a settlement. This
+        # simulates that event, which may occur many days after the purchase in
+        # production. The amount settled can be different from the amount originally
+        # authorized, for example, when adding a tip to a restaurant bill.
+        #
+        # @overload create(card_id:, pending_transaction_id:, amount: nil, request_options: {})
+        #
+        # @param card_id [String] The identifier of the Card to create a settlement on.
+        #
+        # @param pending_transaction_id [String] The identifier of the Pending Transaction for the Card Authorization you wish to
+        #
+        # @param amount [Integer] The amount to be settled. This defaults to the amount of the Pending Transaction
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Transaction]
+        #
+        # @see Increase::Models::Simulations::CardSettlementCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::CardSettlementCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/card_settlements",
+            body: parsed,
+            model: Increase::Transaction,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/check_deposits.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CheckDeposits
+        # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
+        # factors like poor image quality. This Check Deposit must first have a `status`
+        # of `pending`.
+        #
+        # @overload reject(check_deposit_id, request_options: {})
+        #
+        # @param check_deposit_id [String] The identifier of the Check Deposit you wish to reject.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CheckDeposit]
+        #
+        # @see Increase::Models::Simulations::CheckDepositRejectParams
+        def reject(check_deposit_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["simulations/check_deposits/%1$s/reject", check_deposit_id],
+            model: Increase::CheckDeposit,
+            options: params[:request_options]
+          )
+        end
+
+        # Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit
+        # must first have a `status` of `submitted`.
+        #
+        # @overload return_(check_deposit_id, request_options: {})
+        #
+        # @param check_deposit_id [String] The identifier of the Check Deposit you wish to return.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CheckDeposit]
+        #
+        # @see Increase::Models::Simulations::CheckDepositReturnParams
+        def return_(check_deposit_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["simulations/check_deposits/%1$s/return", check_deposit_id],
+            model: Increase::CheckDeposit,
+            options: params[:request_options]
+          )
+        end
+
+        # Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
+        # Reserve. This Check Deposit must first have a `status` of `pending`.
+        #
+        # @overload submit(check_deposit_id, request_options: {})
+        #
+        # @param check_deposit_id [String] The identifier of the Check Deposit you wish to submit.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CheckDeposit]
+        #
+        # @see Increase::Models::Simulations::CheckDepositSubmitParams
+        def submit(check_deposit_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["simulations/check_deposits/%1$s/submit", check_deposit_id],
+            model: Increase::CheckDeposit,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/check_transfers.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CheckTransfers
+        # Simulates the mailing of a [Check Transfer](#check-transfers), which happens
+        # periodically throughout the day in production but can be sped up in sandbox.
+        # This transfer must first have a `status` of `pending_approval` or
+        # `pending_submission`.
+        #
+        # @overload mail(check_transfer_id, request_options: {})
+        #
+        # @param check_transfer_id [String] The identifier of the Check Transfer you wish to mail.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CheckTransfer]
+        #
+        # @see Increase::Models::Simulations::CheckTransferMailParams
+        def mail(check_transfer_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["simulations/check_transfers/%1$s/mail", check_transfer_id],
+            model: Increase::CheckTransfer,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/digital_wallet_token_requests.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class DigitalWalletTokenRequests
+        # Simulates a user attempting add a [Card](#cards) to a digital wallet such as
+        # Apple Pay.
+        #
+        # @overload create(card_id:, request_options: {})
+        #
+        # @param card_id [String] The identifier of the Card to be authorized.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse]
+        #
+        # @see Increase::Models::Simulations::DigitalWalletTokenRequestCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::DigitalWalletTokenRequestCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/digital_wallet_token_requests",
+            body: parsed,
+            model: Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/documents.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class Documents
+        # Simulates an tax document being created for an account.
+        #
+        # @overload create(account_id:, request_options: {})
+        #
+        # @param account_id [String] The identifier of the Account the tax document is for.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Document]
+        #
+        # @see Increase::Models::Simulations::DocumentCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::DocumentCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/documents",
+            body: parsed,
+            model: Increase::Document,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/inbound_ach_transfers.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundACHTransfers
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::InboundACHTransferCreateParams} for more
+        # details.
+        #
+        # Simulates an inbound ACH transfer to your account. This imitates initiating a
+        # transfer to an Increase account from a different financial institution. The
+        # transfer may be either a credit or a debit depending on if the `amount` is
+        # positive or negative. The result of calling this API will contain the created
+        # transfer. You can pass a `resolve_at` parameter to allow for a window to
+        # [action on the Inbound ACH Transfer](https://increase.com/documentation/receiving-ach-transfers).
+        # Alternatively, if you don't pass the `resolve_at` parameter the result will
+        # contain either a [Transaction](#transactions) or a
+        # [Declined Transaction](#declined-transactions) depending on whether or not the
+        # transfer is allowed.
+        #
+        # @overload create(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: {})
+        #
+        # @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}, nil]
+        #
+        # @return [Increase::Models::InboundACHTransfer]
+        #
+        # @see Increase::Models::Simulations::InboundACHTransferCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::InboundACHTransferCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/inbound_ach_transfers",
+            body: parsed,
+            model: Increase::InboundACHTransfer,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/inbound_check_deposits.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundCheckDeposits
+        # Simulates an Inbound Check Deposit against your account. This imitates someone
+        # depositing a check at their bank that was issued from your account. It may or
+        # may not be associated with a Check Transfer. Increase will evaluate the Check
+        # Deposit as we would in production and either create a Transaction or a Declined
+        # Transaction as a result. You can inspect the resulting Inbound Check Deposit
+        # object to see the result.
+        #
+        # @overload create(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}, nil]
+        #
+        # @return [Increase::Models::InboundCheckDeposit]
+        #
+        # @see Increase::Models::Simulations::InboundCheckDepositCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::InboundCheckDepositCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/inbound_check_deposits",
+            body: parsed,
+            model: Increase::InboundCheckDeposit,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/inbound_funds_holds.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundFundsHolds
+        # This endpoint simulates immediately releasing an Inbound Funds Hold, which might
+        # be created as a result of e.g., an ACH debit.
+        #
+        # @overload release(inbound_funds_hold_id, request_options: {})
+        #
+        # @param inbound_funds_hold_id [String] The inbound funds hold to release.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Simulations::InboundFundsHoldReleaseResponse]
+        #
+        # @see Increase::Models::Simulations::InboundFundsHoldReleaseParams
+        def release(inbound_funds_hold_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["simulations/inbound_funds_holds/%1$s/release", inbound_funds_hold_id],
+            model: Increase::Models::Simulations::InboundFundsHoldReleaseResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/inbound_mail_items.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundMailItems
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
+        #
+        # Simulates an inbound mail item to your account, as if someone had mailed a
+        # physical check to one of your account's Lockboxes.
+        #
+        # @overload create(amount:, lockbox_id:, contents_file_id: nil, request_options: {})
+        #
+        # @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}, nil]
+        #
+        # @return [Increase::Models::InboundMailItem]
+        #
+        # @see Increase::Models::Simulations::InboundMailItemCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::InboundMailItemCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/inbound_mail_items",
+            body: parsed,
+            model: Increase::InboundMailItem,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundRealTimePaymentsTransfers
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::InboundRealTimePaymentsTransferCreateParams} for
+        # more details.
+        #
+        # Simulates an
+        # [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to
+        # your account. Real-Time Payments are a beta feature.
+        #
+        # @overload create(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: {})
+        #
+        # @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}, nil]
+        #
+        # @return [Increase::Models::InboundRealTimePaymentsTransfer]
+        #
+        # @see Increase::Models::Simulations::InboundRealTimePaymentsTransferCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::InboundRealTimePaymentsTransferCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/inbound_real_time_payments_transfers",
+            body: parsed,
+            model: Increase::InboundRealTimePaymentsTransfer,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end