increase 1.303.0 → 1.305.0

data/rbi/increase/models/lockbox_address.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxAddress < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Increase::LockboxAddress, Increase::Internal::AnyHash)
+        end
+
+      # The Lockbox Address identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The mailing address for the Lockbox Address. It will be present after Increase
+      # generates it.
+      sig { returns(T.nilable(Increase::LockboxAddress::Address)) }
+      attr_reader :address
+
+      sig do
+        params(
+          address: T.nilable(Increase::LockboxAddress::Address::OrHash)
+        ).void
+      end
+      attr_writer :address
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      # Address was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The description you choose for the Lockbox Address.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The idempotency key you chose for this 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_accessor :idempotency_key
+
+      # The status of the Lockbox Address.
+      sig { returns(Increase::LockboxAddress::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_address`.
+      sig { returns(Increase::LockboxAddress::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Lockbox Addresses are physical locations that can receive mail containing paper
+      # checks.
+      sig do
+        params(
+          id: String,
+          address: T.nilable(Increase::LockboxAddress::Address::OrHash),
+          created_at: Time,
+          description: T.nilable(String),
+          idempotency_key: T.nilable(String),
+          status: Increase::LockboxAddress::Status::OrSymbol,
+          type: Increase::LockboxAddress::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Lockbox Address identifier.
+        id:,
+        # The mailing address for the Lockbox Address. It will be present after Increase
+        # generates it.
+        address:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+        # Address was created.
+        created_at:,
+        # The description you choose for the Lockbox Address.
+        description:,
+        # The idempotency key you chose for this 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:,
+        # The status of the Lockbox Address.
+        status:,
+        # A constant representing the object's type. For this resource it will always be
+        # `lockbox_address`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            address: T.nilable(Increase::LockboxAddress::Address),
+            created_at: Time,
+            description: T.nilable(String),
+            idempotency_key: T.nilable(String),
+            status: Increase::LockboxAddress::Status::TaggedSymbol,
+            type: Increase::LockboxAddress::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Address < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::LockboxAddress::Address,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The city of the address.
+        sig { returns(String) }
+        attr_accessor :city
+
+        # The first line of the address.
+        sig { returns(String) }
+        attr_accessor :line1
+
+        # The second line of the address.
+        sig { returns(String) }
+        attr_accessor :line2
+
+        # The postal code of the address.
+        sig { returns(String) }
+        attr_accessor :postal_code
+
+        # The two-letter United States Postal Service (USPS) abbreviation for the state of
+        # the address.
+        sig { returns(String) }
+        attr_accessor :state
+
+        # The mailing address for the Lockbox Address. It will be present after Increase
+        # generates it.
+        sig do
+          params(
+            city: String,
+            line1: String,
+            line2: String,
+            postal_code: String,
+            state: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city of the address.
+          city:,
+          # The first line of the address.
+          line1:,
+          # The second line of the address.
+          line2:,
+          # The postal code of the address.
+          postal_code:,
+          # The two-letter United States Postal Service (USPS) abbreviation for the state of
+          # the address.
+          state:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              city: String,
+              line1: String,
+              line2: String,
+              postal_code: String,
+              state: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The status of the Lockbox Address.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::LockboxAddress::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # Increase is generating this Lockbox Address.
+        PENDING =
+          T.let(:pending, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        # This Lockbox Address is active.
+        ACTIVE = T.let(:active, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        # This Lockbox Address is disabled.
+        DISABLED =
+          T.let(:disabled, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        # This Lockbox Address is permanently disabled.
+        CANCELED =
+          T.let(:canceled, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::LockboxAddress::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_address`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::LockboxAddress::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCKBOX_ADDRESS =
+          T.let(:lockbox_address, Increase::LockboxAddress::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::LockboxAddress::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/lockbox_address_create_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxAddressCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::LockboxAddressCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The description you choose for the Lockbox Address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      sig do
+        params(
+          description: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The description you choose for the Lockbox Address.
+        description: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { description: String, request_options: Increase::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/{lockbox_list_params.rbi → lockbox_address_list_params.rbi}

@@ -2,27 +2,22 @@
 
 module Increase
   module Models
-    class LockboxListParams < Increase::Internal::Type::BaseModel
+    class LockboxAddressListParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
-          T.any(Increase::LockboxListParams, Increase::Internal::AnyHash)
+          T.any(Increase::LockboxAddressListParams, Increase::Internal::AnyHash)
         end
 
-      # Filter Lockboxes 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 { returns(T.nilable(Increase::LockboxListParams::CreatedAt)) }
+      sig { returns(T.nilable(Increase::LockboxAddressListParams::CreatedAt)) }
       attr_reader :created_at
 
       sig do
-        params(created_at: Increase::LockboxListParams::CreatedAt::OrHash).void
+        params(
+          created_at: Increase::LockboxAddressListParams::CreatedAt::OrHash
+        ).void
       end
       attr_writer :created_at
 
@@ -53,8 +48,7 @@ module Increase
 
       sig do
         params(
-          account_id: String,
-          created_at: Increase::LockboxListParams::CreatedAt::OrHash,
+          created_at: Increase::LockboxAddressListParams::CreatedAt::OrHash,
           cursor: String,
           idempotency_key: String,
           limit: Integer,
@@ -62,8 +56,6 @@ module Increase
         ).returns(T.attached_class)
       end
       def self.new(
-        # Filter Lockboxes to those associated with the provided Account.
-        account_id: nil,
         created_at: nil,
         # Return the page of entries after this one.
         cursor: nil,
@@ -82,8 +74,7 @@ module Increase
       sig do
         override.returns(
           {
-            account_id: String,
-            created_at: Increase::LockboxListParams::CreatedAt,
+            created_at: Increase::LockboxAddressListParams::CreatedAt,
             cursor: String,
             idempotency_key: String,
             limit: Integer,
@@ -98,7 +89,7 @@ module Increase
         OrHash =
           T.type_alias do
             T.any(
-              Increase::LockboxListParams::CreatedAt,
+              Increase::LockboxAddressListParams::CreatedAt,
               Increase::Internal::AnyHash
             )
           end

data/rbi/increase/models/{bookkeeping_entry_set_retrieve_params.rbi → lockbox_address_retrieve_params.rbi}

@@ -2,31 +2,31 @@
 
 module Increase
   module Models
-    class BookkeepingEntrySetRetrieveParams < Increase::Internal::Type::BaseModel
+    class LockboxAddressRetrieveParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Increase::BookkeepingEntrySetRetrieveParams,
+            Increase::LockboxAddressRetrieveParams,
             Increase::Internal::AnyHash
           )
         end
 
-      # The identifier of the Bookkeeping Entry Set.
+      # The identifier of the Lockbox Address to retrieve.
       sig { returns(String) }
-      attr_accessor :bookkeeping_entry_set_id
+      attr_accessor :lockbox_address_id
 
       sig do
         params(
-          bookkeeping_entry_set_id: String,
+          lockbox_address_id: String,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The identifier of the Bookkeeping Entry Set.
-        bookkeeping_entry_set_id:,
+        # The identifier of the Lockbox Address to retrieve.
+        lockbox_address_id:,
         request_options: {}
       )
       end
@@ -34,7 +34,7 @@ module Increase
       sig do
         override.returns(
           {
-            bookkeeping_entry_set_id: String,
+            lockbox_address_id: String,
             request_options: Increase::RequestOptions
           }
         )

data/rbi/increase/models/lockbox_address_update_params.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxAddressUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::LockboxAddressUpdateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Lockbox Address.
+      sig { returns(String) }
+      attr_accessor :lockbox_address_id
+
+      # The description you choose for the Lockbox Address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # The status of the Lockbox Address.
+      sig do
+        returns(
+          T.nilable(Increase::LockboxAddressUpdateParams::Status::OrSymbol)
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: Increase::LockboxAddressUpdateParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          lockbox_address_id: String,
+          description: String,
+          status: Increase::LockboxAddressUpdateParams::Status::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            lockbox_address_id: String,
+            description: String,
+            status: Increase::LockboxAddressUpdateParams::Status::OrSymbol,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the Lockbox Address.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Increase::LockboxAddressUpdateParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # This Lockbox Address is active.
+        ACTIVE =
+          T.let(
+            :active,
+            Increase::LockboxAddressUpdateParams::Status::TaggedSymbol
+          )
+
+        # This Lockbox Address is disabled.
+        DISABLED =
+          T.let(
+            :disabled,
+            Increase::LockboxAddressUpdateParams::Status::TaggedSymbol
+          )
+
+        # This Lockbox Address is permanently disabled.
+        CANCELED =
+          T.let(
+            :canceled,
+            Increase::LockboxAddressUpdateParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Increase::LockboxAddressUpdateParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/lockbox_recipient.rbi

@@ -0,0 +1,182 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxRecipient < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Increase::LockboxRecipient, Increase::Internal::AnyHash)
+        end
+
+      # The Lockbox Recipient identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The identifier for the Account that checks sent to this Lockbox Recipient will
+      # be deposited into.
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      # Recipient was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The description of the Lockbox Recipient.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The idempotency key you chose for this 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_accessor :idempotency_key
+
+      # The identifier for the Lockbox Address where this Lockbox Recipient may receive
+      # physical mail.
+      sig { returns(String) }
+      attr_accessor :lockbox_address_id
+
+      # The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox
+      # Address. It should be included in the mailing address intended for this Lockbox
+      # Recipient.
+      sig { returns(String) }
+      attr_accessor :mail_stop_code
+
+      # The name of the Lockbox Recipient.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :recipient_name
+
+      # The status of the Lockbox Recipient.
+      sig do
+        returns(T.nilable(Increase::LockboxRecipient::Status::TaggedSymbol))
+      end
+      attr_accessor :status
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_recipient`.
+      sig { returns(Increase::LockboxRecipient::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for
+      # a Lockbox Recipient are deposited into its associated Account.
+      sig do
+        params(
+          id: String,
+          account_id: String,
+          created_at: Time,
+          description: T.nilable(String),
+          idempotency_key: T.nilable(String),
+          lockbox_address_id: String,
+          mail_stop_code: String,
+          recipient_name: T.nilable(String),
+          status: T.nilable(Increase::LockboxRecipient::Status::OrSymbol),
+          type: Increase::LockboxRecipient::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Lockbox Recipient identifier.
+        id:,
+        # The identifier for the Account that checks sent to this Lockbox Recipient will
+        # be deposited into.
+        account_id:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+        # Recipient was created.
+        created_at:,
+        # The description of the Lockbox Recipient.
+        description:,
+        # The idempotency key you chose for this 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:,
+        # The identifier for the Lockbox Address where this Lockbox Recipient may receive
+        # physical mail.
+        lockbox_address_id:,
+        # The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox
+        # Address. It should be included in the mailing address intended for this Lockbox
+        # Recipient.
+        mail_stop_code:,
+        # The name of the Lockbox Recipient.
+        recipient_name:,
+        # The status of the Lockbox Recipient.
+        status:,
+        # A constant representing the object's type. For this resource it will always be
+        # `lockbox_recipient`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            account_id: String,
+            created_at: Time,
+            description: T.nilable(String),
+            idempotency_key: T.nilable(String),
+            lockbox_address_id: String,
+            mail_stop_code: String,
+            recipient_name: T.nilable(String),
+            status: T.nilable(Increase::LockboxRecipient::Status::TaggedSymbol),
+            type: Increase::LockboxRecipient::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the Lockbox Recipient.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::LockboxRecipient::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # This Lockbox Recipient is active.
+        ACTIVE =
+          T.let(:active, Increase::LockboxRecipient::Status::TaggedSymbol)
+
+        # This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.
+        DISABLED =
+          T.let(:disabled, Increase::LockboxRecipient::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::LockboxRecipient::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::LockboxRecipient::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_recipient`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::LockboxRecipient::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCKBOX_RECIPIENT =
+          T.let(
+            :lockbox_recipient,
+            Increase::LockboxRecipient::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Increase::LockboxRecipient::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end