@connectedxm/admin-sdk 10.17.0 → 10.19.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/.openapi-generator/FILES +7 -1
- package/README.md +2 -2
- package/api.ts +1065 -65
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +565 -42
- package/dist/api.js +768 -33
- 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 +565 -42
- package/dist/esm/api.js +740 -5
- 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/{CreateEventPassType200Response.md → AddEventOnSiteLabelPassType200Response.md} +3 -3
- package/docs/BaseEventOnSiteLabel.md +28 -0
- package/docs/BasePayment.md +4 -0
- package/docs/CreateEventOnSiteLabel200Response.md +24 -0
- package/docs/EventOnSiteLabel.md +28 -0
- package/docs/EventOnSiteLabelCreateInputs.md +24 -0
- package/docs/EventOnSiteLabelUpdateInputs.md +24 -0
- package/docs/EventPassType.md +2 -0
- package/docs/EventsOnSiteApi.md +527 -0
- package/docs/EventsPasstypesApi.md +18 -18
- package/docs/EventsPasstypesPriceschedulesApi.md +2 -2
- package/docs/EventsPasstypesRefundschedulesApi.md +2 -2
- package/docs/GetEventOnSiteLabels200Response.md +26 -0
- package/docs/Payment.md +4 -0
- package/package.json +1 -1
|
@@ -23,7 +23,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
23
23
|
|[**updateEventPassType**](#updateeventpasstype) | **PUT** /events/{eventId}/passTypes/{passTypeId} | Update an event pass type|
|
|
24
24
|
|
|
25
25
|
# **addEventPassTypeAddOn**
|
|
26
|
-
>
|
|
26
|
+
> AddEventOnSiteLabelPassType200Response addEventPassTypeAddOn()
|
|
27
27
|
|
|
28
28
|
Associates an existing event add-on with a pass type so it can be purchased alongside that pass; requires update permission on events.
|
|
29
29
|
|
|
@@ -60,7 +60,7 @@ const { status, data } = await apiInstance.addEventPassTypeAddOn(
|
|
|
60
60
|
|
|
61
61
|
### Return type
|
|
62
62
|
|
|
63
|
-
**
|
|
63
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
64
64
|
|
|
65
65
|
### Authorization
|
|
66
66
|
|
|
@@ -80,7 +80,7 @@ const { status, data } = await apiInstance.addEventPassTypeAddOn(
|
|
|
80
80
|
[[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)
|
|
81
81
|
|
|
82
82
|
# **addEventPassTypeGroupPassTier**
|
|
83
|
-
>
|
|
83
|
+
> AddEventOnSiteLabelPassType200Response addEventPassTypeGroupPassTier()
|
|
84
84
|
|
|
85
85
|
Adds an account tier to the list of tiers allowed to purchase a pass type as a group pass, rejecting the request if the tier has already been added; requires update permission on events and read permission on tiers.
|
|
86
86
|
|
|
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.addEventPassTypeGroupPassTier(
|
|
|
117
117
|
|
|
118
118
|
### Return type
|
|
119
119
|
|
|
120
|
-
**
|
|
120
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
121
121
|
|
|
122
122
|
### Authorization
|
|
123
123
|
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.addEventPassTypeGroupPassTier(
|
|
|
137
137
|
[[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)
|
|
138
138
|
|
|
139
139
|
# **addEventPassTypeTier**
|
|
140
|
-
>
|
|
140
|
+
> AddEventOnSiteLabelPassType200Response addEventPassTypeTier(addEventAddOnTierRequest)
|
|
141
141
|
|
|
142
142
|
Adds an account tier to either the allowed or disallowed tier list of an event pass type depending on the `allowed` flag, restricting or permitting which account tiers may purchase that pass type; requires update permission on events.
|
|
143
143
|
|
|
@@ -178,7 +178,7 @@ const { status, data } = await apiInstance.addEventPassTypeTier(
|
|
|
178
178
|
|
|
179
179
|
### Return type
|
|
180
180
|
|
|
181
|
-
**
|
|
181
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
182
182
|
|
|
183
183
|
### Authorization
|
|
184
184
|
|
|
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.addEventPassTypeTier(
|
|
|
198
198
|
[[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)
|
|
199
199
|
|
|
200
200
|
# **createEventPassType**
|
|
201
|
-
>
|
|
201
|
+
> AddEventOnSiteLabelPassType200Response createEventPassType(passTypeCreateInputs)
|
|
202
202
|
|
|
203
203
|
Creates a new pass type (ticket type) for the given event using the provided details, such as name, pricing, and availability; requires update permission on events.
|
|
204
204
|
|
|
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.createEventPassType(
|
|
|
233
233
|
|
|
234
234
|
### Return type
|
|
235
235
|
|
|
236
|
-
**
|
|
236
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
237
237
|
|
|
238
238
|
### Authorization
|
|
239
239
|
|
|
@@ -373,7 +373,7 @@ const { status, data } = await apiInstance.eventGetPassTypeCoupons(
|
|
|
373
373
|
[[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)
|
|
374
374
|
|
|
375
375
|
# **getEventPassType**
|
|
376
|
-
>
|
|
376
|
+
> AddEventOnSiteLabelPassType200Response getEventPassType()
|
|
377
377
|
|
|
378
378
|
Retrieves the full details of a single pass type belonging to an event, identified by its ID; requires read access to the event.
|
|
379
379
|
|
|
@@ -407,7 +407,7 @@ const { status, data } = await apiInstance.getEventPassType(
|
|
|
407
407
|
|
|
408
408
|
### Return type
|
|
409
409
|
|
|
410
|
-
**
|
|
410
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
411
411
|
|
|
412
412
|
### Authorization
|
|
413
413
|
|
|
@@ -826,7 +826,7 @@ const { status, data } = await apiInstance.getEventPassTypes(
|
|
|
826
826
|
[[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)
|
|
827
827
|
|
|
828
828
|
# **removeEventPassTypeAddOn**
|
|
829
|
-
>
|
|
829
|
+
> AddEventOnSiteLabelPassType200Response removeEventPassTypeAddOn()
|
|
830
830
|
|
|
831
831
|
Detaches an add-on from an event pass type so it is no longer offered alongside that pass type; requires update permission on events.
|
|
832
832
|
|
|
@@ -863,7 +863,7 @@ const { status, data } = await apiInstance.removeEventPassTypeAddOn(
|
|
|
863
863
|
|
|
864
864
|
### Return type
|
|
865
865
|
|
|
866
|
-
**
|
|
866
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
867
867
|
|
|
868
868
|
### Authorization
|
|
869
869
|
|
|
@@ -883,7 +883,7 @@ const { status, data } = await apiInstance.removeEventPassTypeAddOn(
|
|
|
883
883
|
[[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)
|
|
884
884
|
|
|
885
885
|
# **removeEventPassTypeGroupPassTier**
|
|
886
|
-
>
|
|
886
|
+
> AddEventOnSiteLabelPassType200Response removeEventPassTypeGroupPassTier()
|
|
887
887
|
|
|
888
888
|
Removes an account tier from the list of tiers allowed to purchase an event pass type as a group pass; requires update permission on events.
|
|
889
889
|
|
|
@@ -920,7 +920,7 @@ const { status, data } = await apiInstance.removeEventPassTypeGroupPassTier(
|
|
|
920
920
|
|
|
921
921
|
### Return type
|
|
922
922
|
|
|
923
|
-
**
|
|
923
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
924
924
|
|
|
925
925
|
### Authorization
|
|
926
926
|
|
|
@@ -940,7 +940,7 @@ const { status, data } = await apiInstance.removeEventPassTypeGroupPassTier(
|
|
|
940
940
|
[[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)
|
|
941
941
|
|
|
942
942
|
# **removeEventPassTypeTier**
|
|
943
|
-
>
|
|
943
|
+
> AddEventOnSiteLabelPassType200Response removeEventPassTypeTier()
|
|
944
944
|
|
|
945
945
|
Removes an account tier from either the allowed or disallowed tier list of an event pass type depending on the `allowed` flag; requires update permission on events.
|
|
946
946
|
|
|
@@ -980,7 +980,7 @@ const { status, data } = await apiInstance.removeEventPassTypeTier(
|
|
|
980
980
|
|
|
981
981
|
### Return type
|
|
982
982
|
|
|
983
|
-
**
|
|
983
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
984
984
|
|
|
985
985
|
### Authorization
|
|
986
986
|
|
|
@@ -1000,7 +1000,7 @@ const { status, data } = await apiInstance.removeEventPassTypeTier(
|
|
|
1000
1000
|
[[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)
|
|
1001
1001
|
|
|
1002
1002
|
# **updateEventPassType**
|
|
1003
|
-
>
|
|
1003
|
+
> AddEventOnSiteLabelPassType200Response updateEventPassType(passTypeUpdateInputs)
|
|
1004
1004
|
|
|
1005
1005
|
Updates the details of an existing pass type on the given event, such as its name, pricing, or availability; requires update permission on events.
|
|
1006
1006
|
|
|
@@ -1038,7 +1038,7 @@ const { status, data } = await apiInstance.updateEventPassType(
|
|
|
1038
1038
|
|
|
1039
1039
|
### Return type
|
|
1040
1040
|
|
|
1041
|
-
**
|
|
1041
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
1042
1042
|
|
|
1043
1043
|
### Authorization
|
|
1044
1044
|
|
|
@@ -11,7 +11,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
11
|
|[**updateEventPassTypePriceSchedule**](#updateeventpasstypepriceschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Update a pass type price schedule|
|
|
12
12
|
|
|
13
13
|
# **createEventPassTypePriceSchedule**
|
|
14
|
-
>
|
|
14
|
+
> AddEventOnSiteLabelPassType200Response createEventPassTypePriceSchedule(passTypePriceScheduleCreateInputs)
|
|
15
15
|
|
|
16
16
|
Creates a time-windowed price schedule for an event pass type, rejecting the request if its date range overlaps an existing schedule; requires update permission on events.
|
|
17
17
|
|
|
@@ -49,7 +49,7 @@ const { status, data } = await apiInstance.createEventPassTypePriceSchedule(
|
|
|
49
49
|
|
|
50
50
|
### Return type
|
|
51
51
|
|
|
52
|
-
**
|
|
52
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
53
53
|
|
|
54
54
|
### Authorization
|
|
55
55
|
|
|
@@ -11,7 +11,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
11
|
|[**updateEventPassTypeRefundSchedule**](#updateeventpasstyperefundschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Update a pass type refund schedule|
|
|
12
12
|
|
|
13
13
|
# **createEventPassTypeRefundSchedule**
|
|
14
|
-
>
|
|
14
|
+
> AddEventOnSiteLabelPassType200Response createEventPassTypeRefundSchedule(passTypeRefundScheduleCreateInputs)
|
|
15
15
|
|
|
16
16
|
Creates a time-windowed refund schedule for an event pass type, defining the refund terms available during that date range; requires update permission on events.
|
|
17
17
|
|
|
@@ -49,7 +49,7 @@ const { status, data } = await apiInstance.createEventPassTypeRefundSchedule(
|
|
|
49
49
|
|
|
50
50
|
### Return type
|
|
51
51
|
|
|
52
|
-
**
|
|
52
|
+
**AddEventOnSiteLabelPassType200Response**
|
|
53
53
|
|
|
54
54
|
### Authorization
|
|
55
55
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetEventOnSiteLabels200Response
|
|
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<EventOnSiteLabel>**](EventOnSiteLabel.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetEventOnSiteLabels200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetEventOnSiteLabels200Response = {
|
|
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)
|
package/docs/Payment.md
CHANGED
|
@@ -13,6 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**stripeId** | **string** | | [default to undefined]
|
|
14
14
|
**last4** | **string** | | [default to undefined]
|
|
15
15
|
**debugId** | **string** | | [default to undefined]
|
|
16
|
+
**accountName** | **string** | | [default to undefined]
|
|
17
|
+
**accountEmail** | **string** | | [default to undefined]
|
|
16
18
|
**address1** | **string** | | [default to undefined]
|
|
17
19
|
**address2** | **string** | | [default to undefined]
|
|
18
20
|
**city** | **string** | | [default to undefined]
|
|
@@ -79,6 +81,8 @@ const instance: Payment = {
|
|
|
79
81
|
stripeId,
|
|
80
82
|
last4,
|
|
81
83
|
debugId,
|
|
84
|
+
accountName,
|
|
85
|
+
accountEmail,
|
|
82
86
|
address1,
|
|
83
87
|
address2,
|
|
84
88
|
city,
|