@connectedxm/admin-sdk 10.6.0 → 10.7.1
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/.openapi-generator/FILES +8 -0
- package/README.md +2 -2
- package/api.ts +581 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +358 -1
- package/dist/api.js +360 -26
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +358 -1
- package/dist/esm/api.js +335 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/AccountsApi.md +64 -0
- package/docs/BasePaymentIntent.md +96 -0
- package/docs/BasePaymentIntentIntegration.md +22 -0
- package/docs/BasePaymentIntentLineItem.md +62 -0
- package/docs/BasePaymentIntentTaxIntegration.md +22 -0
- package/docs/GetAccountPaymentIntents200Response.md +26 -0
- package/docs/GetPaymentIntent200Response.md +24 -0
- package/docs/OrganizationPaymentsApi.md +165 -0
- package/docs/PaymentIntent.md +116 -0
- package/docs/PaymentIntentSource.md +22 -0
- package/package.json +1 -1
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# BasePaymentIntent
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**source** | [**PaymentIntentSource**](PaymentIntentSource.md) | | [default to undefined]
|
|
10
|
+
**integrationId** | **number** | | [default to undefined]
|
|
11
|
+
**accountId** | **string** | | [default to undefined]
|
|
12
|
+
**description** | **string** | | [default to undefined]
|
|
13
|
+
**referenceId** | **string** | | [default to undefined]
|
|
14
|
+
**currency** | **string** | | [default to undefined]
|
|
15
|
+
**metadata** | **object** | | [default to undefined]
|
|
16
|
+
**eventId** | **string** | | [default to undefined]
|
|
17
|
+
**registrationId** | **string** | | [default to undefined]
|
|
18
|
+
**sessionId** | **string** | | [default to undefined]
|
|
19
|
+
**passId** | **string** | | [default to undefined]
|
|
20
|
+
**passTypeId** | **string** | | [default to undefined]
|
|
21
|
+
**placeId** | **string** | | [default to undefined]
|
|
22
|
+
**spaceId** | **string** | | [default to undefined]
|
|
23
|
+
**couponId** | **string** | | [default to undefined]
|
|
24
|
+
**invoiceId** | **string** | | [default to undefined]
|
|
25
|
+
**seriesId** | **string** | | [default to undefined]
|
|
26
|
+
**address1** | **string** | | [default to undefined]
|
|
27
|
+
**address2** | **string** | | [default to undefined]
|
|
28
|
+
**city** | **string** | | [default to undefined]
|
|
29
|
+
**state** | **string** | | [default to undefined]
|
|
30
|
+
**country** | **string** | | [default to undefined]
|
|
31
|
+
**zip** | **string** | | [default to undefined]
|
|
32
|
+
**locationAddress1** | **string** | | [default to undefined]
|
|
33
|
+
**locationAddress2** | **string** | | [default to undefined]
|
|
34
|
+
**locationCity** | **string** | | [default to undefined]
|
|
35
|
+
**locationState** | **string** | | [default to undefined]
|
|
36
|
+
**locationCountry** | **string** | | [default to undefined]
|
|
37
|
+
**locationZip** | **string** | | [default to undefined]
|
|
38
|
+
**salesTax** | **number** | | [default to undefined]
|
|
39
|
+
**salesTaxRate** | **string** | | [default to undefined]
|
|
40
|
+
**deferredAmount** | **number** | | [default to undefined]
|
|
41
|
+
**deferredDueDate** | **string** | | [default to undefined]
|
|
42
|
+
**createdAt** | **string** | | [default to undefined]
|
|
43
|
+
**lineItems** | [**Array<BasePaymentIntentLineItem>**](BasePaymentIntentLineItem.md) | | [default to undefined]
|
|
44
|
+
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
45
|
+
**integration** | [**BasePaymentIntentIntegration**](BasePaymentIntentIntegration.md) | | [default to undefined]
|
|
46
|
+
**taxIntegration** | [**BasePaymentIntentTaxIntegration**](BasePaymentIntentTaxIntegration.md) | | [default to undefined]
|
|
47
|
+
|
|
48
|
+
## Example
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
import { BasePaymentIntent } from '@connectedxm/admin-sdk';
|
|
52
|
+
|
|
53
|
+
const instance: BasePaymentIntent = {
|
|
54
|
+
id,
|
|
55
|
+
source,
|
|
56
|
+
integrationId,
|
|
57
|
+
accountId,
|
|
58
|
+
description,
|
|
59
|
+
referenceId,
|
|
60
|
+
currency,
|
|
61
|
+
metadata,
|
|
62
|
+
eventId,
|
|
63
|
+
registrationId,
|
|
64
|
+
sessionId,
|
|
65
|
+
passId,
|
|
66
|
+
passTypeId,
|
|
67
|
+
placeId,
|
|
68
|
+
spaceId,
|
|
69
|
+
couponId,
|
|
70
|
+
invoiceId,
|
|
71
|
+
seriesId,
|
|
72
|
+
address1,
|
|
73
|
+
address2,
|
|
74
|
+
city,
|
|
75
|
+
state,
|
|
76
|
+
country,
|
|
77
|
+
zip,
|
|
78
|
+
locationAddress1,
|
|
79
|
+
locationAddress2,
|
|
80
|
+
locationCity,
|
|
81
|
+
locationState,
|
|
82
|
+
locationCountry,
|
|
83
|
+
locationZip,
|
|
84
|
+
salesTax,
|
|
85
|
+
salesTaxRate,
|
|
86
|
+
deferredAmount,
|
|
87
|
+
deferredDueDate,
|
|
88
|
+
createdAt,
|
|
89
|
+
lineItems,
|
|
90
|
+
coupon,
|
|
91
|
+
integration,
|
|
92
|
+
taxIntegration,
|
|
93
|
+
};
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BasePaymentIntentIntegration
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | [**PaymentIntegrationType**](PaymentIntegrationType.md) | | [default to undefined]
|
|
9
|
+
**connectionId** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BasePaymentIntentIntegration } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: BasePaymentIntentIntegration = {
|
|
17
|
+
type,
|
|
18
|
+
connectionId,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# BasePaymentIntentLineItem
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**type** | [**PaymentLineItemType**](PaymentLineItemType.md) | | [default to undefined]
|
|
10
|
+
**parent** | **string** | | [default to undefined]
|
|
11
|
+
**name** | **string** | | [default to undefined]
|
|
12
|
+
**quantity** | **number** | | [default to undefined]
|
|
13
|
+
**amount** | **number** | | [default to undefined]
|
|
14
|
+
**discount** | **number** | | [default to undefined]
|
|
15
|
+
**deferred** | **number** | | [default to undefined]
|
|
16
|
+
**salesTax** | **number** | | [default to undefined]
|
|
17
|
+
**taxCode** | **string** | | [default to undefined]
|
|
18
|
+
**taxIncluded** | **boolean** | | [default to undefined]
|
|
19
|
+
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [default to undefined]
|
|
20
|
+
**passId** | **string** | | [default to undefined]
|
|
21
|
+
**packageId** | **string** | | [default to undefined]
|
|
22
|
+
**passAddOnId** | **string** | | [default to undefined]
|
|
23
|
+
**reservationId** | **string** | | [default to undefined]
|
|
24
|
+
**accessId** | **string** | | [default to undefined]
|
|
25
|
+
**invoiceId** | **string** | | [default to undefined]
|
|
26
|
+
**bookingId** | **string** | | [default to undefined]
|
|
27
|
+
**couponId** | **string** | | [default to undefined]
|
|
28
|
+
**seriesRegistrationId** | **string** | | [default to undefined]
|
|
29
|
+
**createdAt** | **string** | | [default to undefined]
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import { BasePaymentIntentLineItem } from '@connectedxm/admin-sdk';
|
|
35
|
+
|
|
36
|
+
const instance: BasePaymentIntentLineItem = {
|
|
37
|
+
id,
|
|
38
|
+
type,
|
|
39
|
+
parent,
|
|
40
|
+
name,
|
|
41
|
+
quantity,
|
|
42
|
+
amount,
|
|
43
|
+
discount,
|
|
44
|
+
deferred,
|
|
45
|
+
salesTax,
|
|
46
|
+
taxCode,
|
|
47
|
+
taxIncluded,
|
|
48
|
+
taxLocation,
|
|
49
|
+
passId,
|
|
50
|
+
packageId,
|
|
51
|
+
passAddOnId,
|
|
52
|
+
reservationId,
|
|
53
|
+
accessId,
|
|
54
|
+
invoiceId,
|
|
55
|
+
bookingId,
|
|
56
|
+
couponId,
|
|
57
|
+
seriesRegistrationId,
|
|
58
|
+
createdAt,
|
|
59
|
+
};
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BasePaymentIntentTaxIntegration
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | | [default to undefined]
|
|
9
|
+
**connectionId** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BasePaymentIntentTaxIntegration } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: BasePaymentIntentTaxIntegration = {
|
|
17
|
+
type,
|
|
18
|
+
connectionId,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetAccountPaymentIntents200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<PaymentIntent>**](PaymentIntent.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetAccountPaymentIntents200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetAccountPaymentIntents200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetPaymentIntent200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**PaymentIntent**](PaymentIntent.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetPaymentIntent200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetPaymentIntent200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,9 +6,12 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createOrganizationPaymentIntegration**](#createorganizationpaymentintegration) | **POST** /organization/payment | Create an organization payment integration|
|
|
8
8
|
|[**deleteOrganizationPaymentIntegration**](#deleteorganizationpaymentintegration) | **DELETE** /organization/payment/{integrationId} | Delete an organization payment integration|
|
|
9
|
+
|[**deletePaymentIntent**](#deletepaymentintent) | **DELETE** /payment-intents/{intentId} | Delete a payment intent|
|
|
9
10
|
|[**getOrganizationPaymentIntegration**](#getorganizationpaymentintegration) | **GET** /organization/payment/{integrationId} | Get an organization payment integration|
|
|
10
11
|
|[**getOrganizationPaymentIntegrations**](#getorganizationpaymentintegrations) | **GET** /organization/payment | List an organization\'s payment integrations|
|
|
11
12
|
|[**getPayment**](#getpayment) | **GET** /payments/{paymentId} | Get a payment|
|
|
13
|
+
|[**getPaymentIntent**](#getpaymentintent) | **GET** /payment-intents/{intentId} | Get a payment intent|
|
|
14
|
+
|[**getPaymentIntents**](#getpaymentintents) | **GET** /payment-intents | List an organization\'s payment intents|
|
|
12
15
|
|[**getPaymentTaxMetadata**](#getpaymenttaxmetadata) | **GET** /payments/{paymentId}/tax-metadata | Get a payment\'s tax metadata|
|
|
13
16
|
|[**getPayments**](#getpayments) | **GET** /payments | List an organization\'s payments|
|
|
14
17
|
|[**refundPayment**](#refundpayment) | **POST** /payments/{paymentId}/refund | Refund line items on a payment|
|
|
@@ -112,6 +115,57 @@ const { status, data } = await apiInstance.deleteOrganizationPaymentIntegration(
|
|
|
112
115
|
- **Accept**: application/json
|
|
113
116
|
|
|
114
117
|
|
|
118
|
+
### HTTP response details
|
|
119
|
+
| Status code | Description | Response headers |
|
|
120
|
+
|-------------|-------------|------------------|
|
|
121
|
+
|**200** | Successful response | - |
|
|
122
|
+
|
|
123
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
124
|
+
|
|
125
|
+
# **deletePaymentIntent**
|
|
126
|
+
> CreateAccountInvitations200Response deletePaymentIntent()
|
|
127
|
+
|
|
128
|
+
Permanently removes an unpaid checkout payment intent identified by intentId. For Stripe, cancels an uncaptured PaymentIntent first and refuses if funds were already captured; requires update permission on the payments resource.
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import {
|
|
134
|
+
OrganizationPaymentsApi,
|
|
135
|
+
Configuration
|
|
136
|
+
} from '@connectedxm/admin-sdk';
|
|
137
|
+
|
|
138
|
+
const configuration = new Configuration();
|
|
139
|
+
const apiInstance = new OrganizationPaymentsApi(configuration);
|
|
140
|
+
|
|
141
|
+
let intentId: string; //The intent identifier (default to undefined)
|
|
142
|
+
|
|
143
|
+
const { status, data } = await apiInstance.deletePaymentIntent(
|
|
144
|
+
intentId
|
|
145
|
+
);
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
|Name | Type | Description | Notes|
|
|
151
|
+
|------------- | ------------- | ------------- | -------------|
|
|
152
|
+
| **intentId** | [**string**] | The intent identifier | defaults to undefined|
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
**CreateAccountInvitations200Response**
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: Not defined
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
115
169
|
### HTTP response details
|
|
116
170
|
| Status code | Description | Response headers |
|
|
117
171
|
|-------------|-------------|------------------|
|
|
@@ -274,6 +328,117 @@ const { status, data } = await apiInstance.getPayment(
|
|
|
274
328
|
- **Accept**: application/json
|
|
275
329
|
|
|
276
330
|
|
|
331
|
+
### HTTP response details
|
|
332
|
+
| Status code | Description | Response headers |
|
|
333
|
+
|-------------|-------------|------------------|
|
|
334
|
+
|**200** | Successful response | - |
|
|
335
|
+
|
|
336
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
337
|
+
|
|
338
|
+
# **getPaymentIntent**
|
|
339
|
+
> GetPaymentIntent200Response getPaymentIntent()
|
|
340
|
+
|
|
341
|
+
Returns a single unpaid checkout payment intent identified by intent ID; requires \"read\" permission on \"payments\".
|
|
342
|
+
|
|
343
|
+
### Example
|
|
344
|
+
|
|
345
|
+
```typescript
|
|
346
|
+
import {
|
|
347
|
+
OrganizationPaymentsApi,
|
|
348
|
+
Configuration
|
|
349
|
+
} from '@connectedxm/admin-sdk';
|
|
350
|
+
|
|
351
|
+
const configuration = new Configuration();
|
|
352
|
+
const apiInstance = new OrganizationPaymentsApi(configuration);
|
|
353
|
+
|
|
354
|
+
let intentId: string; //The intent identifier (default to undefined)
|
|
355
|
+
|
|
356
|
+
const { status, data } = await apiInstance.getPaymentIntent(
|
|
357
|
+
intentId
|
|
358
|
+
);
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
### Parameters
|
|
362
|
+
|
|
363
|
+
|Name | Type | Description | Notes|
|
|
364
|
+
|------------- | ------------- | ------------- | -------------|
|
|
365
|
+
| **intentId** | [**string**] | The intent identifier | defaults to undefined|
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
### Return type
|
|
369
|
+
|
|
370
|
+
**GetPaymentIntent200Response**
|
|
371
|
+
|
|
372
|
+
### Authorization
|
|
373
|
+
|
|
374
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
375
|
+
|
|
376
|
+
### HTTP request headers
|
|
377
|
+
|
|
378
|
+
- **Content-Type**: Not defined
|
|
379
|
+
- **Accept**: application/json
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
### HTTP response details
|
|
383
|
+
| Status code | Description | Response headers |
|
|
384
|
+
|-------------|-------------|------------------|
|
|
385
|
+
|**200** | Successful response | - |
|
|
386
|
+
|
|
387
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
388
|
+
|
|
389
|
+
# **getPaymentIntents**
|
|
390
|
+
> GetAccountPaymentIntents200Response getPaymentIntents()
|
|
391
|
+
|
|
392
|
+
Returns a paginated list of unpaid checkout payment intents for the organization, searchable by id, source, description, or account; requires \"read\" permission on \"payments\".
|
|
393
|
+
|
|
394
|
+
### Example
|
|
395
|
+
|
|
396
|
+
```typescript
|
|
397
|
+
import {
|
|
398
|
+
OrganizationPaymentsApi,
|
|
399
|
+
Configuration
|
|
400
|
+
} from '@connectedxm/admin-sdk';
|
|
401
|
+
|
|
402
|
+
const configuration = new Configuration();
|
|
403
|
+
const apiInstance = new OrganizationPaymentsApi(configuration);
|
|
404
|
+
|
|
405
|
+
let page: number; //Page number (optional) (default to 1)
|
|
406
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
407
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
408
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
409
|
+
|
|
410
|
+
const { status, data } = await apiInstance.getPaymentIntents(
|
|
411
|
+
page,
|
|
412
|
+
pageSize,
|
|
413
|
+
orderBy,
|
|
414
|
+
search
|
|
415
|
+
);
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
### Parameters
|
|
419
|
+
|
|
420
|
+
|Name | Type | Description | Notes|
|
|
421
|
+
|------------- | ------------- | ------------- | -------------|
|
|
422
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
423
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
424
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
425
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
### Return type
|
|
429
|
+
|
|
430
|
+
**GetAccountPaymentIntents200Response**
|
|
431
|
+
|
|
432
|
+
### Authorization
|
|
433
|
+
|
|
434
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
435
|
+
|
|
436
|
+
### HTTP request headers
|
|
437
|
+
|
|
438
|
+
- **Content-Type**: Not defined
|
|
439
|
+
- **Accept**: application/json
|
|
440
|
+
|
|
441
|
+
|
|
277
442
|
### HTTP response details
|
|
278
443
|
| Status code | Description | Response headers |
|
|
279
444
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# PaymentIntent
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**source** | [**PaymentIntentSource**](PaymentIntentSource.md) | | [default to undefined]
|
|
10
|
+
**integrationId** | **number** | | [default to undefined]
|
|
11
|
+
**accountId** | **string** | | [default to undefined]
|
|
12
|
+
**description** | **string** | | [default to undefined]
|
|
13
|
+
**referenceId** | **string** | | [default to undefined]
|
|
14
|
+
**currency** | **string** | | [default to undefined]
|
|
15
|
+
**metadata** | **object** | | [default to undefined]
|
|
16
|
+
**eventId** | **string** | | [default to undefined]
|
|
17
|
+
**registrationId** | **string** | | [default to undefined]
|
|
18
|
+
**sessionId** | **string** | | [default to undefined]
|
|
19
|
+
**passId** | **string** | | [default to undefined]
|
|
20
|
+
**passTypeId** | **string** | | [default to undefined]
|
|
21
|
+
**placeId** | **string** | | [default to undefined]
|
|
22
|
+
**spaceId** | **string** | | [default to undefined]
|
|
23
|
+
**couponId** | **string** | | [default to undefined]
|
|
24
|
+
**invoiceId** | **string** | | [default to undefined]
|
|
25
|
+
**seriesId** | **string** | | [default to undefined]
|
|
26
|
+
**address1** | **string** | | [default to undefined]
|
|
27
|
+
**address2** | **string** | | [default to undefined]
|
|
28
|
+
**city** | **string** | | [default to undefined]
|
|
29
|
+
**state** | **string** | | [default to undefined]
|
|
30
|
+
**country** | **string** | | [default to undefined]
|
|
31
|
+
**zip** | **string** | | [default to undefined]
|
|
32
|
+
**locationAddress1** | **string** | | [default to undefined]
|
|
33
|
+
**locationAddress2** | **string** | | [default to undefined]
|
|
34
|
+
**locationCity** | **string** | | [default to undefined]
|
|
35
|
+
**locationState** | **string** | | [default to undefined]
|
|
36
|
+
**locationCountry** | **string** | | [default to undefined]
|
|
37
|
+
**locationZip** | **string** | | [default to undefined]
|
|
38
|
+
**salesTax** | **number** | | [default to undefined]
|
|
39
|
+
**salesTaxRate** | **string** | | [default to undefined]
|
|
40
|
+
**deferredAmount** | **number** | | [default to undefined]
|
|
41
|
+
**deferredDueDate** | **string** | | [default to undefined]
|
|
42
|
+
**createdAt** | **string** | | [default to undefined]
|
|
43
|
+
**lineItems** | [**Array<BasePaymentIntentLineItem>**](BasePaymentIntentLineItem.md) | | [default to undefined]
|
|
44
|
+
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
45
|
+
**integration** | [**BasePaymentIntentIntegration**](BasePaymentIntentIntegration.md) | | [default to undefined]
|
|
46
|
+
**taxIntegration** | [**BasePaymentIntentTaxIntegration**](BasePaymentIntentTaxIntegration.md) | | [default to undefined]
|
|
47
|
+
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
48
|
+
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
49
|
+
**session** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
50
|
+
**registration** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
51
|
+
**pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
|
|
52
|
+
**passType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
53
|
+
**place** | [**BaseBookingPlace**](BaseBookingPlace.md) | | [default to undefined]
|
|
54
|
+
**space** | [**BaseBookingSpace**](BaseBookingSpace.md) | | [default to undefined]
|
|
55
|
+
**invoice** | [**BaseInvoice**](BaseInvoice.md) | | [default to undefined]
|
|
56
|
+
**series** | [**BaseSeries**](BaseSeries.md) | | [default to undefined]
|
|
57
|
+
|
|
58
|
+
## Example
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
import { PaymentIntent } from '@connectedxm/admin-sdk';
|
|
62
|
+
|
|
63
|
+
const instance: PaymentIntent = {
|
|
64
|
+
id,
|
|
65
|
+
source,
|
|
66
|
+
integrationId,
|
|
67
|
+
accountId,
|
|
68
|
+
description,
|
|
69
|
+
referenceId,
|
|
70
|
+
currency,
|
|
71
|
+
metadata,
|
|
72
|
+
eventId,
|
|
73
|
+
registrationId,
|
|
74
|
+
sessionId,
|
|
75
|
+
passId,
|
|
76
|
+
passTypeId,
|
|
77
|
+
placeId,
|
|
78
|
+
spaceId,
|
|
79
|
+
couponId,
|
|
80
|
+
invoiceId,
|
|
81
|
+
seriesId,
|
|
82
|
+
address1,
|
|
83
|
+
address2,
|
|
84
|
+
city,
|
|
85
|
+
state,
|
|
86
|
+
country,
|
|
87
|
+
zip,
|
|
88
|
+
locationAddress1,
|
|
89
|
+
locationAddress2,
|
|
90
|
+
locationCity,
|
|
91
|
+
locationState,
|
|
92
|
+
locationCountry,
|
|
93
|
+
locationZip,
|
|
94
|
+
salesTax,
|
|
95
|
+
salesTaxRate,
|
|
96
|
+
deferredAmount,
|
|
97
|
+
deferredDueDate,
|
|
98
|
+
createdAt,
|
|
99
|
+
lineItems,
|
|
100
|
+
coupon,
|
|
101
|
+
integration,
|
|
102
|
+
taxIntegration,
|
|
103
|
+
account,
|
|
104
|
+
event,
|
|
105
|
+
session,
|
|
106
|
+
registration,
|
|
107
|
+
pass,
|
|
108
|
+
passType,
|
|
109
|
+
place,
|
|
110
|
+
space,
|
|
111
|
+
invoice,
|
|
112
|
+
series,
|
|
113
|
+
};
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PaymentIntentSource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Registration` (value: `'registration'`)
|
|
7
|
+
|
|
8
|
+
* `Invoice` (value: `'invoice'`)
|
|
9
|
+
|
|
10
|
+
* `Pass` (value: `'pass'`)
|
|
11
|
+
|
|
12
|
+
* `Coupon` (value: `'coupon'`)
|
|
13
|
+
|
|
14
|
+
* `Session` (value: `'session'`)
|
|
15
|
+
|
|
16
|
+
* `Booking` (value: `'booking'`)
|
|
17
|
+
|
|
18
|
+
* `Series` (value: `'series'`)
|
|
19
|
+
|
|
20
|
+
* `Exchange` (value: `'exchange'`)
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|