Skip to content

Commit e999dc1

Browse files
docs: Update field descriptions for character limits and allowlist requirements
1 parent eac11a4 commit e999dc1

13 files changed

Lines changed: 45 additions & 21 deletions

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 190
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-8aac2690599ec7343fab3957433e94ebf63ac1186c753e00dff85b32f4d6e88c.yml
3-
openapi_spec_hash: 84da9d0725e41cb5661c6ed6661ce101
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-17c04dd1b0508b380c21e3acc3d4cd1e86b590f81d14fa26d1973b236f660e38.yml
3+
openapi_spec_hash: f8ddee07358d2c938450a6889fbf7940
44
config_hash: 400b9afe0f7f7b7d96177d05950775f9

lib/lithic/models/account_holder_create_params.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ class KYBDelegated < Lithic::Internal::Type::BaseModel
7575

7676
# @!attribute nature_of_business
7777
# Short description of the company's line of business (i.e., what does the company
78-
# do?).
78+
# do?). Values longer than 255 characters will be truncated before KYB
79+
# verification
7980
#
8081
# @return [String, nil]
8182
optional :nature_of_business, String

lib/lithic/models/account_holder_update_params.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ class KYBPatchRequest < Lithic::Internal::Type::BaseModel
8787

8888
# @!attribute nature_of_business
8989
# Short description of the company's line of business (i.e., what does the company
90-
# do?).
90+
# do?). Values longer than 255 characters will be truncated before KYB
91+
# verification
9192
#
9293
# @return [String, nil]
9394
optional :nature_of_business, String

lib/lithic/models/account_holder_updated_webhook_event.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ class KYBPayload < Lithic::Internal::Type::BaseModel
5050

5151
# @!attribute nature_of_business
5252
# Short description of the company's line of business (i.e., what does the company
53-
# do?).
53+
# do?). Values longer than 255 characters will be truncated before KYB
54+
# verification
5455
#
5556
# @return [String, nil]
5657
optional :nature_of_business, String

lib/lithic/models/carrier.rb

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@ module Lithic
44
module Models
55
class Carrier < Lithic::Internal::Type::BaseModel
66
# @!attribute qr_code_url
7-
# QR code url to display on the card carrier
7+
# QR code URL to display on the card carrier. The `qr_code_url` field requires
8+
# your domain to be allowlisted by Lithic before use. Contact Support to configure
9+
# your QR code domain
810
#
911
# @return [String, nil]
1012
optional :qr_code_url, String
1113

1214
# @!method initialize(qr_code_url: nil)
13-
# @param qr_code_url [String] QR code url to display on the card carrier
15+
# Some parameter documentations has been truncated, see {Lithic::Models::Carrier}
16+
# for more details.
17+
#
18+
# @param qr_code_url [String] QR code URL to display on the card carrier. The `qr_code_url` field requires you
1419
end
1520
end
1621
end

lib/lithic/models/kyb.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ class KYB < Lithic::Internal::Type::BaseModel
3737

3838
# @!attribute nature_of_business
3939
# Short description of the company's line of business (i.e., what does the company
40-
# do?).
40+
# do?). Values longer than 255 characters will be truncated before KYB
41+
# verification
4142
#
4243
# @return [String]
4344
required :nature_of_business, String

lib/lithic/models/parsed_webhook_event.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,8 @@ class KYBPayload < Lithic::Internal::Type::BaseModel
170170

171171
# @!attribute nature_of_business
172172
# Short description of the company's line of business (i.e., what does the company
173-
# do?).
173+
# do?). Values longer than 255 characters will be truncated before KYB
174+
# verification
174175
#
175176
# @return [String, nil]
176177
optional :nature_of_business, String

rbi/lithic/models/account_holder_create_params.rbi

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,8 @@ module Lithic
162162
attr_writer :naics_code
163163

164164
# Short description of the company's line of business (i.e., what does the company
165-
# do?).
165+
# do?). Values longer than 255 characters will be truncated before KYB
166+
# verification
166167
sig { returns(T.nilable(String)) }
167168
attr_reader :nature_of_business
168169

@@ -248,7 +249,8 @@ module Lithic
248249
# business.
249250
naics_code: nil,
250251
# Short description of the company's line of business (i.e., what does the company
251-
# do?).
252+
# do?). Values longer than 255 characters will be truncated before KYB
253+
# verification
252254
nature_of_business: nil,
253255
# An RFC 3339 timestamp indicating when the account holder accepted the applicable
254256
# legal agreements (e.g., cardholder terms) as agreed upon during API customer's

rbi/lithic/models/account_holder_update_params.rbi

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,8 @@ module Lithic
173173
attr_writer :naics_code
174174

175175
# Short description of the company's line of business (i.e., what does the company
176-
# do?).
176+
# do?). Values longer than 255 characters will be truncated before KYB
177+
# verification
177178
sig { returns(T.nilable(String)) }
178179
attr_reader :nature_of_business
179180

@@ -231,7 +232,8 @@ module Lithic
231232
# business.
232233
naics_code: nil,
233234
# Short description of the company's line of business (i.e., what does the company
234-
# do?).
235+
# do?). Values longer than 255 characters will be truncated before KYB
236+
# verification
235237
nature_of_business: nil,
236238
# Company website URL.
237239
website_url: nil

rbi/lithic/models/account_holder_updated_webhook_event.rbi

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ module Lithic
7979
attr_writer :naics_code
8080

8181
# Short description of the company's line of business (i.e., what does the company
82-
# do?).
82+
# do?). Values longer than 255 characters will be truncated before KYB
83+
# verification
8384
sig { returns(T.nilable(String)) }
8485
attr_reader :nature_of_business
8586

@@ -121,7 +122,8 @@ module Lithic
121122
# business. Only present if naics_code was included in the update request.
122123
naics_code: nil,
123124
# Short description of the company's line of business (i.e., what does the company
124-
# do?).
125+
# do?). Values longer than 255 characters will be truncated before KYB
126+
# verification
125127
nature_of_business: nil,
126128
# Company website URL.
127129
website_url: nil

0 commit comments

Comments
 (0)