@connectedxm/admin-sdk 6.27.1 → 6.28.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 +2 -0
- package/AdminApi.ts +3 -0
- package/README.md +4 -0
- package/api.ts +396 -0
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +210 -0
- package/dist/api.js +301 -9
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +210 -0
- package/dist/esm/api.js +287 -0
- package/docs/BaseEventSession.md +2 -0
- package/docs/EventSession.md +6 -0
- package/docs/EventSessionCreateInputs.md +4 -0
- package/docs/EventSessionPrice.md +24 -0
- package/docs/EventSessionUpdateInputs.md +4 -0
- package/docs/EventsSessionsPricesApi.md +190 -0
- package/package.json +1 -1
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# EventsSessionsPricesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createEventSessionPrice**](#createeventsessionprice) | **POST** /events/{eventId}/sessions/{sessionId}/prices | Create Event Session Price|
|
|
8
|
+
|[**deleteEventSessionPrice**](#deleteeventsessionprice) | **DELETE** /events/{eventId}/sessions/{sessionId}/prices/{priceId} | Delete Event Session Price|
|
|
9
|
+
|[**updateEventSessionPrice**](#updateeventsessionprice) | **PUT** /events/{eventId}/sessions/{sessionId}/prices/{priceId} | Update Event Session Price|
|
|
10
|
+
|
|
11
|
+
# **createEventSessionPrice**
|
|
12
|
+
> CreateEventSession200Response createEventSessionPrice()
|
|
13
|
+
|
|
14
|
+
Create Event Session Price endpoint
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
EventsSessionsPricesApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new EventsSessionsPricesApi(configuration);
|
|
26
|
+
|
|
27
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
28
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
29
|
+
let passTypeId: string; //Filter by passTypeId (default to undefined)
|
|
30
|
+
let price: number; //Filter by price (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.createEventSessionPrice(
|
|
33
|
+
eventId,
|
|
34
|
+
sessionId,
|
|
35
|
+
passTypeId,
|
|
36
|
+
price
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
45
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
46
|
+
| **passTypeId** | [**string**] | Filter by passTypeId | defaults to undefined|
|
|
47
|
+
| **price** | [**number**] | Filter by price | defaults to undefined|
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Return type
|
|
51
|
+
|
|
52
|
+
**CreateEventSession200Response**
|
|
53
|
+
|
|
54
|
+
### Authorization
|
|
55
|
+
|
|
56
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
57
|
+
|
|
58
|
+
### HTTP request headers
|
|
59
|
+
|
|
60
|
+
- **Content-Type**: Not defined
|
|
61
|
+
- **Accept**: application/json
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### HTTP response details
|
|
65
|
+
| Status code | Description | Response headers |
|
|
66
|
+
|-------------|-------------|------------------|
|
|
67
|
+
|**200** | Successful response | - |
|
|
68
|
+
|
|
69
|
+
[[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)
|
|
70
|
+
|
|
71
|
+
# **deleteEventSessionPrice**
|
|
72
|
+
> CreateEventSession200Response deleteEventSessionPrice()
|
|
73
|
+
|
|
74
|
+
Delete Event Session Price endpoint
|
|
75
|
+
|
|
76
|
+
### Example
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
import {
|
|
80
|
+
EventsSessionsPricesApi,
|
|
81
|
+
Configuration
|
|
82
|
+
} from '@connectedxm/admin-sdk';
|
|
83
|
+
|
|
84
|
+
const configuration = new Configuration();
|
|
85
|
+
const apiInstance = new EventsSessionsPricesApi(configuration);
|
|
86
|
+
|
|
87
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
88
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
89
|
+
let priceId: string; //The price identifier (default to undefined)
|
|
90
|
+
|
|
91
|
+
const { status, data } = await apiInstance.deleteEventSessionPrice(
|
|
92
|
+
eventId,
|
|
93
|
+
sessionId,
|
|
94
|
+
priceId
|
|
95
|
+
);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Parameters
|
|
99
|
+
|
|
100
|
+
|Name | Type | Description | Notes|
|
|
101
|
+
|------------- | ------------- | ------------- | -------------|
|
|
102
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
103
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
104
|
+
| **priceId** | [**string**] | The price identifier | defaults to undefined|
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
**CreateEventSession200Response**
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: Not defined
|
|
118
|
+
- **Accept**: application/json
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### HTTP response details
|
|
122
|
+
| Status code | Description | Response headers |
|
|
123
|
+
|-------------|-------------|------------------|
|
|
124
|
+
|**200** | Successful response | - |
|
|
125
|
+
|
|
126
|
+
[[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)
|
|
127
|
+
|
|
128
|
+
# **updateEventSessionPrice**
|
|
129
|
+
> CreateEventSession200Response updateEventSessionPrice()
|
|
130
|
+
|
|
131
|
+
Update Event Session Price endpoint
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
import {
|
|
137
|
+
EventsSessionsPricesApi,
|
|
138
|
+
Configuration
|
|
139
|
+
} from '@connectedxm/admin-sdk';
|
|
140
|
+
|
|
141
|
+
const configuration = new Configuration();
|
|
142
|
+
const apiInstance = new EventsSessionsPricesApi(configuration);
|
|
143
|
+
|
|
144
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
145
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
146
|
+
let priceId: string; //The price identifier (default to undefined)
|
|
147
|
+
let passTypeId: string; //Filter by passTypeId (optional) (default to undefined)
|
|
148
|
+
let price: number; //Filter by price (optional) (default to undefined)
|
|
149
|
+
|
|
150
|
+
const { status, data } = await apiInstance.updateEventSessionPrice(
|
|
151
|
+
eventId,
|
|
152
|
+
sessionId,
|
|
153
|
+
priceId,
|
|
154
|
+
passTypeId,
|
|
155
|
+
price
|
|
156
|
+
);
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Parameters
|
|
160
|
+
|
|
161
|
+
|Name | Type | Description | Notes|
|
|
162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
163
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
164
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
165
|
+
| **priceId** | [**string**] | The price identifier | defaults to undefined|
|
|
166
|
+
| **passTypeId** | [**string**] | Filter by passTypeId | (optional) defaults to undefined|
|
|
167
|
+
| **price** | [**number**] | Filter by price | (optional) defaults to undefined|
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### Return type
|
|
171
|
+
|
|
172
|
+
**CreateEventSession200Response**
|
|
173
|
+
|
|
174
|
+
### Authorization
|
|
175
|
+
|
|
176
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
177
|
+
|
|
178
|
+
### HTTP request headers
|
|
179
|
+
|
|
180
|
+
- **Content-Type**: Not defined
|
|
181
|
+
- **Accept**: application/json
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### HTTP response details
|
|
185
|
+
| Status code | Description | Response headers |
|
|
186
|
+
|-------------|-------------|------------------|
|
|
187
|
+
|**200** | Successful response | - |
|
|
188
|
+
|
|
189
|
+
[[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)
|
|
190
|
+
|