@stripe/extensibility-api-objects 0.3.3 → 1.0.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.
- package/README.md +21 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# @stripe/extensibility-api-objects
|
|
2
|
+
|
|
3
|
+
Auto-generated TypeScript type definitions for Stripe API objects.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @stripe/extensibility-api-objects
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Import any Stripe API object type directly:
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { Customer, PaymentIntent } from '@stripe/extensibility-api-objects';
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
These types are generated from the Stripe OpenAPI specification. In the extensibility SDK, they are used to declare typed object references from custom objects (e.g. `Ref<Customer>`).
|
|
20
|
+
|
|
21
|
+
Each type corresponds to a [Stripe API resource](https://docs.stripe.com/api). See the Stripe API reference for field-level documentation.
|