@connectedxm/admin-sdk 6.8.6 → 6.9.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/docs/Series.md CHANGED
@@ -17,6 +17,10 @@ Name | Type | Description | Notes
17
17
  **templateId** | **string** | | [default to undefined]
18
18
  **template** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
19
19
  **sortOrder** | **number** | | [default to undefined]
20
+ **price** | **number** | | [default to undefined]
21
+ **taxCode** | **string** | | [default to undefined]
22
+ **taxIncluded** | **boolean** | | [default to undefined]
23
+ **taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [default to undefined]
20
24
  **createdAt** | **string** | | [default to undefined]
21
25
  **updatedAt** | **string** | | [default to undefined]
22
26
 
@@ -38,6 +42,10 @@ const instance: Series = {
38
42
  templateId,
39
43
  template,
40
44
  sortOrder,
45
+ price,
46
+ taxCode,
47
+ taxIncluded,
48
+ taxLocation,
41
49
  createdAt,
42
50
  updatedAt,
43
51
  };
@@ -13,6 +13,11 @@ Name | Type | Description | Notes
13
13
  **templateId** | **string** | | [default to undefined]
14
14
  **startDate** | **string** | | [optional] [default to undefined]
15
15
  **endDate** | **string** | | [optional] [default to undefined]
16
+ **registration** | **boolean** | | [optional] [default to undefined]
17
+ **price** | **number** | | [optional] [default to undefined]
18
+ **taxCode** | **string** | | [optional] [default to undefined]
19
+ **taxIncluded** | **boolean** | | [optional] [default to undefined]
20
+ **taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
16
21
 
17
22
  ## Example
18
23
 
@@ -28,6 +33,11 @@ const instance: SeriesCreateInputs = {
28
33
  templateId,
29
34
  startDate,
30
35
  endDate,
36
+ registration,
37
+ price,
38
+ taxCode,
39
+ taxIncluded,
40
+ taxLocation,
31
41
  };
32
42
  ```
33
43
 
@@ -0,0 +1,36 @@
1
+ # SeriesRegistration
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **organizationId** | **string** | | [default to undefined]
10
+ **seriesId** | **string** | | [default to undefined]
11
+ **series** | [**BaseSeries**](BaseSeries.md) | | [default to undefined]
12
+ **accountId** | **string** | | [default to undefined]
13
+ **account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
14
+ **status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
15
+ **createdAt** | **string** | | [default to undefined]
16
+ **updatedAt** | **string** | | [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { SeriesRegistration } from '@connectedxm/admin-sdk';
22
+
23
+ const instance: SeriesRegistration = {
24
+ id,
25
+ organizationId,
26
+ seriesId,
27
+ series,
28
+ accountId,
29
+ account,
30
+ status,
31
+ createdAt,
32
+ updatedAt,
33
+ };
34
+ ```
35
+
36
+ [[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,20 @@
1
+ # SeriesRegistrationCreateInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **accountId** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { SeriesRegistrationCreateInputs } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: SeriesRegistrationCreateInputs = {
16
+ accountId,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # SeriesRegistrationUpdateInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | [**PurchaseStatus**](PurchaseStatus.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { SeriesRegistrationUpdateInputs } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: SeriesRegistrationUpdateInputs = {
16
+ status,
17
+ };
18
+ ```
19
+
20
+ [[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,354 @@
1
+ # SeriesRegistrationsApi
2
+
3
+ All URIs are relative to *https://admin-api.connected.dev*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createSeriesRegistration**](#createseriesregistration) | **POST** /series/{seriesId}/registrations | Create Series Registration|
8
+ |[**deleteSeriesRegistration**](#deleteseriesregistration) | **DELETE** /series/{seriesId}/registrations/{registrationId} | Delete Series Registration|
9
+ |[**getSeriesRegistration**](#getseriesregistration) | **GET** /series/{seriesId}/registrations/{registrationId} | Get Series Registration|
10
+ |[**getSeriesRegistrationPasses**](#getseriesregistrationpasses) | **GET** /series/{seriesId}/registrations/{registrationId}/passes | Get Series Registration Passes|
11
+ |[**getSeriesRegistrations**](#getseriesregistrations) | **GET** /series/{seriesId}/registrations | Get Series Registrations|
12
+ |[**updateSeriesRegistration**](#updateseriesregistration) | **PUT** /series/{seriesId}/registrations/{registrationId} | Update Series Registration|
13
+
14
+ # **createSeriesRegistration**
15
+ > CreateAccountAddress200Response createSeriesRegistration(seriesRegistrationCreateInputs)
16
+
17
+ Create Series Registration endpoint
18
+
19
+ ### Example
20
+
21
+ ```typescript
22
+ import {
23
+ SeriesRegistrationsApi,
24
+ Configuration,
25
+ SeriesRegistrationCreateInputs
26
+ } from '@connectedxm/admin-sdk';
27
+
28
+ const configuration = new Configuration();
29
+ const apiInstance = new SeriesRegistrationsApi(configuration);
30
+
31
+ let seriesId: string; //The series identifier (default to undefined)
32
+ let seriesRegistrationCreateInputs: SeriesRegistrationCreateInputs; //
33
+
34
+ const { status, data } = await apiInstance.createSeriesRegistration(
35
+ seriesId,
36
+ seriesRegistrationCreateInputs
37
+ );
38
+ ```
39
+
40
+ ### Parameters
41
+
42
+ |Name | Type | Description | Notes|
43
+ |------------- | ------------- | ------------- | -------------|
44
+ | **seriesRegistrationCreateInputs** | **SeriesRegistrationCreateInputs**| | |
45
+ | **seriesId** | [**string**] | The series identifier | defaults to undefined|
46
+
47
+
48
+ ### Return type
49
+
50
+ **CreateAccountAddress200Response**
51
+
52
+ ### Authorization
53
+
54
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: application/json
59
+ - **Accept**: application/json
60
+
61
+
62
+ ### HTTP response details
63
+ | Status code | Description | Response headers |
64
+ |-------------|-------------|------------------|
65
+ |**200** | Successful response | - |
66
+
67
+ [[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)
68
+
69
+ # **deleteSeriesRegistration**
70
+ > CreateAccountInvitations200Response deleteSeriesRegistration()
71
+
72
+ Delete Series Registration endpoint
73
+
74
+ ### Example
75
+
76
+ ```typescript
77
+ import {
78
+ SeriesRegistrationsApi,
79
+ Configuration
80
+ } from '@connectedxm/admin-sdk';
81
+
82
+ const configuration = new Configuration();
83
+ const apiInstance = new SeriesRegistrationsApi(configuration);
84
+
85
+ let seriesId: string; //The series identifier (default to undefined)
86
+ let registrationId: string; //The registration identifier (default to undefined)
87
+
88
+ const { status, data } = await apiInstance.deleteSeriesRegistration(
89
+ seriesId,
90
+ registrationId
91
+ );
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ |Name | Type | Description | Notes|
97
+ |------------- | ------------- | ------------- | -------------|
98
+ | **seriesId** | [**string**] | The series identifier | defaults to undefined|
99
+ | **registrationId** | [**string**] | The registration identifier | defaults to undefined|
100
+
101
+
102
+ ### Return type
103
+
104
+ **CreateAccountInvitations200Response**
105
+
106
+ ### Authorization
107
+
108
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
109
+
110
+ ### HTTP request headers
111
+
112
+ - **Content-Type**: Not defined
113
+ - **Accept**: application/json
114
+
115
+
116
+ ### HTTP response details
117
+ | Status code | Description | Response headers |
118
+ |-------------|-------------|------------------|
119
+ |**200** | Successful response | - |
120
+
121
+ [[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)
122
+
123
+ # **getSeriesRegistration**
124
+ > CreateAccountAddress200Response getSeriesRegistration()
125
+
126
+ Get Series Registration endpoint
127
+
128
+ ### Example
129
+
130
+ ```typescript
131
+ import {
132
+ SeriesRegistrationsApi,
133
+ Configuration
134
+ } from '@connectedxm/admin-sdk';
135
+
136
+ const configuration = new Configuration();
137
+ const apiInstance = new SeriesRegistrationsApi(configuration);
138
+
139
+ let seriesId: string; //The series identifier (default to undefined)
140
+ let registrationId: string; //The registration identifier (default to undefined)
141
+
142
+ const { status, data } = await apiInstance.getSeriesRegistration(
143
+ seriesId,
144
+ registrationId
145
+ );
146
+ ```
147
+
148
+ ### Parameters
149
+
150
+ |Name | Type | Description | Notes|
151
+ |------------- | ------------- | ------------- | -------------|
152
+ | **seriesId** | [**string**] | The series identifier | defaults to undefined|
153
+ | **registrationId** | [**string**] | The registration identifier | defaults to undefined|
154
+
155
+
156
+ ### Return type
157
+
158
+ **CreateAccountAddress200Response**
159
+
160
+ ### Authorization
161
+
162
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
163
+
164
+ ### HTTP request headers
165
+
166
+ - **Content-Type**: Not defined
167
+ - **Accept**: application/json
168
+
169
+
170
+ ### HTTP response details
171
+ | Status code | Description | Response headers |
172
+ |-------------|-------------|------------------|
173
+ |**200** | Successful response | - |
174
+
175
+ [[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)
176
+
177
+ # **getSeriesRegistrationPasses**
178
+ > CreateAccountAddress200Response getSeriesRegistrationPasses()
179
+
180
+ Get Series Registration Passes endpoint
181
+
182
+ ### Example
183
+
184
+ ```typescript
185
+ import {
186
+ SeriesRegistrationsApi,
187
+ Configuration
188
+ } from '@connectedxm/admin-sdk';
189
+
190
+ const configuration = new Configuration();
191
+ const apiInstance = new SeriesRegistrationsApi(configuration);
192
+
193
+ let seriesId: string; //The series identifier (default to undefined)
194
+ let registrationId: string; //The registration identifier (default to undefined)
195
+
196
+ const { status, data } = await apiInstance.getSeriesRegistrationPasses(
197
+ seriesId,
198
+ registrationId
199
+ );
200
+ ```
201
+
202
+ ### Parameters
203
+
204
+ |Name | Type | Description | Notes|
205
+ |------------- | ------------- | ------------- | -------------|
206
+ | **seriesId** | [**string**] | The series identifier | defaults to undefined|
207
+ | **registrationId** | [**string**] | The registration identifier | defaults to undefined|
208
+
209
+
210
+ ### Return type
211
+
212
+ **CreateAccountAddress200Response**
213
+
214
+ ### Authorization
215
+
216
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
217
+
218
+ ### HTTP request headers
219
+
220
+ - **Content-Type**: Not defined
221
+ - **Accept**: application/json
222
+
223
+
224
+ ### HTTP response details
225
+ | Status code | Description | Response headers |
226
+ |-------------|-------------|------------------|
227
+ |**200** | Successful response | - |
228
+
229
+ [[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)
230
+
231
+ # **getSeriesRegistrations**
232
+ > GetAccountInvitations200Response getSeriesRegistrations()
233
+
234
+ Get Series Registrations endpoint
235
+
236
+ ### Example
237
+
238
+ ```typescript
239
+ import {
240
+ SeriesRegistrationsApi,
241
+ Configuration
242
+ } from '@connectedxm/admin-sdk';
243
+
244
+ const configuration = new Configuration();
245
+ const apiInstance = new SeriesRegistrationsApi(configuration);
246
+
247
+ let seriesId: string; //The series identifier (default to undefined)
248
+ let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
249
+ let page: number; //Page number (optional) (default to 1)
250
+ let pageSize: number; //Number of items per page (optional) (default to 25)
251
+ let orderBy: string; //Field to order by (optional) (default to undefined)
252
+ let search: string; //Search query (optional) (default to undefined)
253
+
254
+ const { status, data } = await apiInstance.getSeriesRegistrations(
255
+ seriesId,
256
+ status,
257
+ page,
258
+ pageSize,
259
+ orderBy,
260
+ search
261
+ );
262
+ ```
263
+
264
+ ### Parameters
265
+
266
+ |Name | Type | Description | Notes|
267
+ |------------- | ------------- | ------------- | -------------|
268
+ | **seriesId** | [**string**] | The series identifier | defaults to undefined|
269
+ | **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
270
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
271
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
272
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
273
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
274
+
275
+
276
+ ### Return type
277
+
278
+ **GetAccountInvitations200Response**
279
+
280
+ ### Authorization
281
+
282
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
283
+
284
+ ### HTTP request headers
285
+
286
+ - **Content-Type**: Not defined
287
+ - **Accept**: application/json
288
+
289
+
290
+ ### HTTP response details
291
+ | Status code | Description | Response headers |
292
+ |-------------|-------------|------------------|
293
+ |**200** | Successful response | - |
294
+
295
+ [[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)
296
+
297
+ # **updateSeriesRegistration**
298
+ > CreateAccountAddress200Response updateSeriesRegistration(seriesRegistrationUpdateInputs)
299
+
300
+ Update Series Registration endpoint
301
+
302
+ ### Example
303
+
304
+ ```typescript
305
+ import {
306
+ SeriesRegistrationsApi,
307
+ Configuration,
308
+ SeriesRegistrationUpdateInputs
309
+ } from '@connectedxm/admin-sdk';
310
+
311
+ const configuration = new Configuration();
312
+ const apiInstance = new SeriesRegistrationsApi(configuration);
313
+
314
+ let seriesId: string; //The series identifier (default to undefined)
315
+ let registrationId: string; //The registration identifier (default to undefined)
316
+ let seriesRegistrationUpdateInputs: SeriesRegistrationUpdateInputs; //
317
+
318
+ const { status, data } = await apiInstance.updateSeriesRegistration(
319
+ seriesId,
320
+ registrationId,
321
+ seriesRegistrationUpdateInputs
322
+ );
323
+ ```
324
+
325
+ ### Parameters
326
+
327
+ |Name | Type | Description | Notes|
328
+ |------------- | ------------- | ------------- | -------------|
329
+ | **seriesRegistrationUpdateInputs** | **SeriesRegistrationUpdateInputs**| | |
330
+ | **seriesId** | [**string**] | The series identifier | defaults to undefined|
331
+ | **registrationId** | [**string**] | The registration identifier | defaults to undefined|
332
+
333
+
334
+ ### Return type
335
+
336
+ **CreateAccountAddress200Response**
337
+
338
+ ### Authorization
339
+
340
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: application/json
345
+ - **Accept**: application/json
346
+
347
+
348
+ ### HTTP response details
349
+ | Status code | Description | Response headers |
350
+ |-------------|-------------|------------------|
351
+ |**200** | Successful response | - |
352
+
353
+ [[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)
354
+
@@ -13,6 +13,11 @@ Name | Type | Description | Notes
13
13
  **templateId** | **string** | | [optional] [default to undefined]
14
14
  **startDate** | **string** | | [optional] [default to undefined]
15
15
  **endDate** | **string** | | [optional] [default to undefined]
16
+ **registration** | **boolean** | | [optional] [default to undefined]
17
+ **price** | **number** | | [optional] [default to undefined]
18
+ **taxCode** | **string** | | [optional] [default to undefined]
19
+ **taxIncluded** | **boolean** | | [optional] [default to undefined]
20
+ **taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
16
21
 
17
22
  ## Example
18
23
 
@@ -28,6 +33,11 @@ const instance: SeriesUpdateInputs = {
28
33
  templateId,
29
34
  startDate,
30
35
  endDate,
36
+ registration,
37
+ price,
38
+ taxCode,
39
+ taxIncluded,
40
+ taxLocation,
31
41
  };
32
42
  ```
33
43
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "6.8.6",
3
+ "version": "6.9.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {