increase 1.33.0 → 1.35.0

data/lib/increase/models/card_push_transfer_approve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardPushTransfers#approve
+    class CardPushTransferApproveParams < 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/card_push_transfer_cancel_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardPushTransfers#cancel
+    class CardPushTransferCancelParams < 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/card_push_transfer_create_params.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardPushTransfers#create
+    class CardPushTransferCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute amount
+      #   The transfer amount in USD cents. For Card Push transfers, must be positive.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute business_application_identifier
+      #   The Business Application Identifier describes the type of transaction being
+      #   performed. Your program must be approved for the specified Business Application
+      #   Identifier in order to use it.
+      #
+      #   @return [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier]
+      required :business_application_identifier,
+               enum: -> { Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier }
+
+      # @!attribute card_token_id
+      #   The Increase identifier for the Card Token that represents the card number
+      #   you're pushing funds to.
+      #
+      #   @return [String]
+      required :card_token_id, String
+
+      # @!attribute merchant_category_code
+      #   The merchant category code (MCC) of the merchant (generally your business)
+      #   sending the transfer. This is a four-digit code that describes the type of
+      #   business or service provided by the merchant. Your program must be approved for
+      #   the specified MCC in order to use it.
+      #
+      #   @return [String]
+      required :merchant_category_code, String
+
+      # @!attribute merchant_city_name
+      #   The city name of the merchant (generally your business) sending the transfer.
+      #
+      #   @return [String]
+      required :merchant_city_name, String
+
+      # @!attribute merchant_name
+      #   The merchant name shows up as the statement descriptor for the transfer. This is
+      #   typically the name of your business or organization.
+      #
+      #   @return [String]
+      required :merchant_name, String
+
+      # @!attribute merchant_name_prefix
+      #   For certain Business Application Identifiers, the statement descriptor is
+      #   `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to
+      #   four character prefix that identifies the merchant.
+      #
+      #   @return [String]
+      required :merchant_name_prefix, String
+
+      # @!attribute merchant_postal_code
+      #   The postal code of the merchant (generally your business) sending the transfer.
+      #
+      #   @return [String]
+      required :merchant_postal_code, String
+
+      # @!attribute merchant_state
+      #   The state of the merchant (generally your business) sending the transfer.
+      #
+      #   @return [String]
+      required :merchant_state, String
+
+      # @!attribute recipient_name
+      #   The name of the funds recipient.
+      #
+      #   @return [String]
+      required :recipient_name, String
+
+      # @!attribute sender_address_city
+      #   The city of the sender.
+      #
+      #   @return [String]
+      required :sender_address_city, String
+
+      # @!attribute sender_address_line1
+      #   The address line 1 of the sender.
+      #
+      #   @return [String]
+      required :sender_address_line1, String
+
+      # @!attribute sender_address_postal_code
+      #   The postal code of the sender.
+      #
+      #   @return [String]
+      required :sender_address_postal_code, String
+
+      # @!attribute sender_address_state
+      #   The state of the sender.
+      #
+      #   @return [String]
+      required :sender_address_state, String
+
+      # @!attribute sender_name
+      #   The name of the funds originator.
+      #
+      #   @return [String]
+      required :sender_name, String
+
+      # @!attribute source_account_number_id
+      #   The identifier of the Account Number from which to send the transfer.
+      #
+      #   @return [String]
+      required :source_account_number_id, 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
+
+      # @!method initialize(amount:, business_application_identifier:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, require_approval: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardPushTransferCreateParams} for more details.
+      #
+      #   @param amount [Integer] The transfer amount in USD cents. For Card Push transfers, must be positive.
+      #
+      #   @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier] The Business Application Identifier describes the type of transaction being perf
+      #
+      #   @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
+      #
+      #   @param merchant_category_code [String] The merchant category code (MCC) of the merchant (generally your business) sendi
+      #
+      #   @param merchant_city_name [String] The city name of the merchant (generally your business) sending the transfer.
+      #
+      #   @param merchant_name [String] The merchant name shows up as the statement descriptor for the transfer. This is
+      #
+      #   @param merchant_name_prefix [String] For certain Business Application Identifiers, the statement descriptor is `merch
+      #
+      #   @param merchant_postal_code [String] The postal code of the merchant (generally your business) sending the transfer.
+      #
+      #   @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
+      #
+      #   @param recipient_name [String] The name of the funds recipient.
+      #
+      #   @param sender_address_city [String] The city of the sender.
+      #
+      #   @param sender_address_line1 [String] The address line 1 of the sender.
+      #
+      #   @param sender_address_postal_code [String] The postal code of the sender.
+      #
+      #   @param sender_address_state [String] The state of the sender.
+      #
+      #   @param sender_name [String] The name of the funds originator.
+      #
+      #   @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer.
+      #
+      #   @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The Business Application Identifier describes the type of transaction being
+      # performed. Your program must be approved for the specified Business Application
+      # Identifier in order to use it.
+      module BusinessApplicationIdentifier
+        extend Increase::Internal::Type::Enum
+
+        # Account to Account
+        ACCOUNT_TO_ACCOUNT = :account_to_account
+
+        # Business to Business
+        BUSINESS_TO_BUSINESS = :business_to_business
+
+        # Money Transfer Bank Initiated
+        MONEY_TRANSFER_BANK_INITIATED = :money_transfer_bank_initiated
+
+        # Non-Card Bill Payment
+        NON_CARD_BILL_PAYMENT = :non_card_bill_payment
+
+        # Consumer Bill Payment
+        CONSUMER_BILL_PAYMENT = :consumer_bill_payment
+
+        # Card Bill Payment
+        CARD_BILL_PAYMENT = :card_bill_payment
+
+        # Funds Disbursement
+        FUNDS_DISBURSEMENT = :funds_disbursement
+
+        # Funds Transfer
+        FUNDS_TRANSFER = :funds_transfer
+
+        # Loyalty and Offers
+        LOYALTY_AND_OFFERS = :loyalty_and_offers
+
+        # Merchant Disbursement
+        MERCHANT_DISBURSEMENT = :merchant_disbursement
+
+        # Merchant Payment
+        MERCHANT_PAYMENT = :merchant_payment
+
+        # Person to Person
+        PERSON_TO_PERSON = :person_to_person
+
+        # Top Up
+        TOP_UP = :top_up
+
+        # Wallet Transfer
+        WALLET_TRANSFER = :wallet_transfer
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/card_push_transfer_list_params.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardPushTransfers#list
+    class CardPushTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Card Push Transfers to ones belonging to the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::CardPushTransferListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::CardPushTransferListParams::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::CardPushTransferListParams::Status, nil]
+      optional :status, -> { Increase::CardPushTransferListParams::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::CardPushTransferListParams} for more details.
+      #
+      #   @param account_id [String] Filter Card Push Transfers to ones belonging to the specified Account.
+      #
+      #   @param created_at [Increase::Models::CardPushTransferListParams::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::CardPushTransferListParams::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::CardPushTransferListParams::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_
+        #   Filter Card Push Transfers by status. For GET requests, this should be encoded
+        #   as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::CardPushTransferListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::CardPushTransferListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::CardPushTransferListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::CardPushTransferListParams::Status::In>] Filter Card Push Transfers by status. For GET requests, this should be encoded a
+
+        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 queued to be submitted to the card network.
+          PENDING_SUBMISSION = :pending_submission
+
+          # The transfer has been submitted and is pending a response from the card network.
+          SUBMITTED = :submitted
+
+          # The transfer has been sent successfully and is complete.
+          COMPLETE = :complete
+
+          # The transfer was declined by the network or the recipient's bank.
+          DECLINED = :declined
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/card_push_transfer_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardPushTransfers#retrieve
+    class CardPushTransferRetrieveParams < 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/card_token.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardTokens#retrieve
+    class CardToken < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Card Token's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the card token was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute expiration_date
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the card
+      #   expires.
+      #
+      #   @return [Date]
+      required :expiration_date, Date
+
+      # @!attribute last4
+      #   The last 4 digits of the card number.
+      #
+      #   @return [String]
+      required :last4, String
+
+      # @!attribute length
+      #   The length of the card number.
+      #
+      #   @return [Integer]
+      required :length, Integer
+
+      # @!attribute prefix
+      #   The prefix of the card number, usually 8 digits.
+      #
+      #   @return [String]
+      required :prefix, String
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `card_token`.
+      #
+      #   @return [Symbol, Increase::Models::CardToken::Type]
+      required :type, enum: -> { Increase::CardToken::Type }
+
+      # @!method initialize(id:, created_at:, expiration_date:, last4:, length:, prefix:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardToken} for more details.
+      #
+      #   Card Tokens represent a tokenized card number that can be used for Card Push
+      #   Transfers and Card Validations.
+      #
+      #   @param id [String] The Card Token's identifier.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param expiration_date [Date] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the card expire
+      #
+      #   @param last4 [String] The last 4 digits of the card number.
+      #
+      #   @param length [Integer] The length of the card number.
+      #
+      #   @param prefix [String] The prefix of the card number, usually 8 digits.
+      #
+      #   @param type [Symbol, Increase::Models::CardToken::Type] A constant representing the object's type. For this resource it will always be `
+
+      # A constant representing the object's type. For this resource it will always be
+      # `card_token`.
+      #
+      # @see Increase::Models::CardToken#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CARD_TOKEN = :card_token
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/card_token_capabilities.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardTokens#capabilities
+    class CardTokenCapabilities < Increase::Internal::Type::BaseModel
+      # @!attribute routes
+      #   Each route represent a path e.g., a push transfer can take.
+      #
+      #   @return [Array<Increase::Models::CardTokenCapabilities::Route>]
+      required :routes, -> { Increase::Internal::Type::ArrayOf[Increase::CardTokenCapabilities::Route] }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `card_token_capabilities`.
+      #
+      #   @return [Symbol, Increase::Models::CardTokenCapabilities::Type]
+      required :type, enum: -> { Increase::CardTokenCapabilities::Type }
+
+      # @!method initialize(routes:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardTokenCapabilities} for more details.
+      #
+      #   The capabilities of a Card Token describe whether the card can be used for
+      #   specific operations, such as Card Push Transfers. The capabilities can change
+      #   over time based on the issuing bank's configuration of the card range.
+      #
+      #   @param routes [Array<Increase::Models::CardTokenCapabilities::Route>] Each route represent a path e.g., a push transfer can take.
+      #
+      #   @param type [Symbol, Increase::Models::CardTokenCapabilities::Type] A constant representing the object's type. For this resource it will always be `
+
+      class Route < Increase::Internal::Type::BaseModel
+        # @!attribute cross_border_push_transfers
+        #   Whether you can push funds to the card using cross-border Card Push Transfers.
+        #
+        #   @return [Symbol, Increase::Models::CardTokenCapabilities::Route::CrossBorderPushTransfers]
+        required :cross_border_push_transfers,
+                 enum: -> { Increase::CardTokenCapabilities::Route::CrossBorderPushTransfers }
+
+        # @!attribute domestic_push_transfers
+        #   Whether you can push funds to the card using domestic Card Push Transfers.
+        #
+        #   @return [Symbol, Increase::Models::CardTokenCapabilities::Route::DomesticPushTransfers]
+        required :domestic_push_transfers,
+                 enum: -> { Increase::CardTokenCapabilities::Route::DomesticPushTransfers }
+
+        # @!attribute route
+        #   The card network route the capabilities apply to.
+        #
+        #   @return [Symbol, Increase::Models::CardTokenCapabilities::Route::Route]
+        required :route, enum: -> { Increase::CardTokenCapabilities::Route::Route }
+
+        # @!method initialize(cross_border_push_transfers:, domestic_push_transfers:, route:)
+        #   @param cross_border_push_transfers [Symbol, Increase::Models::CardTokenCapabilities::Route::CrossBorderPushTransfers] Whether you can push funds to the card using cross-border Card Push Transfers.
+        #
+        #   @param domestic_push_transfers [Symbol, Increase::Models::CardTokenCapabilities::Route::DomesticPushTransfers] Whether you can push funds to the card using domestic Card Push Transfers.
+        #
+        #   @param route [Symbol, Increase::Models::CardTokenCapabilities::Route::Route] The card network route the capabilities apply to.
+
+        # Whether you can push funds to the card using cross-border Card Push Transfers.
+        #
+        # @see Increase::Models::CardTokenCapabilities::Route#cross_border_push_transfers
+        module CrossBorderPushTransfers
+          extend Increase::Internal::Type::Enum
+
+          # The capability is supported.
+          SUPPORTED = :supported
+
+          # The capability is not supported.
+          NOT_SUPPORTED = :not_supported
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether you can push funds to the card using domestic Card Push Transfers.
+        #
+        # @see Increase::Models::CardTokenCapabilities::Route#domestic_push_transfers
+        module DomesticPushTransfers
+          extend Increase::Internal::Type::Enum
+
+          # The capability is supported.
+          SUPPORTED = :supported
+
+          # The capability is not supported.
+          NOT_SUPPORTED = :not_supported
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The card network route the capabilities apply to.
+        #
+        # @see Increase::Models::CardTokenCapabilities::Route#route
+        module Route
+          extend Increase::Internal::Type::Enum
+
+          # Visa and Interlink
+          VISA = :visa
+
+          # Mastercard and Maestro
+          MASTERCARD = :mastercard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `card_token_capabilities`.
+      #
+      # @see Increase::Models::CardTokenCapabilities#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CARD_TOKEN_CAPABILITIES = :card_token_capabilities
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/card_token_capabilities_params.rb

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