increase 1.33.0 → 1.35.0

data/rbi/increase/models/card_push_transfer_approve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardPushTransferApproveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardPushTransferApproveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Increase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Increase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/card_push_transfer_cancel_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardPushTransferCancelParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardPushTransferCancelParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Increase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Increase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/card_push_transfer_create_params.rbi

@@ -0,0 +1,325 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardPushTransferCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardPushTransferCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The transfer amount in USD cents. For Card Push transfers, must be positive.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # 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.
+      sig do
+        returns(
+          Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::OrSymbol
+        )
+      end
+      attr_accessor :business_application_identifier
+
+      # The Increase identifier for the Card Token that represents the card number
+      # you're pushing funds to.
+      sig { returns(String) }
+      attr_accessor :card_token_id
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :merchant_category_code
+
+      # The city name of the merchant (generally your business) sending the transfer.
+      sig { returns(String) }
+      attr_accessor :merchant_city_name
+
+      # The merchant name shows up as the statement descriptor for the transfer. This is
+      # typically the name of your business or organization.
+      sig { returns(String) }
+      attr_accessor :merchant_name
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :merchant_name_prefix
+
+      # The postal code of the merchant (generally your business) sending the transfer.
+      sig { returns(String) }
+      attr_accessor :merchant_postal_code
+
+      # The state of the merchant (generally your business) sending the transfer.
+      sig { returns(String) }
+      attr_accessor :merchant_state
+
+      # The name of the funds recipient.
+      sig { returns(String) }
+      attr_accessor :recipient_name
+
+      # The city of the sender.
+      sig { returns(String) }
+      attr_accessor :sender_address_city
+
+      # The address line 1 of the sender.
+      sig { returns(String) }
+      attr_accessor :sender_address_line1
+
+      # The postal code of the sender.
+      sig { returns(String) }
+      attr_accessor :sender_address_postal_code
+
+      # The state of the sender.
+      sig { returns(String) }
+      attr_accessor :sender_address_state
+
+      # The name of the funds originator.
+      sig { returns(String) }
+      attr_accessor :sender_name
+
+      # The identifier of the Account Number from which to send the transfer.
+      sig { returns(String) }
+      attr_accessor :source_account_number_id
+
+      # Whether the transfer requires explicit approval via the dashboard or API.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :require_approval
+
+      sig { params(require_approval: T::Boolean).void }
+      attr_writer :require_approval
+
+      sig do
+        params(
+          amount: Integer,
+          business_application_identifier:
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::OrSymbol,
+          card_token_id: String,
+          merchant_category_code: String,
+          merchant_city_name: String,
+          merchant_name: String,
+          merchant_name_prefix: String,
+          merchant_postal_code: String,
+          merchant_state: String,
+          recipient_name: String,
+          sender_address_city: String,
+          sender_address_line1: String,
+          sender_address_postal_code: String,
+          sender_address_state: String,
+          sender_name: String,
+          source_account_number_id: String,
+          require_approval: T::Boolean,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The transfer amount in USD cents. For Card Push transfers, must be positive.
+        amount:,
+        # 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.
+        business_application_identifier:,
+        # The Increase identifier for the Card Token that represents the card number
+        # you're pushing funds to.
+        card_token_id:,
+        # 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.
+        merchant_category_code:,
+        # The city name of the merchant (generally your business) sending the transfer.
+        merchant_city_name:,
+        # The merchant name shows up as the statement descriptor for the transfer. This is
+        # typically the name of your business or organization.
+        merchant_name:,
+        # 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.
+        merchant_name_prefix:,
+        # The postal code of the merchant (generally your business) sending the transfer.
+        merchant_postal_code:,
+        # The state of the merchant (generally your business) sending the transfer.
+        merchant_state:,
+        # The name of the funds recipient.
+        recipient_name:,
+        # The city of the sender.
+        sender_address_city:,
+        # The address line 1 of the sender.
+        sender_address_line1:,
+        # The postal code of the sender.
+        sender_address_postal_code:,
+        # The state of the sender.
+        sender_address_state:,
+        # The name of the funds originator.
+        sender_name:,
+        # The identifier of the Account Number from which to send the transfer.
+        source_account_number_id:,
+        # Whether the transfer requires explicit approval via the dashboard or API.
+        require_approval: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            amount: Integer,
+            business_application_identifier:
+              Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::OrSymbol,
+            card_token_id: String,
+            merchant_category_code: String,
+            merchant_city_name: String,
+            merchant_name: String,
+            merchant_name_prefix: String,
+            merchant_postal_code: String,
+            merchant_state: String,
+            recipient_name: String,
+            sender_address_city: String,
+            sender_address_line1: String,
+            sender_address_postal_code: String,
+            sender_address_state: String,
+            sender_name: String,
+            source_account_number_id: String,
+            require_approval: T::Boolean,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # 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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # Account to Account
+        ACCOUNT_TO_ACCOUNT =
+          T.let(
+            :account_to_account,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Business to Business
+        BUSINESS_TO_BUSINESS =
+          T.let(
+            :business_to_business,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Money Transfer Bank Initiated
+        MONEY_TRANSFER_BANK_INITIATED =
+          T.let(
+            :money_transfer_bank_initiated,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Non-Card Bill Payment
+        NON_CARD_BILL_PAYMENT =
+          T.let(
+            :non_card_bill_payment,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Consumer Bill Payment
+        CONSUMER_BILL_PAYMENT =
+          T.let(
+            :consumer_bill_payment,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Card Bill Payment
+        CARD_BILL_PAYMENT =
+          T.let(
+            :card_bill_payment,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Funds Disbursement
+        FUNDS_DISBURSEMENT =
+          T.let(
+            :funds_disbursement,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Funds Transfer
+        FUNDS_TRANSFER =
+          T.let(
+            :funds_transfer,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Loyalty and Offers
+        LOYALTY_AND_OFFERS =
+          T.let(
+            :loyalty_and_offers,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Merchant Disbursement
+        MERCHANT_DISBURSEMENT =
+          T.let(
+            :merchant_disbursement,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Merchant Payment
+        MERCHANT_PAYMENT =
+          T.let(
+            :merchant_payment,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Person to Person
+        PERSON_TO_PERSON =
+          T.let(
+            :person_to_person,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Top Up
+        TOP_UP =
+          T.let(
+            :top_up,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        # Wallet Transfer
+        WALLET_TRANSFER =
+          T.let(
+            :wallet_transfer,
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/card_push_transfer_list_params.rbi

@@ -0,0 +1,329 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardPushTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardPushTransferListParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # Filter Card Push Transfers to ones belonging to the specified Account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      sig do
+        returns(T.nilable(Increase::CardPushTransferListParams::CreatedAt))
+      end
+      attr_reader :created_at
+
+      sig do
+        params(
+          created_at: Increase::CardPushTransferListParams::CreatedAt::OrHash
+        ).void
+      end
+      attr_writer :created_at
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # 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).
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig { returns(T.nilable(Increase::CardPushTransferListParams::Status)) }
+      attr_reader :status
+
+      sig do
+        params(
+          status: Increase::CardPushTransferListParams::Status::OrHash
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          account_id: String,
+          created_at: Increase::CardPushTransferListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::CardPushTransferListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter Card Push Transfers to ones belonging to the specified Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # 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).
+        idempotency_key: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            created_at: Increase::CardPushTransferListParams::CreatedAt,
+            cursor: String,
+            idempotency_key: String,
+            limit: Integer,
+            status: Increase::CardPushTransferListParams::Status,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CardPushTransferListParams::CreatedAt,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        # timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :after
+
+        sig { params(after: Time).void }
+        attr_writer :after
+
+        # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        # timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :before
+
+        sig { params(before: Time).void }
+        attr_writer :before
+
+        # Return results on or after this
+        # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :on_or_after
+
+        sig { params(on_or_after: Time).void }
+        attr_writer :on_or_after
+
+        # Return results on or before this
+        # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :on_or_before
+
+        sig { params(on_or_before: Time).void }
+        attr_writer :on_or_before
+
+        sig do
+          params(
+            after: Time,
+            before: Time,
+            on_or_after: Time,
+            on_or_before: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+          # timestamp.
+          after: nil,
+          # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+          # timestamp.
+          before: nil,
+          # Return results on or after this
+          # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+          on_or_after: nil,
+          # Return results on or before this
+          # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+          on_or_before: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CardPushTransferListParams::Status,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter Card Push Transfers by status. For GET requests, this should be encoded
+        # as a comma-delimited string, such as `?in=one,two,three`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Increase::CardPushTransferListParams::Status::In::OrSymbol
+              ]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::CardPushTransferListParams::Status::In::OrSymbol
+              ]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::CardPushTransferListParams::Status::In::OrSymbol
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter Card Push Transfers by status. For GET requests, this should be encoded
+          # as a comma-delimited string, such as `?in=one,two,three`.
+          in_: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              in_:
+                T::Array[
+                  Increase::CardPushTransferListParams::Status::In::OrSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::CardPushTransferListParams::Status::In)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The transfer is pending approval.
+          PENDING_APPROVAL =
+            T.let(
+              :pending_approval,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer has been canceled.
+          CANCELED =
+            T.let(
+              :canceled,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer is pending review by Increase.
+          PENDING_REVIEWING =
+            T.let(
+              :pending_reviewing,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer requires attention from an Increase operator.
+          REQUIRES_ATTENTION =
+            T.let(
+              :requires_attention,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer is queued to be submitted to the card network.
+          PENDING_SUBMISSION =
+            T.let(
+              :pending_submission,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer has been submitted and is pending a response from the card network.
+          SUBMITTED =
+            T.let(
+              :submitted,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer has been sent successfully and is complete.
+          COMPLETE =
+            T.let(
+              :complete,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          # The transfer was declined by the network or the recipient's bank.
+          DECLINED =
+            T.let(
+              :declined,
+              Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::CardPushTransferListParams::Status::In::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end