increase 1.174.0 → 1.175.0

data/lib/increase/models/swift_transfer_create_params.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::SwiftTransfers#create
+    class SwiftTransferCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The identifier for the account that will send the transfer.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute account_number
+      #   The creditor's account number.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute bank_identification_code
+      #   The bank identification code (BIC) of the creditor. If it ends with the
+      #   three-character branch code, this must be 11 characters long. Otherwise this
+      #   must be 8 characters and the branch code will be assumed to be `XXX`.
+      #
+      #   @return [String]
+      required :bank_identification_code, String
+
+      # @!attribute creditor_address
+      #   The creditor's address.
+      #
+      #   @return [Increase::Models::SwiftTransferCreateParams::CreditorAddress]
+      required :creditor_address, -> { Increase::SwiftTransferCreateParams::CreditorAddress }
+
+      # @!attribute creditor_name
+      #   The creditor's name.
+      #
+      #   @return [String]
+      required :creditor_name, String
+
+      # @!attribute debtor_address
+      #   The debtor's address.
+      #
+      #   @return [Increase::Models::SwiftTransferCreateParams::DebtorAddress]
+      required :debtor_address, -> { Increase::SwiftTransferCreateParams::DebtorAddress }
+
+      # @!attribute debtor_name
+      #   The debtor's name.
+      #
+      #   @return [String]
+      required :debtor_name, String
+
+      # @!attribute instructed_amount
+      #   The amount, in minor units of `instructed_currency`, to send to the creditor.
+      #
+      #   @return [Integer]
+      required :instructed_amount, Integer
+
+      # @!attribute instructed_currency
+      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
+      #   instructed amount.
+      #
+      #   @return [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency]
+      required :instructed_currency, enum: -> { Increase::SwiftTransferCreateParams::InstructedCurrency }
+
+      # @!attribute source_account_number_id
+      #   The Account Number to include in the transfer as the debtor's account number.
+      #
+      #   @return [String]
+      required :source_account_number_id, String
+
+      # @!attribute unstructured_remittance_information
+      #   Unstructured remittance information to include in the transfer.
+      #
+      #   @return [String]
+      required :unstructured_remittance_information, String
+
+      # @!attribute require_approval
+      #   Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      #   @return [Boolean, nil]
+      optional :require_approval, Increase::Internal::Type::Boolean
+
+      # @!attribute routing_number
+      #   The creditor's bank account routing or transit number. Required in certain
+      #   countries.
+      #
+      #   @return [String, nil]
+      optional :routing_number, String
+
+      # @!method initialize(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, require_approval: nil, routing_number: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::SwiftTransferCreateParams} for more details.
+      #
+      #   @param account_id [String] The identifier for the account that will send the transfer.
+      #
+      #   @param account_number [String] The creditor's account number.
+      #
+      #   @param bank_identification_code [String] The bank identification code (BIC) of the creditor. If it ends with the three-ch
+      #
+      #   @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress] The creditor's address.
+      #
+      #   @param creditor_name [String] The creditor's name.
+      #
+      #   @param debtor_address [Increase::Models::SwiftTransferCreateParams::DebtorAddress] The debtor's address.
+      #
+      #   @param debtor_name [String] The debtor's name.
+      #
+      #   @param instructed_amount [Integer] The amount, in minor units of `instructed_currency`, to send to the creditor.
+      #
+      #   @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the inst
+      #
+      #   @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
+      #
+      #   @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
+      #
+      #   @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      #   @param routing_number [String] The creditor's bank account routing or transit number. Required in certain count
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreditorAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city, district, town, or village of the address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute country
+        #   The two-letter
+        #   [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
+        #   the country of the address.
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute line1
+        #   The first line of the address. This is usually the street number and street.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of the address. This might be the floor or room number.
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!attribute postal_code
+        #   The ZIP or postal code of the address. Required in certain countries.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String
+
+        # @!attribute state
+        #   The state, province, or region of the address. Required in certain countries.
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::SwiftTransferCreateParams::CreditorAddress} for more details.
+        #
+        #   The creditor's address.
+        #
+        #   @param city [String] The city, district, town, or village of the address.
+        #
+        #   @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
+        #
+        #   @param line1 [String] The first line of the address. This is usually the street number and street.
+        #
+        #   @param line2 [String] The second line of the address. This might be the floor or room number.
+        #
+        #   @param postal_code [String] The ZIP or postal code of the address. Required in certain countries.
+        #
+        #   @param state [String] The state, province, or region of the address. Required in certain countries.
+      end
+
+      class DebtorAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city, district, town, or village of the address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute country
+        #   The two-letter
+        #   [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
+        #   the country of the address.
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute line1
+        #   The first line of the address. This is usually the street number and street.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of the address. This might be the floor or room number.
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!attribute postal_code
+        #   The ZIP or postal code of the address. Required in certain countries.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String
+
+        # @!attribute state
+        #   The state, province, or region of the address. Required in certain countries.
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::SwiftTransferCreateParams::DebtorAddress} for more details.
+        #
+        #   The debtor's address.
+        #
+        #   @param city [String] The city, district, town, or village of the address.
+        #
+        #   @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
+        #
+        #   @param line1 [String] The first line of the address. This is usually the street number and street.
+        #
+        #   @param line2 [String] The second line of the address. This might be the floor or room number.
+        #
+        #   @param postal_code [String] The ZIP or postal code of the address. Required in certain countries.
+        #
+        #   @param state [String] The state, province, or region of the address. Required in certain countries.
+      end
+
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
+      # instructed amount.
+      module InstructedCurrency
+        extend Increase::Internal::Type::Enum
+
+        # United States Dollar
+        USD = :USD
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/swift_transfer_list_params.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::SwiftTransfers#list
+    class SwiftTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Swift Transfers to those that originated from the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::SwiftTransferListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::SwiftTransferListParams::CreatedAt }
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute idempotency_key
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that object. This value is unique across Increase and is used to ensure that a
+      #   request is only processed once. Learn more about
+      #   [idempotency](https://increase.com/documentation/idempotency-keys).
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::SwiftTransferListParams::Status, nil]
+      optional :status, -> { Increase::SwiftTransferListParams::Status }
+
+      # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::SwiftTransferListParams} for more details.
+      #
+      #   @param account_id [String] Filter Swift Transfers to those that originated from the specified Account.
+      #
+      #   @param created_at [Increase::Models::SwiftTransferListParams::CreatedAt]
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param status [Increase::Models::SwiftTransferListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::SwiftTransferListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Return results whose value is in the provided list. For GET requests, this
+        #   should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::SwiftTransferListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::SwiftTransferListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::SwiftTransferListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::SwiftTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The transfer is pending approval.
+          PENDING_APPROVAL = :pending_approval
+
+          # The transfer has been canceled.
+          CANCELED = :canceled
+
+          # The transfer is pending review by Increase.
+          PENDING_REVIEWING = :pending_reviewing
+
+          # The transfer requires attention from an Increase operator.
+          REQUIRES_ATTENTION = :requires_attention
+
+          # The transfer is pending initiation.
+          PENDING_INITIATING = :pending_initiating
+
+          # The transfer has been initiated.
+          INITIATED = :initiated
+
+          # The transfer has been rejected by Increase.
+          REJECTED = :rejected
+
+          # The transfer has been returned.
+          RETURNED = :returned
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/swift_transfer_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::SwiftTransfers#retrieve
+    class SwiftTransferRetrieveParams < 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

data/lib/increase/models.rb

@@ -509,6 +509,18 @@ module Increase
 
   SupplementalDocumentListParams = Increase::Models::SupplementalDocumentListParams
 
+  SwiftTransfer = Increase::Models::SwiftTransfer
+
+  SwiftTransferApproveParams = Increase::Models::SwiftTransferApproveParams
+
+  SwiftTransferCancelParams = Increase::Models::SwiftTransferCancelParams
+
+  SwiftTransferCreateParams = Increase::Models::SwiftTransferCreateParams
+
+  SwiftTransferListParams = Increase::Models::SwiftTransferListParams
+
+  SwiftTransferRetrieveParams = Increase::Models::SwiftTransferRetrieveParams
+
   Transaction = Increase::Models::Transaction
 
   TransactionListParams = Increase::Models::TransactionListParams

data/lib/increase/resources/swift_transfers.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class SwiftTransfers
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::SwiftTransferCreateParams} for more details.
+      #
+      # Create a Swift Transfer
+      #
+      # @overload create(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, require_approval: nil, routing_number: nil, request_options: {})
+      #
+      # @param account_id [String] The identifier for the account that will send the transfer.
+      #
+      # @param account_number [String] The creditor's account number.
+      #
+      # @param bank_identification_code [String] The bank identification code (BIC) of the creditor. If it ends with the three-ch
+      #
+      # @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress] The creditor's address.
+      #
+      # @param creditor_name [String] The creditor's name.
+      #
+      # @param debtor_address [Increase::Models::SwiftTransferCreateParams::DebtorAddress] The debtor's address.
+      #
+      # @param debtor_name [String] The debtor's name.
+      #
+      # @param instructed_amount [Integer] The amount, in minor units of `instructed_currency`, to send to the creditor.
+      #
+      # @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the inst
+      #
+      # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
+      #
+      # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
+      #
+      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      # @param routing_number [String] The creditor's bank account routing or transit number. Required in certain count
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::SwiftTransfer]
+      #
+      # @see Increase::Models::SwiftTransferCreateParams
+      def create(params)
+        parsed, options = Increase::SwiftTransferCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "swift_transfers",
+          body: parsed,
+          model: Increase::SwiftTransfer,
+          options: options
+        )
+      end
+
+      # Retrieve a Swift Transfer
+      #
+      # @overload retrieve(swift_transfer_id, request_options: {})
+      #
+      # @param swift_transfer_id [String] The identifier of the Swift Transfer.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::SwiftTransfer]
+      #
+      # @see Increase::Models::SwiftTransferRetrieveParams
+      def retrieve(swift_transfer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["swift_transfers/%1$s", swift_transfer_id],
+          model: Increase::SwiftTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::SwiftTransferListParams} for more details.
+      #
+      # List Swift Transfers
+      #
+      # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Swift Transfers to those that originated from the specified Account.
+      #
+      # @param created_at [Increase::Models::SwiftTransferListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param status [Increase::Models::SwiftTransferListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::SwiftTransfer>]
+      #
+      # @see Increase::Models::SwiftTransferListParams
+      def list(params = {})
+        parsed, options = Increase::SwiftTransferListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "swift_transfers",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::SwiftTransfer,
+          options: options
+        )
+      end
+
+      # Approve a Swift Transfer
+      #
+      # @overload approve(swift_transfer_id, request_options: {})
+      #
+      # @param swift_transfer_id [String] The identifier of the Swift Transfer to approve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::SwiftTransfer]
+      #
+      # @see Increase::Models::SwiftTransferApproveParams
+      def approve(swift_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["swift_transfers/%1$s/approve", swift_transfer_id],
+          model: Increase::SwiftTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Cancel a pending Swift Transfer
+      #
+      # @overload cancel(swift_transfer_id, request_options: {})
+      #
+      # @param swift_transfer_id [String] The identifier of the pending Swift Transfer to cancel.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::SwiftTransfer]
+      #
+      # @see Increase::Models::SwiftTransferCancelParams
+      def cancel(swift_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["swift_transfers/%1$s/cancel", swift_transfer_id],
+          model: Increase::SwiftTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.174.0"
+  VERSION = "1.175.0"
 end

data/lib/increase.rb

@@ -329,6 +329,12 @@ require_relative "increase/models/simulations/wire_transfer_reverse_params"
 require_relative "increase/models/simulations/wire_transfer_submit_params"
 require_relative "increase/models/supplemental_document_create_params"
 require_relative "increase/models/supplemental_document_list_params"
+require_relative "increase/models/swift_transfer"
+require_relative "increase/models/swift_transfer_approve_params"
+require_relative "increase/models/swift_transfer_cancel_params"
+require_relative "increase/models/swift_transfer_create_params"
+require_relative "increase/models/swift_transfer_list_params"
+require_relative "increase/models/swift_transfer_retrieve_params"
 require_relative "increase/models/transaction"
 require_relative "increase/models/transaction_list_params"
 require_relative "increase/models/transaction_retrieve_params"
@@ -427,6 +433,7 @@ require_relative "increase/resources/simulations/real_time_payments_transfers"
 require_relative "increase/resources/simulations/wire_drawdown_requests"
 require_relative "increase/resources/simulations/wire_transfers"
 require_relative "increase/resources/supplemental_documents"
+require_relative "increase/resources/swift_transfers"
 require_relative "increase/resources/transactions"
 require_relative "increase/resources/wire_drawdown_requests"
 require_relative "increase/resources/wire_transfers"

data/rbi/increase/client.rbi

@@ -103,6 +103,9 @@ module Increase
     sig { returns(Increase::Resources::InboundFednowTransfers) }
     attr_reader :inbound_fednow_transfers
 
+    sig { returns(Increase::Resources::SwiftTransfers) }
+    attr_reader :swift_transfers
+
     sig { returns(Increase::Resources::CheckDeposits) }
     attr_reader :check_deposits