@connectedxm/admin-sdk 7.8.1 → 7.9.2
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 +12 -1
- package/AdminApi.ts +3 -0
- package/README.md +17 -2
- package/api.ts +913 -106
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +518 -58
- package/dist/api.js +624 -107
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +518 -58
- package/dist/esm/api.js +592 -79
- package/docs/AccountsApi.md +0 -55
- package/docs/AddEventPassTypeExchangeTarget200Response.md +24 -0
- package/docs/BaseEventPassTypeExchangeTarget.md +38 -0
- package/docs/BasePassExchange.md +32 -0
- package/docs/Event.md +2 -0
- package/docs/EventCreateInputs.md +2 -0
- package/docs/EventPassTypeExchangeTarget.md +42 -0
- package/docs/EventUpdateInputs.md +2 -0
- package/docs/EventsPasstypesExchangetargetsApi.md +393 -0
- package/docs/ExchangeType.md +12 -0
- package/docs/GetEventPassTypeExchangeTargetExchanges200Response.md +26 -0
- package/docs/GetEventPassTypeExchangeTargets200Response.md +26 -0
- package/docs/{ImpersonateAccount200Response.md → JoinMeeting200Response.md} +3 -3
- package/docs/MeetingsApi.md +2 -2
- package/docs/PassExchange.md +38 -0
- package/docs/PassTypeExchangeTargetCreateInputs.md +30 -0
- package/docs/PassTypeExchangeTargetUpdateInputs.md +28 -0
- package/docs/Payment.md +2 -0
- package/docs/TaxIntegration.md +2 -0
- package/docs/TaxIntegrationCreateInputs.md +8 -0
- package/docs/TaxIntegrationUpdateInputs.md +2 -0
- package/package.json +1 -1
package/docs/AccountsApi.md
CHANGED
|
@@ -21,7 +21,6 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
21
21
|
|[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads | List an account\'s message threads|
|
|
22
22
|
|[**getAccounts**](#getaccounts) | **GET** /accounts | List accounts in the organization|
|
|
23
23
|
|[**getAccountsByInternalRefId**](#getaccountsbyinternalrefid) | **GET** /accounts/internal-ref-id/{internalRefId} | Find accounts by internal reference ID|
|
|
24
|
-
|[**impersonateAccount**](#impersonateaccount) | **POST** /accounts/{accountId}/impersonate/{username} | Impersonate account|
|
|
25
24
|
|[**syncAccount**](#syncaccount) | **POST** /accounts/{accountId}/sync | Sync a single account|
|
|
26
25
|
|[**syncAccounts**](#syncaccounts) | **POST** /accounts/sync | Sync all accounts|
|
|
27
26
|
|[**updateAccount**](#updateaccount) | **PUT** /accounts/{accountId} | Update an account|
|
|
@@ -1031,60 +1030,6 @@ const { status, data } = await apiInstance.getAccountsByInternalRefId(
|
|
|
1031
1030
|
- **Accept**: application/json
|
|
1032
1031
|
|
|
1033
1032
|
|
|
1034
|
-
### HTTP response details
|
|
1035
|
-
| Status code | Description | Response headers |
|
|
1036
|
-
|-------------|-------------|------------------|
|
|
1037
|
-
|**200** | Successful response | - |
|
|
1038
|
-
|
|
1039
|
-
[[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)
|
|
1040
|
-
|
|
1041
|
-
# **impersonateAccount**
|
|
1042
|
-
> ImpersonateAccount200Response impersonateAccount()
|
|
1043
|
-
|
|
1044
|
-
Starts an admin impersonation session for the specified account, returning a token that lets an admin act as the given user identified by account ID and username.
|
|
1045
|
-
|
|
1046
|
-
### Example
|
|
1047
|
-
|
|
1048
|
-
```typescript
|
|
1049
|
-
import {
|
|
1050
|
-
AccountsApi,
|
|
1051
|
-
Configuration
|
|
1052
|
-
} from '@connectedxm/admin-sdk';
|
|
1053
|
-
|
|
1054
|
-
const configuration = new Configuration();
|
|
1055
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1056
|
-
|
|
1057
|
-
let accountId: string; //The account identifier (default to undefined)
|
|
1058
|
-
let username: string; //The username identifier (default to undefined)
|
|
1059
|
-
|
|
1060
|
-
const { status, data } = await apiInstance.impersonateAccount(
|
|
1061
|
-
accountId,
|
|
1062
|
-
username
|
|
1063
|
-
);
|
|
1064
|
-
```
|
|
1065
|
-
|
|
1066
|
-
### Parameters
|
|
1067
|
-
|
|
1068
|
-
|Name | Type | Description | Notes|
|
|
1069
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1070
|
-
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1071
|
-
| **username** | [**string**] | The username identifier | defaults to undefined|
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
### Return type
|
|
1075
|
-
|
|
1076
|
-
**ImpersonateAccount200Response**
|
|
1077
|
-
|
|
1078
|
-
### Authorization
|
|
1079
|
-
|
|
1080
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1081
|
-
|
|
1082
|
-
### HTTP request headers
|
|
1083
|
-
|
|
1084
|
-
- **Content-Type**: Not defined
|
|
1085
|
-
- **Accept**: application/json
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
1033
|
### HTTP response details
|
|
1089
1034
|
| Status code | Description | Response headers |
|
|
1090
1035
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AddEventPassTypeExchangeTarget200Response
|
|
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** | [**EventPassTypeExchangeTarget**](EventPassTypeExchangeTarget.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AddEventPassTypeExchangeTarget200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: AddEventPassTypeExchangeTarget200Response = {
|
|
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)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# BaseEventPassTypeExchangeTarget
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**enabled** | **boolean** | | [default to undefined]
|
|
10
|
+
**sourcePassTypeId** | **string** | | [default to undefined]
|
|
11
|
+
**sourcePassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
12
|
+
**targetPassTypeId** | **string** | | [default to undefined]
|
|
13
|
+
**targetPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
14
|
+
**fixedPricing** | **boolean** | | [default to undefined]
|
|
15
|
+
**amount** | **number** | | [default to undefined]
|
|
16
|
+
**startDate** | **string** | | [default to undefined]
|
|
17
|
+
**endDate** | **string** | | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { BaseEventPassTypeExchangeTarget } from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: BaseEventPassTypeExchangeTarget = {
|
|
25
|
+
id,
|
|
26
|
+
enabled,
|
|
27
|
+
sourcePassTypeId,
|
|
28
|
+
sourcePassType,
|
|
29
|
+
targetPassTypeId,
|
|
30
|
+
targetPassType,
|
|
31
|
+
fixedPricing,
|
|
32
|
+
amount,
|
|
33
|
+
startDate,
|
|
34
|
+
endDate,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[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,32 @@
|
|
|
1
|
+
# BasePassExchange
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**accountId** | **string** | | [default to undefined]
|
|
10
|
+
**passId** | **string** | | [default to undefined]
|
|
11
|
+
**exchangeType** | [**ExchangeType**](ExchangeType.md) | | [default to undefined]
|
|
12
|
+
**exchangeTargetId** | **string** | | [default to undefined]
|
|
13
|
+
**exchangeTarget** | [**EventPassTypeExchangeTarget**](EventPassTypeExchangeTarget.md) | | [default to undefined]
|
|
14
|
+
**lineItem** | [**BasePaymentLineItem**](BasePaymentLineItem.md) | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { BasePassExchange } from '@connectedxm/admin-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: BasePassExchange = {
|
|
22
|
+
id,
|
|
23
|
+
accountId,
|
|
24
|
+
passId,
|
|
25
|
+
exchangeType,
|
|
26
|
+
exchangeTargetId,
|
|
27
|
+
exchangeTarget,
|
|
28
|
+
lineItem,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Event.md
CHANGED
|
@@ -73,6 +73,7 @@ Name | Type | Description | Notes
|
|
|
73
73
|
**groupId** | **string** | | [default to undefined]
|
|
74
74
|
**group** | [**BaseGroup**](BaseGroup.md) | | [default to undefined]
|
|
75
75
|
**groupOnly** | **boolean** | | [default to undefined]
|
|
76
|
+
**guestRegistration** | **boolean** | | [default to undefined]
|
|
76
77
|
**backgroundImageId** | **string** | | [default to undefined]
|
|
77
78
|
**backgroundImage** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
78
79
|
**registrationHeaderImageId** | **string** | | [default to undefined]
|
|
@@ -164,6 +165,7 @@ const instance: Event = {
|
|
|
164
165
|
groupId,
|
|
165
166
|
group,
|
|
166
167
|
groupOnly,
|
|
168
|
+
guestRegistration,
|
|
167
169
|
backgroundImageId,
|
|
168
170
|
backgroundImage,
|
|
169
171
|
registrationHeaderImageId,
|
|
@@ -47,6 +47,7 @@ Name | Type | Description | Notes
|
|
|
47
47
|
**streamReplayId** | **string** | | [optional] [default to undefined]
|
|
48
48
|
**groupId** | **string** | | [optional] [default to undefined]
|
|
49
49
|
**groupOnly** | **boolean** | | [optional] [default to undefined]
|
|
50
|
+
**guestRegistration** | **boolean** | | [optional] [default to undefined]
|
|
50
51
|
**passSupply** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
51
52
|
**passLimitPerAccount** | [**EventCreateInputsPassLimitPerAccount**](EventCreateInputsPassLimitPerAccount.md) | | [optional] [default to undefined]
|
|
52
53
|
**roundName** | **string** | | [optional] [default to undefined]
|
|
@@ -109,6 +110,7 @@ const instance: EventCreateInputs = {
|
|
|
109
110
|
streamReplayId,
|
|
110
111
|
groupId,
|
|
111
112
|
groupOnly,
|
|
113
|
+
guestRegistration,
|
|
112
114
|
passSupply,
|
|
113
115
|
passLimitPerAccount,
|
|
114
116
|
roundName,
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# EventPassTypeExchangeTarget
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**enabled** | **boolean** | | [default to undefined]
|
|
10
|
+
**sourcePassTypeId** | **string** | | [default to undefined]
|
|
11
|
+
**sourcePassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
12
|
+
**targetPassTypeId** | **string** | | [default to undefined]
|
|
13
|
+
**targetPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
14
|
+
**fixedPricing** | **boolean** | | [default to undefined]
|
|
15
|
+
**amount** | **number** | | [default to undefined]
|
|
16
|
+
**startDate** | **string** | | [default to undefined]
|
|
17
|
+
**endDate** | **string** | | [default to undefined]
|
|
18
|
+
**createdAt** | **string** | | [default to undefined]
|
|
19
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { EventPassTypeExchangeTarget } from '@connectedxm/admin-sdk';
|
|
25
|
+
|
|
26
|
+
const instance: EventPassTypeExchangeTarget = {
|
|
27
|
+
id,
|
|
28
|
+
enabled,
|
|
29
|
+
sourcePassTypeId,
|
|
30
|
+
sourcePassType,
|
|
31
|
+
targetPassTypeId,
|
|
32
|
+
targetPassType,
|
|
33
|
+
fixedPricing,
|
|
34
|
+
amount,
|
|
35
|
+
startDate,
|
|
36
|
+
endDate,
|
|
37
|
+
createdAt,
|
|
38
|
+
updatedAt,
|
|
39
|
+
};
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -48,6 +48,7 @@ Name | Type | Description | Notes
|
|
|
48
48
|
**streamReplayId** | **string** | | [optional] [default to undefined]
|
|
49
49
|
**groupId** | **string** | | [optional] [default to undefined]
|
|
50
50
|
**groupOnly** | **boolean** | | [optional] [default to undefined]
|
|
51
|
+
**guestRegistration** | **boolean** | | [optional] [default to undefined]
|
|
51
52
|
**passSupply** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
52
53
|
**passLimitPerAccount** | [**EventCreateInputsPassLimitPerAccount**](EventCreateInputsPassLimitPerAccount.md) | | [optional] [default to undefined]
|
|
53
54
|
**roundName** | **string** | | [optional] [default to undefined]
|
|
@@ -110,6 +111,7 @@ const instance: EventUpdateInputs = {
|
|
|
110
111
|
streamReplayId,
|
|
111
112
|
groupId,
|
|
112
113
|
groupOnly,
|
|
114
|
+
guestRegistration,
|
|
113
115
|
passSupply,
|
|
114
116
|
passLimitPerAccount,
|
|
115
117
|
roundName,
|
|
@@ -0,0 +1,393 @@
|
|
|
1
|
+
# EventsPasstypesExchangetargetsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addEventPassTypeExchangeTarget**](#addeventpasstypeexchangetarget) | **POST** /events/{eventId}/passTypes/{passTypeId}/exchangeTargets | Add Event Pass Type Exchange Target|
|
|
8
|
+
|[**getEventPassTypeExchangeTargetExchanges**](#geteventpasstypeexchangetargetexchanges) | **GET** /events/{eventId}/passTypes/{passTypeId}/exchangeTargets/{exchangeTargetId}/exchanges | Get Event Pass Type Exchange Target Exchanges|
|
|
9
|
+
|[**getEventPassTypeExchangeTargetPayments**](#geteventpasstypeexchangetargetpayments) | **GET** /events/{eventId}/passTypes/{passTypeId}/exchangeTargets/{exchangeTargetId}/payments | Get Event Pass Type Exchange Target Payments|
|
|
10
|
+
|[**getEventPassTypeExchangeTargets**](#geteventpasstypeexchangetargets) | **GET** /events/{eventId}/passTypes/{passTypeId}/exchangeTargets | Get Event Pass Type Exchange Targets|
|
|
11
|
+
|[**removeEventPassTypeExchangeTarget**](#removeeventpasstypeexchangetarget) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/exchangeTargets/{exchangeTargetId} | Remove Event Pass Type Exchange Target|
|
|
12
|
+
|[**updateEventPassTypeExchangeTarget**](#updateeventpasstypeexchangetarget) | **PUT** /events/{eventId}/passTypes/{passTypeId}/exchangeTargets/{exchangeTargetId} | Update Event Pass Type Exchange Target|
|
|
13
|
+
|
|
14
|
+
# **addEventPassTypeExchangeTarget**
|
|
15
|
+
> AddEventPassTypeExchangeTarget200Response addEventPassTypeExchangeTarget(passTypeExchangeTargetCreateInputs)
|
|
16
|
+
|
|
17
|
+
Add Event Pass Type Exchange Target endpoint
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
EventsPasstypesExchangetargetsApi,
|
|
24
|
+
Configuration,
|
|
25
|
+
PassTypeExchangeTargetCreateInputs
|
|
26
|
+
} from '@connectedxm/admin-sdk';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new EventsPasstypesExchangetargetsApi(configuration);
|
|
30
|
+
|
|
31
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
32
|
+
let passTypeId: string; //The passType identifier (default to undefined)
|
|
33
|
+
let passTypeExchangeTargetCreateInputs: PassTypeExchangeTargetCreateInputs; //
|
|
34
|
+
|
|
35
|
+
const { status, data } = await apiInstance.addEventPassTypeExchangeTarget(
|
|
36
|
+
eventId,
|
|
37
|
+
passTypeId,
|
|
38
|
+
passTypeExchangeTargetCreateInputs
|
|
39
|
+
);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
|
|
44
|
+
|Name | Type | Description | Notes|
|
|
45
|
+
|------------- | ------------- | ------------- | -------------|
|
|
46
|
+
| **passTypeExchangeTargetCreateInputs** | **PassTypeExchangeTargetCreateInputs**| | |
|
|
47
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
48
|
+
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Return type
|
|
52
|
+
|
|
53
|
+
**AddEventPassTypeExchangeTarget200Response**
|
|
54
|
+
|
|
55
|
+
### Authorization
|
|
56
|
+
|
|
57
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
58
|
+
|
|
59
|
+
### HTTP request headers
|
|
60
|
+
|
|
61
|
+
- **Content-Type**: application/json
|
|
62
|
+
- **Accept**: application/json
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### HTTP response details
|
|
66
|
+
| Status code | Description | Response headers |
|
|
67
|
+
|-------------|-------------|------------------|
|
|
68
|
+
|**200** | Successful response | - |
|
|
69
|
+
|
|
70
|
+
[[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)
|
|
71
|
+
|
|
72
|
+
# **getEventPassTypeExchangeTargetExchanges**
|
|
73
|
+
> GetEventPassTypeExchangeTargetExchanges200Response getEventPassTypeExchangeTargetExchanges()
|
|
74
|
+
|
|
75
|
+
Get Event Pass Type Exchange Target Exchanges endpoint
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
import {
|
|
81
|
+
EventsPasstypesExchangetargetsApi,
|
|
82
|
+
Configuration
|
|
83
|
+
} from '@connectedxm/admin-sdk';
|
|
84
|
+
|
|
85
|
+
const configuration = new Configuration();
|
|
86
|
+
const apiInstance = new EventsPasstypesExchangetargetsApi(configuration);
|
|
87
|
+
|
|
88
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
89
|
+
let passTypeId: string; //The passType identifier (default to undefined)
|
|
90
|
+
let exchangeTargetId: string; //The exchangeTarget identifier (default to undefined)
|
|
91
|
+
let page: number; //Page number (optional) (default to 1)
|
|
92
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
93
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
94
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
95
|
+
|
|
96
|
+
const { status, data } = await apiInstance.getEventPassTypeExchangeTargetExchanges(
|
|
97
|
+
eventId,
|
|
98
|
+
passTypeId,
|
|
99
|
+
exchangeTargetId,
|
|
100
|
+
page,
|
|
101
|
+
pageSize,
|
|
102
|
+
orderBy,
|
|
103
|
+
search
|
|
104
|
+
);
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Parameters
|
|
108
|
+
|
|
109
|
+
|Name | Type | Description | Notes|
|
|
110
|
+
|------------- | ------------- | ------------- | -------------|
|
|
111
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
112
|
+
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
113
|
+
| **exchangeTargetId** | [**string**] | The exchangeTarget identifier | defaults to undefined|
|
|
114
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
115
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
116
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
117
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### Return type
|
|
121
|
+
|
|
122
|
+
**GetEventPassTypeExchangeTargetExchanges200Response**
|
|
123
|
+
|
|
124
|
+
### Authorization
|
|
125
|
+
|
|
126
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
127
|
+
|
|
128
|
+
### HTTP request headers
|
|
129
|
+
|
|
130
|
+
- **Content-Type**: Not defined
|
|
131
|
+
- **Accept**: application/json
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
### HTTP response details
|
|
135
|
+
| Status code | Description | Response headers |
|
|
136
|
+
|-------------|-------------|------------------|
|
|
137
|
+
|**200** | Successful response | - |
|
|
138
|
+
|
|
139
|
+
[[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)
|
|
140
|
+
|
|
141
|
+
# **getEventPassTypeExchangeTargetPayments**
|
|
142
|
+
> GetAccountPayments200Response getEventPassTypeExchangeTargetPayments()
|
|
143
|
+
|
|
144
|
+
Get Event Pass Type Exchange Target Payments endpoint
|
|
145
|
+
|
|
146
|
+
### Example
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
import {
|
|
150
|
+
EventsPasstypesExchangetargetsApi,
|
|
151
|
+
Configuration
|
|
152
|
+
} from '@connectedxm/admin-sdk';
|
|
153
|
+
|
|
154
|
+
const configuration = new Configuration();
|
|
155
|
+
const apiInstance = new EventsPasstypesExchangetargetsApi(configuration);
|
|
156
|
+
|
|
157
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
158
|
+
let passTypeId: string; //The passType identifier (default to undefined)
|
|
159
|
+
let exchangeTargetId: string; //The exchangeTarget identifier (default to undefined)
|
|
160
|
+
let page: number; //Page number (optional) (default to 1)
|
|
161
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
162
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
163
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
164
|
+
|
|
165
|
+
const { status, data } = await apiInstance.getEventPassTypeExchangeTargetPayments(
|
|
166
|
+
eventId,
|
|
167
|
+
passTypeId,
|
|
168
|
+
exchangeTargetId,
|
|
169
|
+
page,
|
|
170
|
+
pageSize,
|
|
171
|
+
orderBy,
|
|
172
|
+
search
|
|
173
|
+
);
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Parameters
|
|
177
|
+
|
|
178
|
+
|Name | Type | Description | Notes|
|
|
179
|
+
|------------- | ------------- | ------------- | -------------|
|
|
180
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
181
|
+
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
182
|
+
| **exchangeTargetId** | [**string**] | The exchangeTarget identifier | defaults to undefined|
|
|
183
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
184
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
185
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
186
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
### Return type
|
|
190
|
+
|
|
191
|
+
**GetAccountPayments200Response**
|
|
192
|
+
|
|
193
|
+
### Authorization
|
|
194
|
+
|
|
195
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
196
|
+
|
|
197
|
+
### HTTP request headers
|
|
198
|
+
|
|
199
|
+
- **Content-Type**: Not defined
|
|
200
|
+
- **Accept**: application/json
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
### HTTP response details
|
|
204
|
+
| Status code | Description | Response headers |
|
|
205
|
+
|-------------|-------------|------------------|
|
|
206
|
+
|**200** | Successful response | - |
|
|
207
|
+
|
|
208
|
+
[[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)
|
|
209
|
+
|
|
210
|
+
# **getEventPassTypeExchangeTargets**
|
|
211
|
+
> GetEventPassTypeExchangeTargets200Response getEventPassTypeExchangeTargets()
|
|
212
|
+
|
|
213
|
+
Get Event Pass Type Exchange Targets endpoint
|
|
214
|
+
|
|
215
|
+
### Example
|
|
216
|
+
|
|
217
|
+
```typescript
|
|
218
|
+
import {
|
|
219
|
+
EventsPasstypesExchangetargetsApi,
|
|
220
|
+
Configuration
|
|
221
|
+
} from '@connectedxm/admin-sdk';
|
|
222
|
+
|
|
223
|
+
const configuration = new Configuration();
|
|
224
|
+
const apiInstance = new EventsPasstypesExchangetargetsApi(configuration);
|
|
225
|
+
|
|
226
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
227
|
+
let passTypeId: string; //The passType identifier (default to undefined)
|
|
228
|
+
let page: number; //Page number (optional) (default to 1)
|
|
229
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
230
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
231
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
232
|
+
|
|
233
|
+
const { status, data } = await apiInstance.getEventPassTypeExchangeTargets(
|
|
234
|
+
eventId,
|
|
235
|
+
passTypeId,
|
|
236
|
+
page,
|
|
237
|
+
pageSize,
|
|
238
|
+
orderBy,
|
|
239
|
+
search
|
|
240
|
+
);
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Parameters
|
|
244
|
+
|
|
245
|
+
|Name | Type | Description | Notes|
|
|
246
|
+
|------------- | ------------- | ------------- | -------------|
|
|
247
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
248
|
+
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
249
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
250
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
251
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
252
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
### Return type
|
|
256
|
+
|
|
257
|
+
**GetEventPassTypeExchangeTargets200Response**
|
|
258
|
+
|
|
259
|
+
### Authorization
|
|
260
|
+
|
|
261
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
262
|
+
|
|
263
|
+
### HTTP request headers
|
|
264
|
+
|
|
265
|
+
- **Content-Type**: Not defined
|
|
266
|
+
- **Accept**: application/json
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
### HTTP response details
|
|
270
|
+
| Status code | Description | Response headers |
|
|
271
|
+
|-------------|-------------|------------------|
|
|
272
|
+
|**200** | Successful response | - |
|
|
273
|
+
|
|
274
|
+
[[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)
|
|
275
|
+
|
|
276
|
+
# **removeEventPassTypeExchangeTarget**
|
|
277
|
+
> AddEventPassTypeExchangeTarget200Response removeEventPassTypeExchangeTarget()
|
|
278
|
+
|
|
279
|
+
Remove Event Pass Type Exchange Target endpoint
|
|
280
|
+
|
|
281
|
+
### Example
|
|
282
|
+
|
|
283
|
+
```typescript
|
|
284
|
+
import {
|
|
285
|
+
EventsPasstypesExchangetargetsApi,
|
|
286
|
+
Configuration
|
|
287
|
+
} from '@connectedxm/admin-sdk';
|
|
288
|
+
|
|
289
|
+
const configuration = new Configuration();
|
|
290
|
+
const apiInstance = new EventsPasstypesExchangetargetsApi(configuration);
|
|
291
|
+
|
|
292
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
293
|
+
let passTypeId: string; //The passType identifier (default to undefined)
|
|
294
|
+
let exchangeTargetId: string; //The exchangeTarget identifier (default to undefined)
|
|
295
|
+
|
|
296
|
+
const { status, data } = await apiInstance.removeEventPassTypeExchangeTarget(
|
|
297
|
+
eventId,
|
|
298
|
+
passTypeId,
|
|
299
|
+
exchangeTargetId
|
|
300
|
+
);
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### Parameters
|
|
304
|
+
|
|
305
|
+
|Name | Type | Description | Notes|
|
|
306
|
+
|------------- | ------------- | ------------- | -------------|
|
|
307
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
308
|
+
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
309
|
+
| **exchangeTargetId** | [**string**] | The exchangeTarget identifier | defaults to undefined|
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
### Return type
|
|
313
|
+
|
|
314
|
+
**AddEventPassTypeExchangeTarget200Response**
|
|
315
|
+
|
|
316
|
+
### Authorization
|
|
317
|
+
|
|
318
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
319
|
+
|
|
320
|
+
### HTTP request headers
|
|
321
|
+
|
|
322
|
+
- **Content-Type**: Not defined
|
|
323
|
+
- **Accept**: application/json
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
### HTTP response details
|
|
327
|
+
| Status code | Description | Response headers |
|
|
328
|
+
|-------------|-------------|------------------|
|
|
329
|
+
|**200** | Successful response | - |
|
|
330
|
+
|
|
331
|
+
[[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)
|
|
332
|
+
|
|
333
|
+
# **updateEventPassTypeExchangeTarget**
|
|
334
|
+
> AddEventPassTypeExchangeTarget200Response updateEventPassTypeExchangeTarget(passTypeExchangeTargetUpdateInputs)
|
|
335
|
+
|
|
336
|
+
Update Event Pass Type Exchange Target endpoint
|
|
337
|
+
|
|
338
|
+
### Example
|
|
339
|
+
|
|
340
|
+
```typescript
|
|
341
|
+
import {
|
|
342
|
+
EventsPasstypesExchangetargetsApi,
|
|
343
|
+
Configuration,
|
|
344
|
+
PassTypeExchangeTargetUpdateInputs
|
|
345
|
+
} from '@connectedxm/admin-sdk';
|
|
346
|
+
|
|
347
|
+
const configuration = new Configuration();
|
|
348
|
+
const apiInstance = new EventsPasstypesExchangetargetsApi(configuration);
|
|
349
|
+
|
|
350
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
351
|
+
let passTypeId: string; //The passType identifier (default to undefined)
|
|
352
|
+
let exchangeTargetId: string; //The exchangeTarget identifier (default to undefined)
|
|
353
|
+
let passTypeExchangeTargetUpdateInputs: PassTypeExchangeTargetUpdateInputs; //
|
|
354
|
+
|
|
355
|
+
const { status, data } = await apiInstance.updateEventPassTypeExchangeTarget(
|
|
356
|
+
eventId,
|
|
357
|
+
passTypeId,
|
|
358
|
+
exchangeTargetId,
|
|
359
|
+
passTypeExchangeTargetUpdateInputs
|
|
360
|
+
);
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### Parameters
|
|
364
|
+
|
|
365
|
+
|Name | Type | Description | Notes|
|
|
366
|
+
|------------- | ------------- | ------------- | -------------|
|
|
367
|
+
| **passTypeExchangeTargetUpdateInputs** | **PassTypeExchangeTargetUpdateInputs**| | |
|
|
368
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
369
|
+
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
370
|
+
| **exchangeTargetId** | [**string**] | The exchangeTarget identifier | defaults to undefined|
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
### Return type
|
|
374
|
+
|
|
375
|
+
**AddEventPassTypeExchangeTarget200Response**
|
|
376
|
+
|
|
377
|
+
### Authorization
|
|
378
|
+
|
|
379
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
380
|
+
|
|
381
|
+
### HTTP request headers
|
|
382
|
+
|
|
383
|
+
- **Content-Type**: application/json
|
|
384
|
+
- **Accept**: application/json
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
### HTTP response details
|
|
388
|
+
| Status code | Description | Response headers |
|
|
389
|
+
|-------------|-------------|------------------|
|
|
390
|
+
|**200** | Successful response | - |
|
|
391
|
+
|
|
392
|
+
[[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)
|
|
393
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# ExchangeType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Upgrade` (value: `'upgrade'`)
|
|
7
|
+
|
|
8
|
+
* `Downgrade` (value: `'downgrade'`)
|
|
9
|
+
|
|
10
|
+
* `Swap` (value: `'swap'`)
|
|
11
|
+
|
|
12
|
+
[[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
|
+
# GetEventPassTypeExchangeTargetExchanges200Response
|
|
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<PassExchange>**](PassExchange.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetEventPassTypeExchangeTargetExchanges200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetEventPassTypeExchangeTargetExchanges200Response = {
|
|
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)
|