increase 1.340.0 → 1.341.0

data/lib/increase/models/entity_list_params.rb

@@ -39,20 +39,30 @@ module Increase
       #   @return [Increase::Models::EntityListParams::Status, nil]
       optional :status, -> { Increase::EntityListParams::Status }
 
-      # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EntityListParams} for more details.
+      # @!attribute validation_status
       #
+      #   @return [Increase::Models::EntityListParams::ValidationStatus, nil]
+      optional :validation_status, -> { Increase::EntityListParams::ValidationStatus }
+
+      # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, validation_status: nil, request_options: {})
       #   @param created_at [Increase::Models::EntityListParams::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 status [Increase::Models::EntityListParams::Status]
       #
+      #   @param validation_status [Increase::Models::EntityListParams::ValidationStatus]
+      #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class CreatedAt < Increase::Internal::Type::BaseModel
@@ -85,16 +95,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::EntityListParams::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
@@ -109,10 +124,10 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::EntityListParams::Status::In>] Filter Entities for those with the specified status or statuses. For GET request
+        #   @param in_ [Array<Symbol, Increase::Models::EntityListParams::Status::In>]
+        #     Filter Entities for those with the specified status or statuses. 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
@@ -130,6 +145,42 @@ module Increase
           #   @return [Array<Symbol>]
         end
       end
+
+      class ValidationStatus < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Entities for those with the specified validation status. For GET
+        #   requests, this should be encoded as a comma-delimited string, such as
+        #   `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::EntityListParams::ValidationStatus::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::EntityListParams::ValidationStatus::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   @param in_ [Array<Symbol, Increase::Models::EntityListParams::ValidationStatus::In>]
+        #     Filter Entities for those with the specified validation status. 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
+
+          # The submitted data is being validated.
+          PENDING = :pending
+
+          # The submitted data is valid.
+          VALID = :valid
+
+          # Additional information is required to validate the data.
+          INVALID = :invalid
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/increase/models/entity_onboarding_session.rb

@@ -74,9 +74,6 @@ module Increase
       required :type, enum: -> { Increase::EntityOnboardingSession::Type }
 
       # @!method initialize(id:, created_at:, entity_id:, expires_at:, idempotency_key:, program_id:, redirect_url:, session_url:, status:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EntityOnboardingSession} for more details.
-      #
       #   Entity Onboarding Sessions let your customers onboard themselves by completing
       #   Increase-hosted forms. Create a session and redirect your customer to the
       #   returned URL. When they're done, they'll be redirected back to your site. This
@@ -84,23 +81,40 @@ module Increase
       #
       #   @param id [String] The Entity Onboarding Session's identifier.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the Entity Onboarding Session was created.
       #
-      #   @param entity_id [String, nil] The identifier of the Entity associated with this session, if one has been creat
+      #   @param entity_id [String, nil]
+      #     The identifier of the Entity associated with this session, if one has been
+      #     created or was provided when creating the session.
       #
-      #   @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #   @param expires_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the Entity Onboarding Session will expire.
       #
-      #   @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 program_id [String] The identifier of the Program the Entity will be onboarded to.
       #
-      #   @param redirect_url [String] The URL to redirect to after the onboarding session is complete. Increase will i
+      #   @param redirect_url [String]
+      #     The URL to redirect to after the onboarding session is complete. Increase will
+      #     include the query parameters `entity_onboarding_session_id` and `entity_id` when
+      #     redirecting.
       #
-      #   @param session_url [String, nil] The URL containing the onboarding form. You should share this link with your cus
+      #   @param session_url [String, nil]
+      #     The URL containing the onboarding form. You should share this link with your
+      #     customer. Only present when the session is active.
       #
-      #   @param status [Symbol, Increase::Models::EntityOnboardingSession::Status] The status of the onboarding session.
+      #   @param status [Symbol, Increase::Models::EntityOnboardingSession::Status]
+      #     The status of the onboarding session.
       #
-      #   @param type [Symbol, Increase::Models::EntityOnboardingSession::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::EntityOnboardingSession::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `entity_onboarding_session`.
 
       # The status of the onboarding session.
       #

data/lib/increase/models/entity_onboarding_session_create_params.rb

@@ -30,14 +30,17 @@ module Increase
       optional :entity_id, String
 
       # @!method initialize(program_id:, redirect_url:, entity_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EntityOnboardingSessionCreateParams} for more details.
-      #
       #   @param program_id [String] The identifier of the Program the Entity will be onboarded to.
       #
-      #   @param redirect_url [String] The URL to redirect the customer to after they complete the onboarding form. The
+      #   @param redirect_url [String]
+      #     The URL to redirect the customer to after they complete the onboarding form. The
+      #     redirect will include `entity_onboarding_session_id` and `entity_id` query
+      #     parameters.
       #
-      #   @param entity_id [String] The identifier of an existing Entity to associate with the onboarding session. I
+      #   @param entity_id [String]
+      #     The identifier of an existing Entity to associate with the onboarding session.
+      #     If provided, the onboarding form will display any outstanding tasks required to
+      #     complete the Entity's onboarding.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/increase/models/entity_onboarding_session_list_params.rb

@@ -35,14 +35,17 @@ module Increase
       optional :status, -> { Increase::EntityOnboardingSessionListParams::Status }
 
       # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EntityOnboardingSessionListParams} for more details.
-      #
       #   @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 status [Increase::Models::EntityOnboardingSessionListParams::Status]
       #
@@ -62,10 +65,10 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityOnboardingSessionListParams::Status} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::EntityOnboardingSessionListParams::Status::In>] Filter Entity Onboarding Session for those with the specified status or statuses
+        #   @param in_ [Array<Symbol, Increase::Models::EntityOnboardingSessionListParams::Status::In>]
+        #     Filter Entity Onboarding Session for those with the specified status or
+        #     statuses. 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/entity_supplemental_document.rb

@@ -39,21 +39,25 @@ module Increase
       required :type, enum: -> { Increase::EntitySupplementalDocument::Type }
 
       # @!method initialize(created_at:, entity_id:, file_id:, idempotency_key:, type:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EntitySupplementalDocument} for more details.
-      #
       #   Supplemental Documents are uploaded files connected to an Entity during
       #   onboarding. Not all programs require supplemental documents.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplem
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+      #     Supplemental Document was created.
       #
       #   @param entity_id [String] The Entity the supplemental document is attached to.
       #
       #   @param file_id [String] The File containing the document.
       #
-      #   @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 type [Symbol, Increase::Models::EntitySupplementalDocument::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::EntitySupplementalDocument::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `entity_supplemental_document`.
 
       # A constant representing the object's type. For this resource it will always be
       # `entity_supplemental_document`.