increase 1.304.0 → 1.305.0

data/lib/increase/models/lockbox_recipient.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxRecipients#create
+    class LockboxRecipient < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Lockbox Recipient identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The identifier for the Account that checks sent to this Lockbox Recipient will
+      #   be deposited into.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      #   Recipient was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description of the Lockbox Recipient.
+      #
+      #   @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 lockbox_address_id
+      #   The identifier for the Lockbox Address where this Lockbox Recipient may receive
+      #   physical mail.
+      #
+      #   @return [String]
+      required :lockbox_address_id, String
+
+      # @!attribute mail_stop_code
+      #   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.
+      #
+      #   @return [String]
+      required :mail_stop_code, String
+
+      # @!attribute recipient_name
+      #   The name of the Lockbox Recipient.
+      #
+      #   @return [String, nil]
+      required :recipient_name, String, nil?: true
+
+      # @!attribute status
+      #   The status of the Lockbox Recipient.
+      #
+      #   @return [Symbol, Increase::Models::LockboxRecipient::Status, nil]
+      required :status, enum: -> { Increase::LockboxRecipient::Status }, nil?: true
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `lockbox_recipient`.
+      #
+      #   @return [Symbol, Increase::Models::LockboxRecipient::Type]
+      required :type, enum: -> { Increase::LockboxRecipient::Type }
+
+      # @!method initialize(id:, account_id:, created_at:, description:, idempotency_key:, lockbox_address_id:, mail_stop_code:, recipient_name:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::LockboxRecipient} for more details.
+      #
+      #   Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for
+      #   a Lockbox Recipient are deposited into its associated Account.
+      #
+      #   @param id [String] The Lockbox Recipient identifier.
+      #
+      #   @param account_id [String] The identifier for the Account that checks sent to this Lockbox Recipient will b
+      #
+      #   @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 of the Lockbox Recipient.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param lockbox_address_id [String] The identifier for the Lockbox Address where this Lockbox Recipient may receive
+      #
+      #   @param mail_stop_code [String] The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Ad
+      #
+      #   @param recipient_name [String, nil] The name of the Lockbox Recipient.
+      #
+      #   @param status [Symbol, Increase::Models::LockboxRecipient::Status, nil] The status of the Lockbox Recipient.
+      #
+      #   @param type [Symbol, Increase::Models::LockboxRecipient::Type] A constant representing the object's type. For this resource it will always be `
+
+      # The status of the Lockbox Recipient.
+      #
+      # @see Increase::Models::LockboxRecipient#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # This Lockbox Recipient is active.
+        ACTIVE = :active
+
+        # This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.
+        DISABLED = :disabled
+
+        # This Lockbox Recipient is canceled and cannot be modified. Checks mailed to this Lockbox Recipient will be rejected.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_recipient`.
+      #
+      # @see Increase::Models::LockboxRecipient#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        LOCKBOX_RECIPIENT = :lockbox_recipient
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/lockbox_recipient_create_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxRecipients#create
+    class LockboxRecipientCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The Account that checks sent to this Lockbox Recipient should be deposited into.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute lockbox_address_id
+      #   The Lockbox Address where this Lockbox Recipient may receive mail.
+      #
+      #   @return [String]
+      required :lockbox_address_id, String
+
+      # @!attribute description
+      #   The description you choose for the Lockbox Recipient.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute recipient_name
+      #   The name of the Lockbox Recipient
+      #
+      #   @return [String, nil]
+      optional :recipient_name, String
+
+      # @!method initialize(account_id:, lockbox_address_id:, description: nil, recipient_name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::LockboxRecipientCreateParams} for more details.
+      #
+      #   @param account_id [String] The Account that checks sent to this Lockbox Recipient should be deposited into.
+      #
+      #   @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail.
+      #
+      #   @param description [String] The description you choose for the Lockbox Recipient.
+      #
+      #   @param recipient_name [String] The name of the Lockbox Recipient
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/lockbox_recipient_list_params.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxRecipients#list
+    class LockboxRecipientListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Lockbox Recipients to those associated with the provided Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::LockboxRecipientListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::LockboxRecipientListParams::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 lockbox_address_id
+      #   Filter Lockbox Recipients to those associated with the provided Lockbox Address.
+      #
+      #   @return [String, nil]
+      optional :lockbox_address_id, String
+
+      # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, lockbox_address_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::LockboxRecipientListParams} for more details.
+      #
+      #   @param account_id [String] Filter Lockbox Recipients to those associated with the provided Account.
+      #
+      #   @param created_at [Increase::Models::LockboxRecipientListParams::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 lockbox_address_id [String] Filter Lockbox Recipients to those associated with the provided Lockbox Address.
+      #
+      #   @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::LockboxRecipientListParams::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
+    end
+  end
+end

data/lib/increase/models/lockbox_recipient_retrieve_params.rb

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

data/lib/increase/models/lockbox_recipient_update_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxRecipients#update
+    class LockboxRecipientUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute lockbox_recipient_id
+      #   The identifier of the Lockbox Recipient.
+      #
+      #   @return [String]
+      required :lockbox_recipient_id, String
+
+      # @!attribute description
+      #   The description you choose for the Lockbox Recipient.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute recipient_name
+      #   The name of the Lockbox Recipient.
+      #
+      #   @return [String, nil]
+      optional :recipient_name, String
+
+      # @!attribute status
+      #   The status of the Lockbox Recipient.
+      #
+      #   @return [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status, nil]
+      optional :status, enum: -> { Increase::LockboxRecipientUpdateParams::Status }
+
+      # @!method initialize(lockbox_recipient_id:, description: nil, recipient_name: nil, status: nil, request_options: {})
+      #   @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient.
+      #
+      #   @param description [String] The description you choose for the Lockbox Recipient.
+      #
+      #   @param recipient_name [String] The name of the Lockbox Recipient.
+      #
+      #   @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status] The status of the Lockbox Recipient.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The status of the Lockbox Recipient.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # This Lockbox Recipient is active.
+        ACTIVE = :active
+
+        # This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.
+        DISABLED = :disabled
+
+        # This Lockbox Recipient is canceled and cannot be modified. Checks mailed to this Lockbox Recipient will be rejected.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/simulations/card_token_create_params.rb

@@ -132,6 +132,9 @@ module Increase
             # Mastercard and Maestro
             MASTERCARD = :mastercard
 
+            # Pulse
+            PULSE = :pulse
+
             # @!method self.values
             #   @return [Array<Symbol>]
           end

data/lib/increase/models/simulations/inbound_mail_item_create_params.rb

@@ -14,12 +14,6 @@ module Increase
         #   @return [Integer]
         required :amount, Integer
 
-        # @!attribute lockbox_id
-        #   The identifier of the Lockbox to simulate inbound mail to.
-        #
-        #   @return [String]
-        required :lockbox_id, String
-
         # @!attribute contents_file_id
         #   The file containing the PDF contents. If not present, a default check image file
         #   will be used.
@@ -27,16 +21,30 @@ module Increase
         #   @return [String, nil]
         optional :contents_file_id, String
 
-        # @!method initialize(amount:, lockbox_id:, contents_file_id: nil, request_options: {})
+        # @!attribute lockbox_address_id
+        #   The identifier of the Lockbox Address to simulate inbound mail to.
+        #
+        #   @return [String, nil]
+        optional :lockbox_address_id, String
+
+        # @!attribute lockbox_recipient_id
+        #   The identifier of the Lockbox Recipient to simulate inbound mail to.
+        #
+        #   @return [String, nil]
+        optional :lockbox_recipient_id, String
+
+        # @!method initialize(amount:, contents_file_id: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
         #
         #   @param amount [Integer] The amount of the check to be simulated, in cents.
         #
-        #   @param lockbox_id [String] The identifier of the Lockbox to simulate inbound mail to.
-        #
         #   @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
         #
+        #   @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to.
+        #
+        #   @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to.
+        #
         #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/increase/models.rb

@@ -405,15 +405,25 @@ 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/lib/increase/resources/inbound_mail_items.rb

@@ -28,7 +28,7 @@ module Increase
       #
       # List Inbound Mail Items
       #
-      # @overload list(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {})
+      # @overload list(created_at: nil, cursor: nil, limit: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
       #
       # @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt]
       #
@@ -36,7 +36,9 @@ module Increase
       #
       # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
       #
-      # @param lockbox_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox.
+      # @param lockbox_address_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
+      #
+      # @param lockbox_recipient_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/increase/resources/lockbox_addresses.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class LockboxAddresses
+      # Create a Lockbox Address
+      #
+      # @overload create(description: nil, request_options: {})
+      #
+      # @param description [String] The description you choose for the Lockbox Address.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::LockboxAddress]
+      #
+      # @see Increase::Models::LockboxAddressCreateParams
+      def create(params = {})
+        parsed, options = Increase::LockboxAddressCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "lockbox_addresses",
+          body: parsed,
+          model: Increase::LockboxAddress,
+          options: options
+        )
+      end
+
+      # Retrieve a Lockbox Address
+      #
+      # @overload retrieve(lockbox_address_id, request_options: {})
+      #
+      # @param lockbox_address_id [String] The identifier of the Lockbox Address to retrieve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::LockboxAddress]
+      #
+      # @see Increase::Models::LockboxAddressRetrieveParams
+      def retrieve(lockbox_address_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["lockbox_addresses/%1$s", lockbox_address_id],
+          model: Increase::LockboxAddress,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a Lockbox Address
+      #
+      # @overload update(lockbox_address_id, description: nil, status: nil, request_options: {})
+      #
+      # @param lockbox_address_id [String] The identifier of the Lockbox Address.
+      #
+      # @param description [String] The description you choose for the Lockbox Address.
+      #
+      # @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status] The status of the Lockbox Address.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::LockboxAddress]
+      #
+      # @see Increase::Models::LockboxAddressUpdateParams
+      def update(lockbox_address_id, params = {})
+        parsed, options = Increase::LockboxAddressUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["lockbox_addresses/%1$s", lockbox_address_id],
+          body: parsed,
+          model: Increase::LockboxAddress,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::LockboxAddressListParams} for more details.
+      #
+      # List Lockbox Addresses
+      #
+      # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #
+      # @param created_at [Increase::Models::LockboxAddressListParams::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::LockboxAddress>]
+      #
+      # @see Increase::Models::LockboxAddressListParams
+      def list(params = {})
+        parsed, options = Increase::LockboxAddressListParams.dump_request(params)
+        query = Increase::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "lockbox_addresses",
+          query: query,
+          page: Increase::Internal::Page,
+          model: Increase::LockboxAddress,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end