stripe 16.4.0-beta.1 → 16.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/CHANGELOG.md +130 -767
  2. package/README.md +0 -33
  3. package/VERSION +1 -1
  4. package/cjs/RequestSender.js +5 -66
  5. package/cjs/StripeResource.js +1 -1
  6. package/cjs/apiVersion.js +1 -2
  7. package/cjs/multipart.js +1 -1
  8. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  9. package/cjs/resources/Invoices.js +0 -13
  10. package/cjs/resources/OAuth.js +1 -1
  11. package/cjs/resources/PaymentIntents.js +0 -4
  12. package/cjs/resources/Quotes.js +0 -32
  13. package/cjs/resources/SubscriptionSchedules.js +0 -4
  14. package/cjs/resources/Terminal/Readers.js +0 -12
  15. package/cjs/resources.js +10 -38
  16. package/cjs/stripe.core.js +3 -6
  17. package/cjs/utils.js +3 -30
  18. package/esm/RequestSender.js +6 -67
  19. package/esm/StripeResource.js +2 -2
  20. package/esm/apiVersion.js +0 -1
  21. package/esm/multipart.js +2 -2
  22. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  23. package/esm/resources/Invoices.js +0 -13
  24. package/esm/resources/OAuth.js +2 -2
  25. package/esm/resources/PaymentIntents.js +0 -4
  26. package/esm/resources/Quotes.js +0 -32
  27. package/esm/resources/SubscriptionSchedules.js +0 -4
  28. package/esm/resources/Terminal/Readers.js +0 -12
  29. package/esm/resources.js +0 -24
  30. package/esm/stripe.core.js +3 -6
  31. package/esm/utils.js +1 -27
  32. package/package.json +1 -1
  33. package/types/AccountLinksResource.d.ts +1 -5
  34. package/types/AccountSessions.d.ts +0 -15
  35. package/types/AccountSessionsResource.d.ts +0 -205
  36. package/types/Accounts.d.ts +1 -88
  37. package/types/AccountsResource.d.ts +0 -204
  38. package/types/Charges.d.ts +0 -67
  39. package/types/ChargesResource.d.ts +0 -1294
  40. package/types/Checkout/Sessions.d.ts +1 -28
  41. package/types/Checkout/SessionsResource.d.ts +1 -15
  42. package/types/ConfirmationTokens.d.ts +5 -62
  43. package/types/Coupons.d.ts +1 -1
  44. package/types/CouponsResource.d.ts +1 -1
  45. package/types/CreditNotes.d.ts +0 -21
  46. package/types/CreditNotesResource.d.ts +0 -51
  47. package/types/CustomersResource.d.ts +0 -2
  48. package/types/Disputes.d.ts +0 -168
  49. package/types/DisputesResource.d.ts +3 -120
  50. package/types/EventTypes.d.ts +17 -426
  51. package/types/Events.d.ts +1 -83
  52. package/types/EventsResource.d.ts +1 -1
  53. package/types/FinancialConnections/Accounts.d.ts +1 -29
  54. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  55. package/types/FinancialConnections/Sessions.d.ts +1 -49
  56. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  57. package/types/Identity/VerificationReports.d.ts +1 -1
  58. package/types/InvoiceItems.d.ts +0 -5
  59. package/types/InvoiceItemsResource.d.ts +0 -98
  60. package/types/InvoiceLineItems.d.ts +0 -22
  61. package/types/Invoices.d.ts +2 -116
  62. package/types/InvoicesResource.d.ts +1784 -5359
  63. package/types/Issuing/CardholdersResource.d.ts +1 -2
  64. package/types/LineItems.d.ts +0 -7
  65. package/types/Mandates.d.ts +0 -77
  66. package/types/PaymentIntents.d.ts +1 -469
  67. package/types/PaymentIntentsResource.d.ts +3377 -6725
  68. package/types/PaymentMethodDomains.d.ts +1 -1
  69. package/types/PaymentMethods.d.ts +0 -62
  70. package/types/PaymentMethodsResource.d.ts +0 -110
  71. package/types/Prices.d.ts +0 -22
  72. package/types/PricesResource.d.ts +0 -22
  73. package/types/Products.d.ts +0 -39
  74. package/types/ProductsResource.d.ts +0 -36
  75. package/types/Quotes.d.ts +1 -578
  76. package/types/QuotesResource.d.ts +266 -3175
  77. package/types/SetupAttempts.d.ts +0 -9
  78. package/types/SetupIntents.d.ts +1 -110
  79. package/types/SetupIntentsResource.d.ts +3 -498
  80. package/types/Sources.d.ts +0 -23
  81. package/types/SubscriptionItems.d.ts +0 -21
  82. package/types/SubscriptionItemsResource.d.ts +0 -109
  83. package/types/SubscriptionSchedules.d.ts +0 -164
  84. package/types/SubscriptionSchedulesResource.d.ts +13 -1231
  85. package/types/Subscriptions.d.ts +3 -47
  86. package/types/SubscriptionsResource.d.ts +6 -349
  87. package/types/Terminal/Readers.d.ts +2 -279
  88. package/types/Terminal/ReadersResource.d.ts +1 -208
  89. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -55
  90. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  91. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  92. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  93. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  94. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  95. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  96. package/types/WebhookEndpointsResource.d.ts +2 -50
  97. package/types/index.d.ts +0 -64
  98. package/types/lib.d.ts +0 -12
  99. package/cjs/resources/AccountNotices.js +0 -21
  100. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  101. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  102. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  103. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  104. package/cjs/resources/GiftCards/Cards.js +0 -23
  105. package/cjs/resources/GiftCards/Transactions.js +0 -33
  106. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  107. package/cjs/resources/Margins.js +0 -22
  108. package/cjs/resources/Orders.js +0 -24
  109. package/cjs/resources/QuotePhases.js +0 -22
  110. package/cjs/resources/Tax/Forms.js +0 -20
  111. package/esm/resources/AccountNotices.js +0 -18
  112. package/esm/resources/Capital/FinancingOffers.js +0 -18
  113. package/esm/resources/Capital/FinancingSummary.js +0 -9
  114. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  115. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  116. package/esm/resources/GiftCards/Cards.js +0 -20
  117. package/esm/resources/GiftCards/Transactions.js +0 -30
  118. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  119. package/esm/resources/Margins.js +0 -19
  120. package/esm/resources/Orders.js +0 -21
  121. package/esm/resources/QuotePhases.js +0 -19
  122. package/esm/resources/Tax/Forms.js +0 -17
  123. package/types/AccountNotices.d.ts +0 -110
  124. package/types/AccountNoticesResource.d.ts +0 -98
  125. package/types/Capital/FinancingOffers.d.ts +0 -188
  126. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  127. package/types/Capital/FinancingSummary.d.ts +0 -106
  128. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  129. package/types/Capital/FinancingTransactions.d.ts +0 -135
  130. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  131. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  132. package/types/FinancialConnections/Institutions.d.ts +0 -93
  133. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  134. package/types/GiftCards/Cards.d.ts +0 -118
  135. package/types/GiftCards/CardsResource.d.ts +0 -159
  136. package/types/GiftCards/Transactions.d.ts +0 -129
  137. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  138. package/types/InvoicePayments.d.ts +0 -91
  139. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -446
  140. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1017
  141. package/types/Margins.d.ts +0 -56
  142. package/types/MarginsResource.d.ts +0 -114
  143. package/types/Orders.d.ts +0 -1057
  144. package/types/OrdersResource.d.ts +0 -2711
  145. package/types/QuoteLines.d.ts +0 -634
  146. package/types/QuotePhases.d.ts +0 -198
  147. package/types/QuotePhasesResource.d.ts +0 -67
  148. package/types/QuotePreviewInvoices.d.ts +0 -1530
  149. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -778
  150. package/types/Tax/Forms.d.ts +0 -133
  151. package/types/Tax/FormsResource.d.ts +0 -90
@@ -1,68 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Capital {
6
- interface FinancingTransactionRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- interface FinancingTransactionListParams extends PaginationParams {
14
- /**
15
- * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
16
- */
17
- charge?: string;
18
-
19
- /**
20
- * Specifies which fields in the response should be expanded.
21
- */
22
- expand?: Array<string>;
23
-
24
- /**
25
- * Returns transactions that were created that apply to this financing offer ID.
26
- */
27
- financing_offer?: string;
28
-
29
- /**
30
- * Only returns transactions that are responsible for reversing this financing transaction ID.
31
- */
32
- reversed_transaction?: string;
33
-
34
- /**
35
- * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
36
- */
37
- treasury_transaction?: string;
38
- }
39
-
40
- class FinancingTransactionsResource {
41
- /**
42
- * Retrieves a financing transaction for a financing offer.
43
- */
44
- retrieve(
45
- id: string,
46
- params?: FinancingTransactionRetrieveParams,
47
- options?: RequestOptions
48
- ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
49
- retrieve(
50
- id: string,
51
- options?: RequestOptions
52
- ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
53
-
54
- /**
55
- * Returns a list of financing transactions. The transactions are returned in sorted order,
56
- * with the most recent transactions appearing first.
57
- */
58
- list(
59
- params?: FinancingTransactionListParams,
60
- options?: RequestOptions
61
- ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
62
- list(
63
- options?: RequestOptions
64
- ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
65
- }
66
- }
67
- }
68
- }
@@ -1,38 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace FinancialConnections {
6
- /**
7
- * A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
8
- */
9
- interface AccountInferredBalance {
10
- /**
11
- * Unique identifier for the object.
12
- */
13
- id: string;
14
-
15
- /**
16
- * String representing the object's type. Objects of the same type share the same value.
17
- */
18
- object: 'financial_connections.account_inferred_balance';
19
-
20
- /**
21
- * The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
22
- */
23
- as_of: number;
24
-
25
- /**
26
- * The balances owed to (or by) the account holder.
27
- *
28
- * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
29
- *
30
- * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
31
- */
32
- current: {
33
- [key: string]: number;
34
- };
35
- }
36
- }
37
- }
38
- }
@@ -1,93 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace FinancialConnections {
6
- /**
7
- * An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
8
- */
9
- interface Institution {
10
- /**
11
- * Unique identifier for the object.
12
- */
13
- id: string;
14
-
15
- /**
16
- * String representing the object's type. Objects of the same type share the same value.
17
- */
18
- object: 'financial_connections.institution';
19
-
20
- features: Institution.Features;
21
-
22
- /**
23
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
24
- */
25
- livemode: boolean;
26
-
27
- /**
28
- * The name of this institution.
29
- */
30
- name: string;
31
-
32
- /**
33
- * A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
34
- */
35
- routing_numbers: Array<string>;
36
-
37
- /**
38
- * The status of this institution in the Financial Connections authentication flow.
39
- */
40
- status: Institution.Status;
41
-
42
- /**
43
- * A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
44
- */
45
- url: string | null;
46
- }
47
-
48
- namespace Institution {
49
- interface Features {
50
- balances: Features.Balances;
51
-
52
- ownership: Features.Ownership;
53
-
54
- payment_method: Features.PaymentMethod;
55
-
56
- transactions: Features.Transactions;
57
- }
58
-
59
- namespace Features {
60
- interface Balances {
61
- /**
62
- * Whether the given feature is supported by this institution.
63
- */
64
- supported: boolean;
65
- }
66
-
67
- interface Ownership {
68
- /**
69
- * Whether the given feature is supported by this institution.
70
- */
71
- supported: boolean;
72
- }
73
-
74
- interface PaymentMethod {
75
- /**
76
- * Whether the given feature is supported by this institution.
77
- */
78
- supported: boolean;
79
- }
80
-
81
- interface Transactions {
82
- /**
83
- * Whether the given feature is supported by this institution.
84
- */
85
- supported: boolean;
86
- }
87
- }
88
-
89
- type Status = 'active' | 'degraded' | 'inactive';
90
- }
91
- }
92
- }
93
- }
@@ -1,47 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace FinancialConnections {
6
- interface InstitutionRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- interface InstitutionListParams extends PaginationParams {
14
- /**
15
- * Specifies which fields in the response should be expanded.
16
- */
17
- expand?: Array<string>;
18
- }
19
-
20
- class InstitutionsResource {
21
- /**
22
- * Retrieves the details of a Financial Connections Institution.
23
- */
24
- retrieve(
25
- id: string,
26
- params?: InstitutionRetrieveParams,
27
- options?: RequestOptions
28
- ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
29
- retrieve(
30
- id: string,
31
- options?: RequestOptions
32
- ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
33
-
34
- /**
35
- * Returns a list of Financial Connections Institution objects.
36
- */
37
- list(
38
- params?: InstitutionListParams,
39
- options?: RequestOptions
40
- ): ApiListPromise<Stripe.FinancialConnections.Institution>;
41
- list(
42
- options?: RequestOptions
43
- ): ApiListPromise<Stripe.FinancialConnections.Institution>;
44
- }
45
- }
46
- }
47
- }
@@ -1,118 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace GiftCards {
6
- /**
7
- * A gift card represents a single gift card owned by a customer, including the
8
- * remaining balance, gift card code, and whether or not it is active.
9
- */
10
- interface Card {
11
- /**
12
- * Unique identifier for the object.
13
- */
14
- id: string;
15
-
16
- /**
17
- * String representing the object's type. Objects of the same type share the same value.
18
- */
19
- object: 'gift_cards.card';
20
-
21
- /**
22
- * Whether this gift card can be used or not.
23
- */
24
- active: boolean;
25
-
26
- /**
27
- * The amount of funds available for new transactions.
28
- */
29
- amount_available: number;
30
-
31
- /**
32
- * The amount of funds marked as held.
33
- */
34
- amount_held: number;
35
-
36
- /**
37
- * Code used to redeem this gift card.
38
- */
39
- code?: string | null;
40
-
41
- /**
42
- * Time at which the object was created. Measured in seconds since the Unix epoch.
43
- */
44
- created: number;
45
-
46
- /**
47
- * The related Stripe objects that created this gift card.
48
- */
49
- created_by: Card.CreatedBy | null;
50
-
51
- /**
52
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
53
- */
54
- currency: string;
55
-
56
- /**
57
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
58
- */
59
- metadata: Stripe.Metadata | null;
60
-
61
- /**
62
- * Transactions on this gift card.
63
- */
64
- transactions?: ApiList<Stripe.GiftCards.Transaction>;
65
- }
66
-
67
- namespace Card {
68
- interface CreatedBy {
69
- checkout?: CreatedBy.Checkout;
70
-
71
- order?: CreatedBy.Order;
72
-
73
- payment?: CreatedBy.Payment;
74
-
75
- /**
76
- * The type of event that created this object.
77
- */
78
- type: CreatedBy.Type;
79
- }
80
-
81
- namespace CreatedBy {
82
- interface Checkout {
83
- /**
84
- * The Stripe CheckoutSession that created this object.
85
- */
86
- checkout_session: string;
87
-
88
- /**
89
- * The Stripe CheckoutSession LineItem that created this object.
90
- */
91
- line_item: string | null;
92
- }
93
-
94
- interface Order {
95
- /**
96
- * The Stripe Order LineItem that created this object.
97
- */
98
- line_item: string | null;
99
-
100
- /**
101
- * The Stripe Order that created this object.
102
- */
103
- order: string;
104
- }
105
-
106
- interface Payment {
107
- /**
108
- * The PaymentIntent that created this object.
109
- */
110
- payment_intent: string;
111
- }
112
-
113
- type Type = 'checkout' | 'order' | 'payment';
114
- }
115
- }
116
- }
117
- }
118
- }
@@ -1,159 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace GiftCards {
6
- interface CardCreateParams {
7
- /**
8
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
9
- */
10
- currency: string;
11
-
12
- /**
13
- * The active state for the new gift card, defaults to false. The active state can be updated after creation.
14
- */
15
- active?: boolean;
16
-
17
- /**
18
- * Related objects which created this gift card.
19
- */
20
- created_by?: CardCreateParams.CreatedBy;
21
-
22
- /**
23
- * Specifies which fields in the response should be expanded.
24
- */
25
- expand?: Array<string>;
26
-
27
- /**
28
- * The initial amount to load onto the new gift card, defaults to 0.
29
- */
30
- initial_amount?: number;
31
-
32
- /**
33
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
34
- */
35
- metadata?: Stripe.MetadataParam;
36
- }
37
-
38
- namespace CardCreateParams {
39
- interface CreatedBy {
40
- /**
41
- * The details for the payment that created this object.
42
- */
43
- payment: CreatedBy.Payment;
44
-
45
- /**
46
- * The type of event that created this object.
47
- */
48
- type: 'payment';
49
- }
50
-
51
- namespace CreatedBy {
52
- interface Payment {
53
- /**
54
- * The PaymentIntent used to collect payment for this object.
55
- */
56
- payment_intent: string;
57
- }
58
- }
59
- }
60
-
61
- interface CardRetrieveParams {
62
- /**
63
- * Specifies which fields in the response should be expanded.
64
- */
65
- expand?: Array<string>;
66
- }
67
-
68
- interface CardUpdateParams {
69
- /**
70
- * The new active state for the gift card.
71
- */
72
- active?: boolean;
73
-
74
- /**
75
- * Specifies which fields in the response should be expanded.
76
- */
77
- expand?: Array<string>;
78
-
79
- /**
80
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
81
- */
82
- metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
83
- }
84
-
85
- interface CardListParams extends PaginationParams {
86
- /**
87
- * Specifies which fields in the response should be expanded.
88
- */
89
- expand?: Array<string>;
90
- }
91
-
92
- interface CardValidateParams {
93
- /**
94
- * The gift card code to be validated.
95
- */
96
- code: string;
97
-
98
- /**
99
- * Specifies which fields in the response should be expanded.
100
- */
101
- expand?: Array<string>;
102
-
103
- /**
104
- * The pin associated with the gift card. Not all gift cards have pins.
105
- */
106
- giftcard_pin?: string;
107
- }
108
-
109
- class CardsResource {
110
- /**
111
- * Creates a new gift card object.
112
- */
113
- create(
114
- params: CardCreateParams,
115
- options?: RequestOptions
116
- ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
117
-
118
- /**
119
- * Retrieve a gift card by id
120
- */
121
- retrieve(
122
- id: string,
123
- params?: CardRetrieveParams,
124
- options?: RequestOptions
125
- ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
126
- retrieve(
127
- id: string,
128
- options?: RequestOptions
129
- ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
130
-
131
- /**
132
- * Update a gift card
133
- */
134
- update(
135
- id: string,
136
- params?: CardUpdateParams,
137
- options?: RequestOptions
138
- ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
139
-
140
- /**
141
- * List gift cards for an account
142
- */
143
- list(
144
- params?: CardListParams,
145
- options?: RequestOptions
146
- ): ApiListPromise<Stripe.GiftCards.Card>;
147
- list(options?: RequestOptions): ApiListPromise<Stripe.GiftCards.Card>;
148
-
149
- /**
150
- * Validates a gift card code, returning the matching gift card object if it exists.
151
- */
152
- validate(
153
- params: CardValidateParams,
154
- options?: RequestOptions
155
- ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
156
- }
157
- }
158
- }
159
- }
@@ -1,129 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace GiftCards {
6
- /**
7
- * A gift card transaction represents a single transaction on a referenced gift card.
8
- * A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
9
- * transaction is one that has added/deducted funds. A `held` transaction has created a
10
- * temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
11
- * can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
12
- * A `canceled` transaction has no effect on a gift card's balance.
13
- */
14
- interface Transaction {
15
- /**
16
- * Unique identifier for the object.
17
- */
18
- id: string;
19
-
20
- /**
21
- * String representing the object's type. Objects of the same type share the same value.
22
- */
23
- object: 'gift_cards.transaction';
24
-
25
- /**
26
- * The amount of this transaction. A positive value indicates that funds were added to the gift card. A negative value indicates that funds were removed from the gift card.
27
- */
28
- amount: number | null;
29
-
30
- /**
31
- * Time at which the transaction was confirmed. Measured in seconds since the Unix epoch.
32
- */
33
- confirmed_at: number | null;
34
-
35
- /**
36
- * Time at which the object was created. Measured in seconds since the Unix epoch.
37
- */
38
- created: number | null;
39
-
40
- /**
41
- * The related Stripe objects that created this gift card transaction.
42
- */
43
- created_by: Transaction.CreatedBy | null;
44
-
45
- /**
46
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
47
- */
48
- currency: string | null;
49
-
50
- /**
51
- * An arbitrary string attached to the object. Often useful for displaying to users.
52
- */
53
- description: string | null;
54
-
55
- /**
56
- * The gift card that this transaction occurred on
57
- */
58
- gift_card: string | null;
59
-
60
- /**
61
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
62
- */
63
- metadata: Stripe.Metadata | null;
64
-
65
- /**
66
- * Status of this transaction, one of `held`, `confirmed`, or `canceled`.
67
- */
68
- status: Transaction.Status | null;
69
-
70
- /**
71
- * A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
72
- */
73
- transfer_group: string | null;
74
- }
75
-
76
- namespace Transaction {
77
- interface CreatedBy {
78
- checkout?: CreatedBy.Checkout;
79
-
80
- order?: CreatedBy.Order;
81
-
82
- payment?: CreatedBy.Payment;
83
-
84
- /**
85
- * The type of event that created this object.
86
- */
87
- type: CreatedBy.Type;
88
- }
89
-
90
- namespace CreatedBy {
91
- interface Checkout {
92
- /**
93
- * The Stripe CheckoutSession that created this object.
94
- */
95
- checkout_session: string;
96
-
97
- /**
98
- * The Stripe CheckoutSession LineItem that created this object.
99
- */
100
- line_item: string | null;
101
- }
102
-
103
- interface Order {
104
- /**
105
- * The Stripe Order LineItem that created this object.
106
- */
107
- line_item: string | null;
108
-
109
- /**
110
- * The Stripe Order that created this object.
111
- */
112
- order: string;
113
- }
114
-
115
- interface Payment {
116
- /**
117
- * The PaymentIntent that created this object.
118
- */
119
- payment_intent: string;
120
- }
121
-
122
- type Type = 'checkout' | 'order' | 'payment';
123
- }
124
-
125
- type Status = 'canceled' | 'confirmed' | 'held' | 'invalid';
126
- }
127
- }
128
- }
129
- }