increase 1.304.0 → 1.305.0

data/lib/increase/models/lockbox.rb

@@ -1,185 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Lockboxes#create
-    class Lockbox < Increase::Internal::Type::BaseModel
-      # @!attribute id
-      #   The Lockbox identifier.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute account_id
-      #   The identifier for the Account checks sent to this lockbox will be deposited
-      #   into.
-      #
-      #   @return [String]
-      required :account_id, String
-
-      # @!attribute address
-      #   The mailing address for the Lockbox.
-      #
-      #   @return [Increase::Models::Lockbox::Address]
-      required :address, -> { Increase::Lockbox::Address }
-
-      # @!attribute check_deposit_behavior
-      #   Indicates if checks mailed to this lockbox will be deposited.
-      #
-      #   @return [Symbol, Increase::Models::Lockbox::CheckDepositBehavior]
-      required :check_deposit_behavior, enum: -> { Increase::Lockbox::CheckDepositBehavior }
-
-      # @!attribute created_at
-      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
-      #   was created.
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute description
-      #   The description you choose for the Lockbox.
-      #
-      #   @return [String, nil]
-      required :description, String, nil?: true
-
-      # @!attribute idempotency_key
-      #   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).
-      #
-      #   @return [String, nil]
-      required :idempotency_key, String, nil?: true
-
-      # @!attribute recipient_name
-      #   The recipient name you choose for the Lockbox.
-      #
-      #   @return [String, nil]
-      required :recipient_name, String, nil?: true
-
-      # @!attribute type
-      #   A constant representing the object's type. For this resource it will always be
-      #   `lockbox`.
-      #
-      #   @return [Symbol, Increase::Models::Lockbox::Type]
-      required :type, enum: -> { Increase::Lockbox::Type }
-
-      # @!method initialize(id:, account_id:, address:, check_deposit_behavior:, created_at:, description:, idempotency_key:, recipient_name:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::Lockbox} for more details.
-      #
-      #   Lockboxes are physical locations that can receive mail containing paper checks.
-      #   Increase will automatically create a Check Deposit for checks received this way.
-      #
-      #   @param id [String] The Lockbox identifier.
-      #
-      #   @param account_id [String] The identifier for the Account checks sent to this lockbox will be deposited int
-      #
-      #   @param address [Increase::Models::Lockbox::Address] The mailing address for the Lockbox.
-      #
-      #   @param check_deposit_behavior [Symbol, Increase::Models::Lockbox::CheckDepositBehavior] Indicates if checks mailed to this lockbox will be deposited.
-      #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
-      #
-      #   @param description [String, nil] The description you choose for the Lockbox.
-      #
-      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
-      #
-      #   @param recipient_name [String, nil] The recipient name you choose for the Lockbox.
-      #
-      #   @param type [Symbol, Increase::Models::Lockbox::Type] A constant representing the object's type. For this resource it will always be `
-
-      # @see Increase::Models::Lockbox#address
-      class Address < Increase::Internal::Type::BaseModel
-        # @!attribute city
-        #   The city of the address.
-        #
-        #   @return [String]
-        required :city, String
-
-        # @!attribute line1
-        #   The first line of the address.
-        #
-        #   @return [String]
-        required :line1, String
-
-        # @!attribute line2
-        #   The second line of the address.
-        #
-        #   @return [String]
-        required :line2, String
-
-        # @!attribute postal_code
-        #   The postal code of the address.
-        #
-        #   @return [String]
-        required :postal_code, String
-
-        # @!attribute recipient
-        #   The recipient line of the address. This will include the recipient name you
-        #   provide when creating the address, as well as an ATTN suffix to help route the
-        #   mail to your lockbox. Mail senders must include this ATTN line to receive mail
-        #   at this Lockbox.
-        #
-        #   @return [String, nil]
-        required :recipient, String, nil?: true
-
-        # @!attribute state
-        #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-        #   the address.
-        #
-        #   @return [String]
-        required :state, String
-
-        # @!method initialize(city:, line1:, line2:, postal_code:, recipient:, state:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::Lockbox::Address} for more details.
-        #
-        #   The mailing address for the Lockbox.
-        #
-        #   @param city [String] The city of the address.
-        #
-        #   @param line1 [String] The first line of the address.
-        #
-        #   @param line2 [String] The second line of the address.
-        #
-        #   @param postal_code [String] The postal code of the address.
-        #
-        #   @param recipient [String, nil] The recipient line of the address. This will include the recipient name you prov
-        #
-        #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
-      end
-
-      # Indicates if checks mailed to this lockbox will be deposited.
-      #
-      # @see Increase::Models::Lockbox#check_deposit_behavior
-      module CheckDepositBehavior
-        extend Increase::Internal::Type::Enum
-
-        # Checks mailed to this Lockbox will be deposited.
-        ENABLED = :enabled
-
-        # Checks mailed to this Lockbox will not be deposited.
-        DISABLED = :disabled
-
-        # Checks mailed to this Lockbox will be pending until actioned.
-        PEND_FOR_PROCESSING = :pend_for_processing
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `lockbox`.
-      #
-      # @see Increase::Models::Lockbox#type
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        LOCKBOX = :lockbox
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/models/lockbox_create_params.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Lockboxes#create
-    class LockboxCreateParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute account_id
-      #   The Account checks sent to this Lockbox should be deposited into.
-      #
-      #   @return [String]
-      required :account_id, String
-
-      # @!attribute description
-      #   The description you choose for the Lockbox, for display purposes.
-      #
-      #   @return [String, nil]
-      optional :description, String
-
-      # @!attribute recipient_name
-      #   The name of the recipient that will receive mail at this location.
-      #
-      #   @return [String, nil]
-      optional :recipient_name, String
-
-      # @!method initialize(account_id:, description: nil, recipient_name: nil, request_options: {})
-      #   @param account_id [String] The Account checks sent to this Lockbox should be deposited into.
-      #
-      #   @param description [String] The description you choose for the Lockbox, for display purposes.
-      #
-      #   @param recipient_name [String] The name of the recipient that will receive mail at this location.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/increase/models/lockbox_retrieve_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Lockboxes#retrieve
-    class LockboxRetrieveParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute lockbox_id
-      #   The identifier of the Lockbox to retrieve.
-      #
-      #   @return [String]
-      required :lockbox_id, String
-
-      # @!method initialize(lockbox_id:, request_options: {})
-      #   @param lockbox_id [String] The identifier of the Lockbox to retrieve.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/increase/models/lockbox_update_params.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::Lockboxes#update
-    class LockboxUpdateParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute lockbox_id
-      #   The identifier of the Lockbox.
-      #
-      #   @return [String]
-      required :lockbox_id, String
-
-      # @!attribute check_deposit_behavior
-      #   This indicates if checks mailed to this lockbox will be deposited.
-      #
-      #   @return [Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior, nil]
-      optional :check_deposit_behavior, enum: -> { Increase::LockboxUpdateParams::CheckDepositBehavior }
-
-      # @!attribute description
-      #   The description you choose for the Lockbox.
-      #
-      #   @return [String, nil]
-      optional :description, String
-
-      # @!attribute recipient_name
-      #   The recipient name you choose for the Lockbox.
-      #
-      #   @return [String, nil]
-      optional :recipient_name, String
-
-      # @!method initialize(lockbox_id:, check_deposit_behavior: nil, description: nil, recipient_name: nil, request_options: {})
-      #   @param lockbox_id [String] The identifier of the Lockbox.
-      #
-      #   @param check_deposit_behavior [Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior] This indicates if checks mailed to this lockbox will be deposited.
-      #
-      #   @param description [String] The description you choose for the Lockbox.
-      #
-      #   @param recipient_name [String] The recipient name you choose for the Lockbox.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-
-      # This indicates if checks mailed to this lockbox will be deposited.
-      module CheckDepositBehavior
-        extend Increase::Internal::Type::Enum
-
-        # Checks mailed to this Lockbox will be deposited.
-        ENABLED = :enabled
-
-        # Checks mailed to this Lockbox will not be deposited.
-        DISABLED = :disabled
-
-        # Checks mailed to this Lockbox will be pending until actioned.
-        PEND_FOR_PROCESSING = :pend_for_processing
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/resources/lockboxes.rb

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class Lockboxes
-      # Create a Lockbox
-      #
-      # @overload create(account_id:, description: nil, recipient_name: nil, request_options: {})
-      #
-      # @param account_id [String] The Account checks sent to this Lockbox should be deposited into.
-      #
-      # @param description [String] The description you choose for the Lockbox, for display purposes.
-      #
-      # @param recipient_name [String] The name of the recipient that will receive mail at this location.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Lockbox]
-      #
-      # @see Increase::Models::LockboxCreateParams
-      def create(params)
-        parsed, options = Increase::LockboxCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "lockboxes",
-          body: parsed,
-          model: Increase::Lockbox,
-          options: options
-        )
-      end
-
-      # Retrieve a Lockbox
-      #
-      # @overload retrieve(lockbox_id, request_options: {})
-      #
-      # @param lockbox_id [String] The identifier of the Lockbox to retrieve.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Lockbox]
-      #
-      # @see Increase::Models::LockboxRetrieveParams
-      def retrieve(lockbox_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["lockboxes/%1$s", lockbox_id],
-          model: Increase::Lockbox,
-          options: params[:request_options]
-        )
-      end
-
-      # Update a Lockbox
-      #
-      # @overload update(lockbox_id, check_deposit_behavior: nil, description: nil, recipient_name: nil, request_options: {})
-      #
-      # @param lockbox_id [String] The identifier of the Lockbox.
-      #
-      # @param check_deposit_behavior [Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior] This indicates if checks mailed to this lockbox will be deposited.
-      #
-      # @param description [String] The description you choose for the Lockbox.
-      #
-      # @param recipient_name [String] The recipient name you choose for the Lockbox.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Lockbox]
-      #
-      # @see Increase::Models::LockboxUpdateParams
-      def update(lockbox_id, params = {})
-        parsed, options = Increase::LockboxUpdateParams.dump_request(params)
-        @client.request(
-          method: :patch,
-          path: ["lockboxes/%1$s", lockbox_id],
-          body: parsed,
-          model: Increase::Lockbox,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::LockboxListParams} for more details.
-      #
-      # List Lockboxes
-      #
-      # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
-      #
-      # @param account_id [String] Filter Lockboxes to those associated with the provided Account.
-      #
-      # @param created_at [Increase::Models::LockboxListParams::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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Internal::Page<Increase::Models::Lockbox>]
-      #
-      # @see Increase::Models::LockboxListParams
-      def list(params = {})
-        parsed, options = Increase::LockboxListParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "lockboxes",
-          query: query,
-          page: Increase::Internal::Page,
-          model: Increase::Lockbox,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/increase/models/lockbox.rbi

@@ -1,251 +0,0 @@
-# typed: strong
-
-module Increase
-  module Models
-    class Lockbox < Increase::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias { T.any(Increase::Lockbox, Increase::Internal::AnyHash) }
-
-      # The Lockbox identifier.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The identifier for the Account checks sent to this lockbox will be deposited
-      # into.
-      sig { returns(String) }
-      attr_accessor :account_id
-
-      # The mailing address for the Lockbox.
-      sig { returns(Increase::Lockbox::Address) }
-      attr_reader :address
-
-      sig { params(address: Increase::Lockbox::Address::OrHash).void }
-      attr_writer :address
-
-      # Indicates if checks mailed to this lockbox will be deposited.
-      sig { returns(Increase::Lockbox::CheckDepositBehavior::TaggedSymbol) }
-      attr_accessor :check_deposit_behavior
-
-      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
-      # was created.
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # The description you choose for the Lockbox.
-      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 recipient name you choose for the Lockbox.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :recipient_name
-
-      # A constant representing the object's type. For this resource it will always be
-      # `lockbox`.
-      sig { returns(Increase::Lockbox::Type::TaggedSymbol) }
-      attr_accessor :type
-
-      # Lockboxes are physical locations that can receive mail containing paper checks.
-      # Increase will automatically create a Check Deposit for checks received this way.
-      sig do
-        params(
-          id: String,
-          account_id: String,
-          address: Increase::Lockbox::Address::OrHash,
-          check_deposit_behavior:
-            Increase::Lockbox::CheckDepositBehavior::OrSymbol,
-          created_at: Time,
-          description: T.nilable(String),
-          idempotency_key: T.nilable(String),
-          recipient_name: T.nilable(String),
-          type: Increase::Lockbox::Type::OrSymbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The Lockbox identifier.
-        id:,
-        # The identifier for the Account checks sent to this lockbox will be deposited
-        # into.
-        account_id:,
-        # The mailing address for the Lockbox.
-        address:,
-        # Indicates if checks mailed to this lockbox will be deposited.
-        check_deposit_behavior:,
-        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
-        # was created.
-        created_at:,
-        # The description you choose for the Lockbox.
-        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 recipient name you choose for the Lockbox.
-        recipient_name:,
-        # A constant representing the object's type. For this resource it will always be
-        # `lockbox`.
-        type:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            account_id: String,
-            address: Increase::Lockbox::Address,
-            check_deposit_behavior:
-              Increase::Lockbox::CheckDepositBehavior::TaggedSymbol,
-            created_at: Time,
-            description: T.nilable(String),
-            idempotency_key: T.nilable(String),
-            recipient_name: T.nilable(String),
-            type: Increase::Lockbox::Type::TaggedSymbol
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Address < Increase::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Increase::Lockbox::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 recipient line of the address. This will include the recipient name you
-        # provide when creating the address, as well as an ATTN suffix to help route the
-        # mail to your lockbox. Mail senders must include this ATTN line to receive mail
-        # at this Lockbox.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :recipient
-
-        # 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.
-        sig do
-          params(
-            city: String,
-            line1: String,
-            line2: String,
-            postal_code: String,
-            recipient: T.nilable(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 recipient line of the address. This will include the recipient name you
-          # provide when creating the address, as well as an ATTN suffix to help route the
-          # mail to your lockbox. Mail senders must include this ATTN line to receive mail
-          # at this Lockbox.
-          recipient:,
-          # 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,
-              recipient: T.nilable(String),
-              state: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      # Indicates if checks mailed to this lockbox will be deposited.
-      module CheckDepositBehavior
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Increase::Lockbox::CheckDepositBehavior)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        # Checks mailed to this Lockbox will be deposited.
-        ENABLED =
-          T.let(:enabled, Increase::Lockbox::CheckDepositBehavior::TaggedSymbol)
-
-        # Checks mailed to this Lockbox will not be deposited.
-        DISABLED =
-          T.let(
-            :disabled,
-            Increase::Lockbox::CheckDepositBehavior::TaggedSymbol
-          )
-
-        # Checks mailed to this Lockbox will be pending until actioned.
-        PEND_FOR_PROCESSING =
-          T.let(
-            :pend_for_processing,
-            Increase::Lockbox::CheckDepositBehavior::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Increase::Lockbox::CheckDepositBehavior::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `lockbox`.
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Lockbox::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        LOCKBOX = T.let(:lockbox, Increase::Lockbox::Type::TaggedSymbol)
-
-        sig do
-          override.returns(T::Array[Increase::Lockbox::Type::TaggedSymbol])
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end