increase 1.340.0 → 1.342.0

data/lib/increase/models/lockbox_recipient.rb

@@ -73,31 +73,43 @@ module Increase
       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 account_id [String]
+      #     The identifier for the Account that checks sent to this Lockbox Recipient will
+      #     be deposited into.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      #     Recipient was created.
       #
       #   @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 idempotency_key [String, nil]
+      #     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).
       #
-      #   @param lockbox_address_id [String] The identifier for the Lockbox Address where this Lockbox Recipient may receive
+      #   @param lockbox_address_id [String]
+      #     The identifier for the Lockbox Address where this Lockbox Recipient may receive
+      #     physical mail.
       #
-      #   @param mail_stop_code [String] The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Ad
+      #   @param mail_stop_code [String]
+      #     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.
       #
       #   @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 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 `
+      #   @param type [Symbol, Increase::Models::LockboxRecipient::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `lockbox_recipient`.
 
       # The status of the Lockbox Recipient.
       #

data/lib/increase/models/lockbox_recipient_create_params.rb

@@ -33,12 +33,12 @@ module Increase
       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 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. The Lockbox A
+      #   @param lockbox_address_id [String]
+      #     The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
+      #     Address must have a `status` of `active`.
       #
       #   @param description [String] The description you choose for the Lockbox Recipient.
       #

data/lib/increase/models/lockbox_recipient_list_params.rb

@@ -47,20 +47,24 @@ module Increase
       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 idempotency_key [String]
+      #     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).
       #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #   @param limit [Integer]
+      #     Limit the size of the list that is returned. The default (and maximum) is 100
+      #     objects.
       #
-      #   @param lockbox_address_id [String] Filter Lockbox Recipients to those associated with the provided Lockbox Address.
+      #   @param lockbox_address_id [String]
+      #     Filter Lockbox Recipients to those associated with the provided Lockbox Address.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -94,16 +98,21 @@ module Increase
         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 after [Time]
+        #     Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #   @param before [Time]
+        #     Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #   @param on_or_after [Time]
+        #     Return results on or after this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
         #
-        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+        #   @param on_or_before [Time]
+        #     Return results on or before this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
       end
     end
   end

data/lib/increase/models/lockbox_recipient_update_params.rb

@@ -38,7 +38,8 @@ module Increase
       #
       #   @param recipient_name [String] The name of the Lockbox Recipient.
       #
-      #   @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status] The status 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}]
 

data/lib/increase/models/oauth_application.rb

@@ -51,9 +51,6 @@ module Increase
       required :type, enum: -> { Increase::OAuthApplication::Type }
 
       # @!method initialize(id:, client_id:, created_at:, deleted_at:, name:, status:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::OAuthApplication} for more details.
-      #
       #   An OAuth Application lets you build an application for others to use with their
       #   Increase data. You can create an OAuth Application via the Dashboard and read
       #   information about it with the API. Learn more about OAuth
@@ -61,17 +58,25 @@ module Increase
       #
       #   @param id [String] The OAuth Application's identifier.
       #
-      #   @param client_id [String] The OAuth Application's client_id. Use this to authenticate with the OAuth Appli
+      #   @param client_id [String]
+      #     The OAuth Application's client_id. Use this to authenticate with the OAuth
+      #     Application.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #     Application was created.
       #
-      #   @param deleted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #   @param deleted_at [Time, nil]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #     Application was deleted.
       #
       #   @param name [String, nil] The name you chose for this OAuth Application.
       #
       #   @param status [Symbol, Increase::Models::OAuthApplication::Status] Whether the application is active.
       #
-      #   @param type [Symbol, Increase::Models::OAuthApplication::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::OAuthApplication::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `oauth_application`.
 
       # Whether the application is active.
       #

data/lib/increase/models/oauth_application_list_params.rb

@@ -31,14 +31,13 @@ module Increase
       optional :status, -> { Increase::OAuthApplicationListParams::Status }
 
       # @!method initialize(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::OAuthApplicationListParams} for more details.
-      #
       #   @param created_at [Increase::Models::OAuthApplicationListParams::CreatedAt]
       #
       #   @param cursor [String] Return the page of entries after this one.
       #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #   @param limit [Integer]
+      #     Limit the size of the list that is returned. The default (and maximum) is 100
+      #     objects.
       #
       #   @param status [Increase::Models::OAuthApplicationListParams::Status]
       #
@@ -74,16 +73,21 @@ module Increase
         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::OAuthApplicationListParams::CreatedAt} for more details.
-        #
-        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #   @param after [Time]
+        #     Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #   @param before [Time]
+        #     Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
         #
-        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #   @param on_or_after [Time]
+        #     Return results on or after this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
         #
-        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+        #   @param on_or_before [Time]
+        #     Return results on or before this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
       end
 
       class Status < Increase::Internal::Type::BaseModel
@@ -99,10 +103,9 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::OAuthApplicationListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::OAuthApplicationListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
+        #   @param in_ [Array<Symbol, Increase::Models::OAuthApplicationListParams::Status::In>]
+        #     Return results whose value is in the provided list. For GET requests, this
+        #     should be encoded as a comma-delimited string, such as `?in=one,two,three`.
 
         module In
           extend Increase::Internal::Type::Enum

data/lib/increase/models/oauth_connection.rb

@@ -50,18 +50,19 @@ module Increase
       required :type, enum: -> { Increase::OAuthConnection::Type }
 
       # @!method initialize(id:, created_at:, deleted_at:, group_id:, oauth_application_id:, status:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::OAuthConnection} for more details.
-      #
       #   When a user authorizes your OAuth application, an OAuth Connection object is
       #   created. Learn more about OAuth
       #   [here](https://increase.com/documentation/oauth).
       #
       #   @param id [String] The OAuth Connection's identifier.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #     Connection was created.
       #
-      #   @param deleted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #   @param deleted_at [Time, nil]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #     Connection was deleted.
       #
       #   @param group_id [String] The identifier of the Group that has authorized your OAuth application.
       #
@@ -69,7 +70,9 @@ module Increase
       #
       #   @param status [Symbol, Increase::Models::OAuthConnection::Status] Whether the connection is active.
       #
-      #   @param type [Symbol, Increase::Models::OAuthConnection::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::OAuthConnection::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `oauth_connection`.
 
       # Whether the connection is active.
       #

data/lib/increase/models/oauth_connection_list_params.rb

@@ -33,14 +33,15 @@ module Increase
       optional :status, -> { Increase::OAuthConnectionListParams::Status }
 
       # @!method initialize(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::OAuthConnectionListParams} for more details.
-      #
       #   @param cursor [String] Return the page of entries after this one.
       #
-      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #   @param limit [Integer]
+      #     Limit the size of the list that is returned. The default (and maximum) is 100
+      #     objects.
       #
-      #   @param oauth_application_id [String] Filter results to only include OAuth Connections for a specific OAuth Applicatio
+      #   @param oauth_application_id [String]
+      #     Filter results to only include OAuth Connections for a specific OAuth
+      #     Application.
       #
       #   @param status [Increase::Models::OAuthConnectionListParams::Status]
       #
@@ -60,10 +61,10 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::OAuthConnectionListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::OAuthConnectionListParams::Status::In>] Filter to OAuth Connections by their status. By default, return only the `active
+        #   @param in_ [Array<Symbol, Increase::Models::OAuthConnectionListParams::Status::In>]
+        #     Filter to OAuth Connections by their status. By default, return only the
+        #     `active` ones. For GET requests, this should be encoded as a comma-delimited
+        #     string, such as `?in=one,two,three`.
 
         module In
           extend Increase::Internal::Type::Enum

data/lib/increase/models/oauth_token.rb

@@ -31,20 +31,21 @@ module Increase
       required :type, enum: -> { Increase::OAuthToken::Type }
 
       # @!method initialize(access_token:, group_id:, token_type:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::OAuthToken} for more details.
-      #
       #   A token that is returned to your application when a user completes the OAuth
       #   flow and may be used to authenticate requests. Learn more about OAuth
       #   [here](/documentation/oauth).
       #
-      #   @param access_token [String] You may use this token in place of an API key to make OAuth requests on a user's
+      #   @param access_token [String]
+      #     You may use this token in place of an API key to make OAuth requests on a user's
+      #     behalf.
       #
       #   @param group_id [String] The Group's identifier. A Group is the top-level organization in Increase.
       #
       #   @param token_type [Symbol, Increase::Models::OAuthToken::TokenType] The type of OAuth token.
       #
-      #   @param type [Symbol, Increase::Models::OAuthToken::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::OAuthToken::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `oauth_token`.
 
       # The type of OAuth token.
       #

data/lib/increase/models/oauth_token_create_params.rb

@@ -44,18 +44,25 @@ module Increase
       optional :production_token, String
 
       # @!method initialize(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::OAuthTokenCreateParams} for more details.
-      #
-      #   @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] The credential you request in exchange for the code. In Production, this is alwa
+      #   @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
+      #     The credential you request in exchange for the code. In Production, this is
+      #     always `authorization_code`. In Sandbox, you can pass either enum value.
       #
       #   @param client_id [String] The public identifier for your application.
       #
-      #   @param client_secret [String] The secret that confirms you own the application. This is redundant given that t
+      #   @param client_secret [String]
+      #     The secret that confirms you own the application. This is redundant given that
+      #     the request is made with your API key but it's a required component of OAuth
+      #     2.0.
       #
-      #   @param code [String] The authorization code generated by the user and given to you as a query paramet
+      #   @param code [String]
+      #     The authorization code generated by the user and given to you as a query
+      #     parameter.
       #
-      #   @param production_token [String] The production token you want to exchange for a sandbox token. This is only avai
+      #   @param production_token [String]
+      #     The production token you want to exchange for a sandbox token. This is only
+      #     available in Sandbox. Set `grant_type` to `production_token` to use this
+      #     parameter.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]