Skip to content

Commit feca69d

Browse files
stripe-openapi[bot]stripe-openapi[bot]
authored
Update generated code (#2222)
* Update generated code for v1328 * Update generated code for v1341 * Update generated code for v1347 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
1 parent d12717a commit feca69d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+489
-100
lines changed

‎OPENAPI_VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v1319
1+
v1347

‎src/apiVersion.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
// File generated from our OpenAPI spec
22

3-
export const ApiVersion = '2024-10-28.acacia';
3+
export const ApiVersion = '2024-11-20.acacia';

‎src/resources/TestHelpers/Issuing/Authorizations.ts

+5
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ export const Authorizations = StripeResource.extend({
2525
fullPath:
2626
'/v1/test_helpers/issuing/authorizations/{authorization}/increment',
2727
}),
28+
respond: stripeMethod({
29+
method: 'POST',
30+
fullPath:
31+
'/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond',
32+
}),
2833
reverse: stripeMethod({
2934
method: 'POST',
3035
fullPath: '/v1/test_helpers/issuing/authorizations/{authorization}/reverse',

‎test/resources/generated_examples_test.spec.js

+1-1
Large diffs are not rendered by default.

‎types/AccountSessions.d.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ declare module 'stripe' {
8484
/**
8585
* Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
8686
*/
87-
disable_stripe_user_authentication?: boolean;
87+
disable_stripe_user_authentication: boolean;
8888

8989
/**
9090
* Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
@@ -107,7 +107,7 @@ declare module 'stripe' {
107107
/**
108108
* Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
109109
*/
110-
disable_stripe_user_authentication?: boolean;
110+
disable_stripe_user_authentication: boolean;
111111

112112
/**
113113
* Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
@@ -130,7 +130,7 @@ declare module 'stripe' {
130130
/**
131131
* Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
132132
*/
133-
disable_stripe_user_authentication?: boolean;
133+
disable_stripe_user_authentication: boolean;
134134

135135
/**
136136
* Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
@@ -181,7 +181,7 @@ declare module 'stripe' {
181181
/**
182182
* Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
183183
*/
184-
disable_stripe_user_authentication?: boolean;
184+
disable_stripe_user_authentication: boolean;
185185

186186
/**
187187
* Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
@@ -270,7 +270,7 @@ declare module 'stripe' {
270270
/**
271271
* Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
272272
*/
273-
disable_stripe_user_authentication?: boolean;
273+
disable_stripe_user_authentication: boolean;
274274

275275
/**
276276
* Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.

‎types/Accounts.d.ts

+38-4
Original file line numberDiff line numberDiff line change
@@ -909,9 +909,9 @@ declare module 'stripe' {
909909
currently_due: Array<string> | null;
910910

911911
/**
912-
* This is typed as a string for consistency with `requirements.disabled_reason`.
912+
* This is typed as an enum for consistency with `requirements.disabled_reason`.
913913
*/
914-
disabled_reason: string | null;
914+
disabled_reason: FutureRequirements.DisabledReason | null;
915915

916916
/**
917917
* Fields that are `currently_due` and need to be collected again because validation or verification failed.
@@ -947,6 +947,23 @@ declare module 'stripe' {
947947
original_fields_due: Array<string>;
948948
}
949949

950+
type DisabledReason =
951+
| 'action_required.requested_capabilities'
952+
| 'listed'
953+
| 'other'
954+
| 'platform_paused'
955+
| 'rejected.fraud'
956+
| 'rejected.incomplete_verification'
957+
| 'rejected.listed'
958+
| 'rejected.other'
959+
| 'rejected.platform_fraud'
960+
| 'rejected.platform_other'
961+
| 'rejected.platform_terms_of_service'
962+
| 'rejected.terms_of_service'
963+
| 'requirements.past_due'
964+
| 'requirements.pending_verification'
965+
| 'under_review';
966+
950967
interface Error {
951968
/**
952969
* The code for the type of error.
@@ -1083,9 +1100,9 @@ declare module 'stripe' {
10831100
currently_due: Array<string> | null;
10841101

10851102
/**
1086-
* If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`.
1103+
* If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
10871104
*/
1088-
disabled_reason: string | null;
1105+
disabled_reason: Requirements.DisabledReason | null;
10891106

10901107
/**
10911108
* Fields that are `currently_due` and need to be collected again because validation or verification failed.
@@ -1121,6 +1138,23 @@ declare module 'stripe' {
11211138
original_fields_due: Array<string>;
11221139
}
11231140

1141+
type DisabledReason =
1142+
| 'action_required.requested_capabilities'
1143+
| 'listed'
1144+
| 'other'
1145+
| 'platform_paused'
1146+
| 'rejected.fraud'
1147+
| 'rejected.incomplete_verification'
1148+
| 'rejected.listed'
1149+
| 'rejected.other'
1150+
| 'rejected.platform_fraud'
1151+
| 'rejected.platform_other'
1152+
| 'rejected.platform_terms_of_service'
1153+
| 'rejected.terms_of_service'
1154+
| 'requirements.past_due'
1155+
| 'requirements.pending_verification'
1156+
| 'under_review';
1157+
11241158
interface Error {
11251159
/**
11261160
* The code for the type of error.

‎types/AccountsResource.d.ts

+15
Original file line numberDiff line numberDiff line change
@@ -3637,6 +3637,11 @@ declare module 'stripe' {
36373637
}
36383638

36393639
interface Relationship {
3640+
/**
3641+
* Whether the person is the authorizer of the account's representative.
3642+
*/
3643+
authorizer?: boolean;
3644+
36403645
/**
36413646
* Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
36423647
*/
@@ -3753,6 +3758,11 @@ declare module 'stripe' {
37533758

37543759
namespace AccountListPersonsParams {
37553760
interface Relationship {
3761+
/**
3762+
* A filter on the list of people returned based on whether these people are authorizers of the account's representative.
3763+
*/
3764+
authorizer?: boolean;
3765+
37563766
/**
37573767
* A filter on the list of people returned based on whether these people are directors of the account's company.
37583768
*/
@@ -4167,6 +4177,11 @@ declare module 'stripe' {
41674177
}
41684178

41694179
interface Relationship {
4180+
/**
4181+
* Whether the person is the authorizer of the account's representative.
4182+
*/
4183+
authorizer?: boolean;
4184+
41704185
/**
41714186
* Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
41724187
*/

‎types/Billing/CreditBalanceSummaryResource.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ declare module 'stripe' {
4141
namespace Filter {
4242
interface ApplicabilityScope {
4343
/**
44-
* The price type to which credit grants can apply to. We currently only support `metered` price type.
44+
* The price type for which credit grants can apply. We currently only support the `metered` price type.
4545
*/
4646
price_type: 'metered';
4747
}

‎types/Billing/CreditGrants.d.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ declare module 'stripe' {
77
* A credit grant is an API resource that documents the allocation of some billing credits to a customer.
88
*
99
* Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)
10-
* end
1110
*/
1211
interface CreditGrant {
1312
/**
@@ -25,7 +24,7 @@ declare module 'stripe' {
2524
applicability_config: CreditGrant.ApplicabilityConfig;
2625

2726
/**
28-
* The category of this credit grant. This is for tracking purposes and will not be displayed to the customer.
27+
* The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
2928
*/
3029
category: CreditGrant.Category;
3130

@@ -35,17 +34,17 @@ declare module 'stripe' {
3534
created: number;
3635

3736
/**
38-
* ID of the customer to whom the billing credits are granted.
37+
* ID of the customer receiving the billing credits.
3938
*/
4039
customer: string | Stripe.Customer | Stripe.DeletedCustomer;
4140

4241
/**
43-
* The time when the billing credits become effective i.e when they are eligible to be used.
42+
* The time when the billing credits become effective—when they're eligible for use.
4443
*/
4544
effective_at: number | null;
4645

4746
/**
48-
* The time when the billing credits will expire. If not present, the billing credits will never expire.
47+
* The time when the billing credits expire. If not present, the billing credits don't expire.
4948
*/
5049
expires_at: number | null;
5150

@@ -114,7 +113,7 @@ declare module 'stripe' {
114113
namespace ApplicabilityConfig {
115114
interface Scope {
116115
/**
117-
* The price type to which credit grants can apply to. We currently only support `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
116+
* The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
118117
*/
119118
price_type: 'metered';
120119
}

‎types/Billing/CreditGrantsResource.d.ts

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ declare module 'stripe' {
2020
category: CreditGrantCreateParams.Category;
2121

2222
/**
23-
* ID of the customer to whom the billing credits should be granted.
23+
* ID of the customer to receive the billing credits.
2424
*/
2525
customer: string;
2626

2727
/**
28-
* The time when the billing credits become effective i.e when they are eligible to be used. Defaults to the current timestamp if not specified.
28+
* The time when the billing credits become effective—when they're eligible for use. Defaults to the current timestamp if not specified.
2929
*/
3030
effective_at?: number;
3131

@@ -35,17 +35,17 @@ declare module 'stripe' {
3535
expand?: Array<string>;
3636

3737
/**
38-
* The time when the billing credits will expire. If not specified, the billing credits will never expire.
38+
* The time when the billing credits will expire. If not specified, the billing credits don't expire.
3939
*/
4040
expires_at?: number;
4141

4242
/**
43-
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (ex: cost basis) in a structured format.
43+
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
4444
*/
4545
metadata?: Stripe.MetadataParam;
4646

4747
/**
48-
* A descriptive name shown in dashboard.
48+
* A descriptive name shown in the Dashboard.
4949
*/
5050
name?: string;
5151
}
@@ -87,7 +87,7 @@ declare module 'stripe' {
8787
namespace ApplicabilityConfig {
8888
interface Scope {
8989
/**
90-
* The price type to which credit grants can apply to. We currently only support `metered` price type.
90+
* The price type for which credit grants can apply. We currently only support the `metered` price type.
9191
*/
9292
price_type: 'metered';
9393
}
@@ -110,12 +110,12 @@ declare module 'stripe' {
110110
expand?: Array<string>;
111111

112112
/**
113-
* The time when the billing credits created by this credit grant will expire. If set to empty, the billing credits will never expire.
113+
* The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.
114114
*/
115115
expires_at?: Stripe.Emptyable<number>;
116116

117117
/**
118-
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (ex: cost basis) in a structured format.
118+
* Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
119119
*/
120120
metadata?: Stripe.MetadataParam;
121121
}
@@ -178,7 +178,7 @@ declare module 'stripe' {
178178
): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
179179

180180
/**
181-
* Retrieve a list of credit grants
181+
* Retrieve a list of credit grants.
182182
*/
183183
list(
184184
params?: CreditGrantListParams,
@@ -189,7 +189,7 @@ declare module 'stripe' {
189189
): ApiListPromise<Stripe.Billing.CreditGrant>;
190190

191191
/**
192-
* Expires a credit grant
192+
* Expires a credit grant.
193193
*/
194194
expire(
195195
id: string,
@@ -202,7 +202,7 @@ declare module 'stripe' {
202202
): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
203203

204204
/**
205-
* Voids a credit grant
205+
* Voids a credit grant.
206206
*/
207207
voidGrant(
208208
id: string,

‎types/Billing/MeterEventsResource.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ declare module 'stripe' {
2222
expand?: Array<string>;
2323

2424
/**
25-
* A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.
25+
* A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
2626
*/
2727
identifier?: string;
2828

‎types/Charges.d.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ declare module 'stripe' {
725725
authorization_code: string | null;
726726

727727
/**
728-
* Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
728+
* Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
729729
*/
730730
brand: string | null;
731731

@@ -810,7 +810,7 @@ declare module 'stripe' {
810810
multicapture?: Card.Multicapture;
811811

812812
/**
813-
* Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
813+
* Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
814814
*/
815815
network: string | null;
816816

@@ -1106,7 +1106,7 @@ declare module 'stripe' {
11061106
amount_authorized: number | null;
11071107

11081108
/**
1109-
* Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1109+
* Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
11101110
*/
11111111
brand: string | null;
11121112

@@ -1188,7 +1188,7 @@ declare module 'stripe' {
11881188
last4: string | null;
11891189

11901190
/**
1191-
* Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1191+
* Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
11921192
*/
11931193
network: string | null;
11941194

@@ -1585,7 +1585,7 @@ declare module 'stripe' {
15851585
last4: string | null;
15861586

15871587
/**
1588-
* Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1588+
* Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
15891589
*/
15901590
network: string | null;
15911591

0 commit comments

Comments
 (0)