increase 1.304.0 → 1.305.0

data/rbi/increase/models/lockbox_recipient_list_params.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxRecipientListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::LockboxRecipientListParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # Filter Lockbox Recipients to those associated with the provided 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::LockboxRecipientListParams::CreatedAt))
+      end
+      attr_reader :created_at
+
+      sig do
+        params(
+          created_at: Increase::LockboxRecipientListParams::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
+
+      # Filter Lockbox Recipients to those associated with the provided Lockbox Address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :lockbox_address_id
+
+      sig { params(lockbox_address_id: String).void }
+      attr_writer :lockbox_address_id
+
+      sig do
+        params(
+          account_id: String,
+          created_at: Increase::LockboxRecipientListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          lockbox_address_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter Lockbox Recipients to those associated with the provided 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,
+        # Filter Lockbox Recipients to those associated with the provided Lockbox Address.
+        lockbox_address_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            created_at: Increase::LockboxRecipientListParams::CreatedAt,
+            cursor: String,
+            idempotency_key: String,
+            limit: Integer,
+            lockbox_address_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::LockboxRecipientListParams::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
+    end
+  end
+end

data/rbi/increase/models/lockbox_recipient_retrieve_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxRecipientRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::LockboxRecipientRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Lockbox Recipient to retrieve.
+      sig { returns(String) }
+      attr_accessor :lockbox_recipient_id
+
+      sig do
+        params(
+          lockbox_recipient_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Lockbox Recipient to retrieve.
+        lockbox_recipient_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            lockbox_recipient_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/lockbox_recipient_update_params.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxRecipientUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::LockboxRecipientUpdateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Lockbox Recipient.
+      sig { returns(String) }
+      attr_accessor :lockbox_recipient_id
+
+      # The description you choose for the Lockbox Recipient.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # The name of the Lockbox Recipient.
+      sig { returns(T.nilable(String)) }
+      attr_reader :recipient_name
+
+      sig { params(recipient_name: String).void }
+      attr_writer :recipient_name
+
+      # The status of the Lockbox Recipient.
+      sig do
+        returns(
+          T.nilable(Increase::LockboxRecipientUpdateParams::Status::OrSymbol)
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: Increase::LockboxRecipientUpdateParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          lockbox_recipient_id: String,
+          description: String,
+          recipient_name: String,
+          status: Increase::LockboxRecipientUpdateParams::Status::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Lockbox Recipient.
+        lockbox_recipient_id:,
+        # The description you choose for the Lockbox Recipient.
+        description: nil,
+        # The name of the Lockbox Recipient.
+        recipient_name: nil,
+        # The status of the Lockbox Recipient.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            lockbox_recipient_id: String,
+            description: String,
+            recipient_name: String,
+            status: Increase::LockboxRecipientUpdateParams::Status::OrSymbol,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the Lockbox Recipient.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Increase::LockboxRecipientUpdateParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # This Lockbox Recipient is active.
+        ACTIVE =
+          T.let(
+            :active,
+            Increase::LockboxRecipientUpdateParams::Status::TaggedSymbol
+          )
+
+        # This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.
+        DISABLED =
+          T.let(
+            :disabled,
+            Increase::LockboxRecipientUpdateParams::Status::TaggedSymbol
+          )
+
+        # This Lockbox Recipient is canceled and cannot be modified. Checks mailed to this Lockbox Recipient will be rejected.
+        CANCELED =
+          T.let(
+            :canceled,
+            Increase::LockboxRecipientUpdateParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Increase::LockboxRecipientUpdateParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/simulations/card_token_create_params.rbi

@@ -301,6 +301,13 @@ module Increase
                 Increase::Simulations::CardTokenCreateParams::Capability::Route::TaggedSymbol
               )
 
+            # Pulse
+            PULSE =
+              T.let(
+                :pulse,
+                Increase::Simulations::CardTokenCreateParams::Capability::Route::TaggedSymbol
+              )
+
             sig do
               override.returns(
                 T::Array[

data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi

@@ -19,10 +19,6 @@ module Increase
         sig { returns(Integer) }
         attr_accessor :amount
 
-        # The identifier of the Lockbox to simulate inbound mail to.
-        sig { returns(String) }
-        attr_accessor :lockbox_id
-
         # The file containing the PDF contents. If not present, a default check image file
         # will be used.
         sig { returns(T.nilable(String)) }
@@ -31,22 +27,39 @@ module Increase
         sig { params(contents_file_id: String).void }
         attr_writer :contents_file_id
 
+        # The identifier of the Lockbox Address to simulate inbound mail to.
+        sig { returns(T.nilable(String)) }
+        attr_reader :lockbox_address_id
+
+        sig { params(lockbox_address_id: String).void }
+        attr_writer :lockbox_address_id
+
+        # The identifier of the Lockbox Recipient to simulate inbound mail to.
+        sig { returns(T.nilable(String)) }
+        attr_reader :lockbox_recipient_id
+
+        sig { params(lockbox_recipient_id: String).void }
+        attr_writer :lockbox_recipient_id
+
         sig do
           params(
             amount: Integer,
-            lockbox_id: String,
             contents_file_id: String,
+            lockbox_address_id: String,
+            lockbox_recipient_id: String,
             request_options: Increase::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           # The amount of the check to be simulated, in cents.
           amount:,
-          # The identifier of the Lockbox to simulate inbound mail to.
-          lockbox_id:,
           # The file containing the PDF contents. If not present, a default check image file
           # will be used.
           contents_file_id: nil,
+          # The identifier of the Lockbox Address to simulate inbound mail to.
+          lockbox_address_id: nil,
+          # The identifier of the Lockbox Recipient to simulate inbound mail to.
+          lockbox_recipient_id: nil,
           request_options: {}
         )
         end
@@ -55,8 +68,9 @@ module Increase
           override.returns(
             {
               amount: Integer,
-              lockbox_id: String,
               contents_file_id: String,
+              lockbox_address_id: String,
+              lockbox_recipient_id: String,
               request_options: Increase::RequestOptions
             }
           )

data/rbi/increase/models.rbi

@@ -418,15 +418,26 @@ module Increase
   IntrafiExclusionRetrieveParams =
     Increase::Models::IntrafiExclusionRetrieveParams
 
-  Lockbox = Increase::Models::Lockbox
+  LockboxAddress = Increase::Models::LockboxAddress
 
-  LockboxCreateParams = Increase::Models::LockboxCreateParams
+  LockboxAddressCreateParams = Increase::Models::LockboxAddressCreateParams
 
-  LockboxListParams = Increase::Models::LockboxListParams
+  LockboxAddressListParams = Increase::Models::LockboxAddressListParams
 
-  LockboxRetrieveParams = Increase::Models::LockboxRetrieveParams
+  LockboxAddressRetrieveParams = Increase::Models::LockboxAddressRetrieveParams
 
-  LockboxUpdateParams = Increase::Models::LockboxUpdateParams
+  LockboxAddressUpdateParams = Increase::Models::LockboxAddressUpdateParams
+
+  LockboxRecipient = Increase::Models::LockboxRecipient
+
+  LockboxRecipientCreateParams = Increase::Models::LockboxRecipientCreateParams
+
+  LockboxRecipientListParams = Increase::Models::LockboxRecipientListParams
+
+  LockboxRecipientRetrieveParams =
+    Increase::Models::LockboxRecipientRetrieveParams
+
+  LockboxRecipientUpdateParams = Increase::Models::LockboxRecipientUpdateParams
 
   OAuthApplication = Increase::Models::OAuthApplication
 

data/rbi/increase/resources/inbound_mail_items.rbi

@@ -23,7 +23,8 @@ module Increase
           created_at: Increase::InboundMailItemListParams::CreatedAt::OrHash,
           cursor: String,
           limit: Integer,
-          lockbox_id: String,
+          lockbox_address_id: String,
+          lockbox_recipient_id: String,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::Internal::Page[Increase::InboundMailItem])
       end
@@ -34,8 +35,10 @@ module Increase
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
         limit: nil,
-        # Filter Inbound Mail Items to ones sent to the provided Lockbox.
-        lockbox_id: nil,
+        # Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
+        lockbox_address_id: nil,
+        # Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
+        lockbox_recipient_id: nil,
         request_options: {}
       )
       end

data/rbi/increase/resources/lockbox_addresses.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class LockboxAddresses
+      # Create a Lockbox Address
+      sig do
+        params(
+          description: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::LockboxAddress)
+      end
+      def create(
+        # The description you choose for the Lockbox Address.
+        description: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Lockbox Address
+      sig do
+        params(
+          lockbox_address_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::LockboxAddress)
+      end
+      def retrieve(
+        # The identifier of the Lockbox Address to retrieve.
+        lockbox_address_id,
+        request_options: {}
+      )
+      end
+
+      # Update a Lockbox Address
+      sig do
+        params(
+          lockbox_address_id: String,
+          description: String,
+          status: Increase::LockboxAddressUpdateParams::Status::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::LockboxAddress)
+      end
+      def update(
+        # The identifier of the Lockbox Address.
+        lockbox_address_id,
+        # The description you choose for the Lockbox Address.
+        description: nil,
+        # The status of the Lockbox Address.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # List Lockbox Addresses
+      sig do
+        params(
+          created_at: Increase::LockboxAddressListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::LockboxAddress])
+      end
+      def list(
+        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,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end