increase 1.340.0 → 1.341.0

data/lib/increase/models/entity_update_params.rb

@@ -73,26 +73,41 @@ module Increase
       optional :trust, -> { Increase::EntityUpdateParams::Trust }
 
       # @!method initialize(entity_id:, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EntityUpdateParams} for more details.
-      #
       #   @param entity_id [String] The entity identifier.
       #
-      #   @param corporation [Increase::Models::EntityUpdateParams::Corporation] Details of the corporation entity to update. If you specify this parameter and t
+      #   @param corporation [Increase::Models::EntityUpdateParams::Corporation]
+      #     Details of the corporation entity to update. If you specify this parameter and
+      #     the entity is not a corporation, the request will fail.
       #
-      #   @param details_confirmed_at [Time] When your user last confirmed the Entity's details. Depending on your program, y
+      #   @param details_confirmed_at [Time]
+      #     When your user last confirmed the Entity's details. Depending on your program,
+      #     you may be required to affirmatively confirm details with your users on an
+      #     annual basis.
       #
-      #   @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority] Details of the government authority entity to update. If you specify this parame
+      #   @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority]
+      #     Details of the government authority entity to update. If you specify this
+      #     parameter and the entity is not a government authority, the request will fail.
       #
-      #   @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson] Details of the natural person entity to update. If you specify this parameter an
+      #   @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson]
+      #     Details of the natural person entity to update. If you specify this parameter
+      #     and the entity is not a natural person, the request will fail.
       #
-      #   @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
+      #   @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
+      #     An assessment of the entity’s potential risk of involvement in financial crimes,
+      #     such as money laundering.
       #
-      #   @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>] New terms that the Entity agreed to. Not all programs are required to submit thi
+      #   @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>]
+      #     New terms that the Entity agreed to. Not all programs are required to submit
+      #     this data. This will not archive previously submitted terms.
       #
-      #   @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
+      #   @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification]
+      #     If you are using a third-party service for identity verification, you can use
+      #     this field to associate this Entity with the identifier that represents them in
+      #     that service.
       #
-      #   @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update. If you specify this parameter and the ent
+      #   @param trust [Increase::Models::EntityUpdateParams::Trust]
+      #     Details of the trust entity to update. If you specify this parameter and the
+      #     entity is not a trust, the request will fail.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -148,25 +163,36 @@ module Increase
         optional :website, String
 
         # @!method initialize(address: nil, email: nil, incorporation_state: nil, industry_code: nil, legal_identifier: nil, name: nil, website: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityUpdateParams::Corporation} for more details.
-        #
         #   Details of the corporation entity to update. If you specify this parameter and
         #   the entity is not a corporation, the request will fail.
         #
-        #   @param address [Increase::Models::EntityUpdateParams::Corporation::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #   @param address [Increase::Models::EntityUpdateParams::Corporation::Address]
+        #     The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #     are disallowed.
         #
-        #   @param email [String] An email address for the business. Not every program requires an email for submi
+        #   @param email [String]
+        #     An email address for the business. Not every program requires an email for
+        #     submitted Entities.
         #
-        #   @param incorporation_state [String] The two-letter United States Postal Service (USPS) abbreviation for the corporat
+        #   @param incorporation_state [String]
+        #     The two-letter United States Postal Service (USPS) abbreviation for the
+        #     corporation's state of incorporation.
         #
-        #   @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati
+        #   @param industry_code [String]
+        #     The North American Industry Classification System (NAICS) code for the
+        #     corporation's primary line of business. This is a number, like `5132` for
+        #     `Software Publishers`. A full list of classification codes is available
+        #     [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
         #
-        #   @param legal_identifier [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier] The legal identifier of the corporation. This is usually the Employer Identifica
+        #   @param legal_identifier [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier]
+        #     The legal identifier of the corporation. This is usually the Employer
+        #     Identification Number (EIN).
         #
         #   @param name [String] The legal name of the corporation.
         #
-        #   @param website [String] A website for the business. Not every program requires a website for submitted E
+        #   @param website [String]
+        #     A website for the business. Not every program requires a website for submitted
+        #     Entities.
 
         # @see Increase::Models::EntityUpdateParams::Corporation#address
         class Address < Increase::Internal::Type::BaseModel
@@ -208,9 +234,6 @@ module Increase
           optional :zip, String
 
           # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::EntityUpdateParams::Corporation::Address} for more details.
-          #
           #   The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           #   are disallowed.
           #
@@ -222,7 +245,9 @@ module Increase
           #
           #   @param line2 [String] The second line of the address. This might be the floor or room number.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
+          #   @param state [String]
+          #     The two-letter United States Postal Service (USPS) abbreviation for the US
+          #     state, province, or region of the address. Required in certain countries.
           #
           #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
         end
@@ -243,16 +268,15 @@ module Increase
           optional :category, enum: -> { Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category }
 
           # @!method initialize(value:, category: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier} for more
-          #   details.
-          #
           #   The legal identifier of the corporation. This is usually the Employer
           #   Identification Number (EIN).
           #
-          #   @param value [String] The legal identifier itself. For US Employer Identification Numbers, submit nine
+          #   @param value [String]
+          #     The legal identifier itself. For US Employer Identification Numbers, submit nine
+          #     digits with no dashes or other separators.
           #
-          #   @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category] The category of the legal identifier.
+          #   @param category [Symbol, Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier::Category]
+          #     The category of the legal identifier.
 
           # The category of the legal identifier.
           #
@@ -287,13 +311,12 @@ module Increase
         optional :name, String
 
         # @!method initialize(address: nil, name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityUpdateParams::GovernmentAuthority} for more details.
-        #
         #   Details of the government authority entity to update. If you specify this
         #   parameter and the entity is not a government authority, the request will fail.
         #
-        #   @param address [Increase::Models::EntityUpdateParams::GovernmentAuthority::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #   @param address [Increase::Models::EntityUpdateParams::GovernmentAuthority::Address]
+        #     The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #     are disallowed.
         #
         #   @param name [String] The legal name of the government authority.
 
@@ -331,10 +354,6 @@ module Increase
           optional :line2, String
 
           # @!method initialize(city:, line1:, state:, zip:, line2: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::EntityUpdateParams::GovernmentAuthority::Address} for more
-          #   details.
-          #
           #   The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           #   are disallowed.
           #
@@ -342,7 +361,9 @@ module Increase
           #
           #   @param line1 [String] The first line of the address. This is usually the street number and street.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param state [String]
+          #     The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #     the address.
           #
           #   @param zip [String] The ZIP code of the address.
           #
@@ -380,17 +401,21 @@ module Increase
         optional :name, String
 
         # @!method initialize(address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityUpdateParams::NaturalPerson} for more details.
-        #
         #   Details of the natural person entity to update. If you specify this parameter
         #   and the entity is not a natural person, the request will fail.
         #
-        #   @param address [Increase::Models::EntityUpdateParams::NaturalPerson::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #   @param address [Increase::Models::EntityUpdateParams::NaturalPerson::Address]
+        #     The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #     are disallowed.
         #
-        #   @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
+        #   @param confirmed_no_us_tax_id [Boolean]
+        #     The identification method for an individual can only be a passport, driver's
+        #     license, or other document if you've confirmed the individual does not have a US
+        #     tax id (either a Social Security Number or Individual Taxpayer Identification
+        #     Number).
         #
-        #   @param identification [Increase::Models::EntityUpdateParams::NaturalPerson::Identification] A means of verifying the person's identity.
+        #   @param identification [Increase::Models::EntityUpdateParams::NaturalPerson::Identification]
+        #     A means of verifying the person's identity.
         #
         #   @param name [String] The legal name of the natural person.
 
@@ -434,9 +459,6 @@ module Increase
           optional :zip, String
 
           # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::EntityUpdateParams::NaturalPerson::Address} for more details.
-          #
           #   The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           #   are disallowed.
           #
@@ -448,7 +470,9 @@ module Increase
           #
           #   @param line2 [String] The second line of the address. This might be the floor or room number.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
+          #   @param state [String]
+          #     The two-letter United States Postal Service (USPS) abbreviation for the US
+          #     state, province, or region of the address. Required in certain countries.
           #
           #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
         end
@@ -496,21 +520,29 @@ module Increase
           optional :passport, -> { Increase::EntityUpdateParams::NaturalPerson::Identification::Passport }
 
           # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::EntityUpdateParams::NaturalPerson::Identification} for more
-          #   details.
-          #
           #   A means of verifying the person's identity.
           #
-          #   @param method_ [Symbol, Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Method] A method that can be used to verify the individual's identity.
+          #   @param method_ [Symbol, Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Method]
+          #     A method that can be used to verify the individual's identity.
           #
-          #   @param number [String] An identification number that can be used to verify the individual's identity, s
+          #   @param number [String]
+          #     An identification number that can be used to verify the individual's identity,
+          #     such as a social security number. For Social Security Numbers and Individual
+          #     Taxpayer Identification Numbers, submit nine digits with no dashes or other
+          #     separators. When testing in sandbox, use one of our
+          #     [sandbox test values](https://increase.com/documentation/sandbox-test-values).
           #
-          #   @param drivers_license [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
+          #   @param drivers_license [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::DriversLicense]
+          #     Information about the United States driver's license used for identification.
+          #     Required if `method` is equal to `drivers_license`.
           #
-          #   @param other [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Other] Information about the identification document provided. Required if `method` is
+          #   @param other [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Other]
+          #     Information about the identification document provided. Required if `method` is
+          #     equal to `other`.
           #
-          #   @param passport [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Passport] Information about the passport used for identification. Required if `method` is
+          #   @param passport [Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Passport]
+          #     Information about the passport used for identification. Required if `method` is
+          #     equal to `passport`.
 
           # A method that can be used to verify the individual's identity.
           #
@@ -611,20 +643,20 @@ module Increase
             optional :expiration_date, Date
 
             # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Other} for
-            #   more details.
-            #
             #   Information about the identification document provided. Required if `method` is
             #   equal to `other`.
             #
-            #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+            #   @param country [String]
+            #     The two-character ISO 3166-1 code representing the country that issued the
+            #     document (e.g., `US`).
             #
             #   @param description [String] A description of the document submitted.
             #
             #   @param file_id [String] The identifier of the File containing the front of the document.
             #
-            #   @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
+            #   @param back_file_id [String]
+            #     The identifier of the File containing the back of the document. Not every
+            #     document has a reverse side.
             #
             #   @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
           end
@@ -651,14 +683,12 @@ module Increase
             required :file_id, String
 
             # @!method initialize(country:, expiration_date:, file_id:)
-            #   Some parameter documentations has been truncated, see
-            #   {Increase::Models::EntityUpdateParams::NaturalPerson::Identification::Passport}
-            #   for more details.
-            #
             #   Information about the passport used for identification. Required if `method` is
             #   equal to `passport`.
             #
-            #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+            #   @param country [String]
+            #     The two-character ISO 3166-1 code representing the country that issued the
+            #     document (e.g., `US`).
             #
             #   @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
             #
@@ -682,15 +712,15 @@ module Increase
         required :rating, enum: -> { Increase::EntityUpdateParams::RiskRating::Rating }
 
         # @!method initialize(rated_at:, rating:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityUpdateParams::RiskRating} for more details.
-        #
         #   An assessment of the entity’s potential risk of involvement in financial crimes,
         #   such as money laundering.
         #
-        #   @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
+        #   @param rated_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
+        #     rating was performed.
         #
-        #   @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating] The rating given to this entity.
+        #   @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating]
+        #     The rating given to this entity.
 
         # The rating given to this entity.
         #
@@ -732,9 +762,6 @@ module Increase
         required :terms_url, String
 
         # @!method initialize(agreed_at:, ip_address:, terms_url:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityUpdateParams::TermsAgreement} for more details.
-        #
         #   @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
         #
         #   @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
@@ -762,7 +789,8 @@ module Increase
         #
         #   @param reference [String] The reference identifier for the third party verification.
         #
-        #   @param vendor [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification.
+        #   @param vendor [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor]
+        #     The vendor that was used to perform the verification.
 
         # The vendor that was used to perform the verification.
         #
@@ -805,13 +833,12 @@ module Increase
         optional :name, String
 
         # @!method initialize(address: nil, name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EntityUpdateParams::Trust} for more details.
-        #
         #   Details of the trust entity to update. If you specify this parameter and the
         #   entity is not a trust, the request will fail.
         #
-        #   @param address [Increase::Models::EntityUpdateParams::Trust::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #   @param address [Increase::Models::EntityUpdateParams::Trust::Address]
+        #     The entity's physical address. Mail receiving locations like PO Boxes and PMB's
+        #     are disallowed.
         #
         #   @param name [String] The legal name of the trust.
 
@@ -849,9 +876,6 @@ module Increase
           optional :line2, String
 
           # @!method initialize(city:, line1:, state:, zip:, line2: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::EntityUpdateParams::Trust::Address} for more details.
-          #
           #   The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           #   are disallowed.
           #
@@ -859,7 +883,9 @@ module Increase
           #
           #   @param line1 [String] The first line of the address. This is usually the street number and street.
           #
-          #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #   @param state [String]
+          #     The two-letter United States Postal Service (USPS) abbreviation for the state of
+          #     the address.
           #
           #   @param zip [String] The ZIP code of the address.
           #

data/lib/increase/models/event.rb

@@ -43,9 +43,6 @@ module Increase
       required :type, enum: -> { Increase::Event::Type }
 
       # @!method initialize(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:)
-      #   Some parameter documentations has been truncated, see {Increase::Models::Event}
-      #   for more details.
-      #
       #   Events are records of things that happened to objects at Increase. Events are
       #   accessible via the List Events endpoint and can be delivered to your application
       #   via webhooks. For more information, see our
@@ -57,11 +54,15 @@ module Increase
       #
       #   @param associated_object_type [String] The type of the object that generated this Event.
       #
-      #   @param category [Symbol, Increase::Models::Event::Category] The category of the Event. We may add additional possible values for this enum o
+      #   @param category [Symbol, Increase::Models::Event::Category]
+      #     The category of the Event. We may add additional possible values for this enum
+      #     over time; your application should be able to handle such additions gracefully.
       #
       #   @param created_at [Time] The time the Event was created.
       #
-      #   @param type [Symbol, Increase::Models::Event::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::Event::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `event`.
 
       # The category of the Event. We may add additional possible values for this enum
       # over time; your application should be able to handle such additions gracefully.

data/lib/increase/models/event_list_params.rb

@@ -42,10 +42,8 @@ module Increase
       optional :order_by, -> { Increase::EventListParams::OrderBy }
 
       # @!method initialize(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, order_by: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EventListParams} for more details.
-      #
-      #   @param associated_object_id [String] Filter Events to those belonging to the object with the provided identifier.
+      #   @param associated_object_id [String]
+      #     Filter Events to those belonging to the object with the provided identifier.
       #
       #   @param category [Increase::Models::EventListParams::Category]
       #
@@ -53,7 +51,9 @@ module Increase
       #
       #   @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 order_by [Increase::Models::EventListParams::OrderBy]
       #
@@ -71,10 +71,10 @@ module Increase
                  api_name: :in
 
         # @!method initialize(in_: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::EventListParams::Category} for more details.
-        #
-        #   @param in_ [Array<Symbol, Increase::Models::EventListParams::Category::In>] Filter Events for those with the specified category or categories. For GET reque
+        #   @param in_ [Array<Symbol, Increase::Models::EventListParams::Category::In>]
+        #     Filter Events for those with the specified category or categories. 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
@@ -455,16 +455,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::EventListParams::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 OrderBy < Increase::Internal::Type::BaseModel
@@ -481,7 +486,8 @@ module Increase
         optional :field, enum: -> { Increase::EventListParams::OrderBy::Field }
 
         # @!method initialize(direction: nil, field: nil)
-        #   @param direction [Symbol, Increase::Models::EventListParams::OrderBy::Direction] The direction to order in.
+        #   @param direction [Symbol, Increase::Models::EventListParams::OrderBy::Direction]
+        #     The direction to order in.
         #
         #   @param field [Symbol, Increase::Models::EventListParams::OrderBy::Field] The field to order by.
 

data/lib/increase/models/event_subscription.rb

@@ -60,9 +60,6 @@ module Increase
       required :url, String
 
       # @!method initialize(id:, created_at:, idempotency_key:, oauth_connection_id:, selected_event_categories:, status:, type:, url:)
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EventSubscription} for more details.
-      #
       #   Webhooks are event notifications we send to you by HTTPS POST requests. Event
       #   Subscriptions are how you configure your application to listen for them. You can
       #   create an Event Subscription through your
@@ -74,15 +71,25 @@ module Increase
       #
       #   @param created_at [Time] The time the event subscription was created.
       #
-      #   @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 oauth_connection_id [String, nil] If specified, this subscription will only receive webhooks for Events associated
+      #   @param oauth_connection_id [String, nil]
+      #     If specified, this subscription will only receive webhooks for Events associated
+      #     with this OAuth Connection.
       #
-      #   @param selected_event_categories [Array<Increase::Models::EventSubscription::SelectedEventCategory>, nil] If specified, this subscription will only receive webhooks for Events with the s
+      #   @param selected_event_categories [Array<Increase::Models::EventSubscription::SelectedEventCategory>, nil]
+      #     If specified, this subscription will only receive webhooks for Events with the
+      #     specified `category`.
       #
-      #   @param status [Symbol, Increase::Models::EventSubscription::Status] This indicates if we'll send notifications to this subscription.
+      #   @param status [Symbol, Increase::Models::EventSubscription::Status]
+      #     This indicates if we'll send notifications to this subscription.
       #
-      #   @param type [Symbol, Increase::Models::EventSubscription::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::EventSubscription::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `event_subscription`.
       #
       #   @param url [String] The webhook url where we'll send notifications.
 
@@ -96,7 +103,8 @@ module Increase
                  nil?: true
 
         # @!method initialize(event_category:)
-        #   @param event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory::EventCategory, nil] The category of the Event.
+        #   @param event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory::EventCategory, nil]
+        #     The category of the Event.
 
         # The category of the Event.
         #

data/lib/increase/models/event_subscription_create_params.rb

@@ -43,18 +43,23 @@ module Increase
       optional :status, enum: -> { Increase::EventSubscriptionCreateParams::Status }
 
       # @!method initialize(url:, oauth_connection_id: nil, selected_event_categories: nil, shared_secret: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EventSubscriptionCreateParams} for more details.
-      #
       #   @param url [String] The URL you'd like us to send webhooks to.
       #
-      #   @param oauth_connection_id [String] If specified, this subscription will only receive webhooks for Events associated
+      #   @param oauth_connection_id [String]
+      #     If specified, this subscription will only receive webhooks for Events associated
+      #     with the specified OAuth Connection.
       #
-      #   @param selected_event_categories [Array<Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory>] If specified, this subscription will only receive webhooks for Events with the s
+      #   @param selected_event_categories [Array<Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory>]
+      #     If specified, this subscription will only receive webhooks for Events with the
+      #     specified `category`. If specifying a Real-Time Decision event category, only
+      #     one Event Category can be specified for the Event Subscription.
       #
-      #   @param shared_secret [String] The key that will be used to sign webhooks. If no value is passed, a random stri
+      #   @param shared_secret [String]
+      #     The key that will be used to sign webhooks. If no value is passed, a random
+      #     string will be used as default.
       #
-      #   @param status [Symbol, Increase::Models::EventSubscriptionCreateParams::Status] The status of the event subscription. Defaults to `active` if not specified.
+      #   @param status [Symbol, Increase::Models::EventSubscriptionCreateParams::Status]
+      #     The status of the event subscription. Defaults to `active` if not specified.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -67,7 +72,8 @@ module Increase
                  enum: -> { Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory }
 
         # @!method initialize(event_category:)
-        #   @param event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory] The category of the Event to subscribe to.
+        #   @param event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory]
+        #     The category of the Event to subscribe to.
 
         # The category of the Event to subscribe to.
         #

data/lib/increase/models/event_subscription_list_params.rb

@@ -30,14 +30,17 @@ module Increase
       optional :limit, Integer
 
       # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::EventSubscriptionListParams} 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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/increase/models/event_subscription_update_params.rb

@@ -22,7 +22,8 @@ module Increase
       # @!method initialize(event_subscription_id:, status: nil, request_options: {})
       #   @param event_subscription_id [String] The identifier of the Event Subscription.
       #
-      #   @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] The status to update the Event Subscription with.
+      #   @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status]
+      #     The status to update the Event Subscription with.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]