@connectedxm/admin-sdk 6.7.7 → 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.
Files changed (44) hide show
  1. package/.openapi-generator/FILES +13 -0
  2. package/AdminApi.ts +9 -1
  3. package/README.md +28 -0
  4. package/api.ts +2619 -564
  5. package/dist/AdminApi.d.ts +5 -1
  6. package/dist/AdminApi.js +4 -1
  7. package/dist/api.d.ts +1122 -30
  8. package/dist/api.js +1759 -286
  9. package/dist/esm/AdminApi.d.ts +5 -1
  10. package/dist/esm/AdminApi.js +5 -2
  11. package/dist/esm/api.d.ts +1122 -30
  12. package/dist/esm/api.js +1729 -264
  13. package/docs/AccountCreateInputs.md +2 -0
  14. package/docs/AccountUpdateInputs.md +2 -0
  15. package/docs/BaseEventActivation.md +2 -0
  16. package/docs/BaseEventBlock.md +28 -0
  17. package/docs/BaseSeriesRegistration.md +32 -0
  18. package/docs/BaseSurvey.md +2 -0
  19. package/docs/BaseSurveySubmission.md +6 -0
  20. package/docs/CreateEventBlock200Response.md +24 -0
  21. package/docs/EventActivation.md +2 -0
  22. package/docs/EventBlock.md +36 -0
  23. package/docs/EventBlockCreateInputs.md +26 -0
  24. package/docs/EventBlockUpdateInputs.md +26 -0
  25. package/docs/EventSession.md +2 -0
  26. package/docs/EventsBlocksApi.md +479 -0
  27. package/docs/EventsCouponsApi.md +3 -0
  28. package/docs/EventsSessionsApi.md +183 -0
  29. package/docs/GetEventBlocks200Response.md +26 -0
  30. package/docs/Series.md +8 -0
  31. package/docs/SeriesCreateInputs.md +10 -0
  32. package/docs/SeriesRegistration.md +36 -0
  33. package/docs/SeriesRegistrationCreateInputs.md +20 -0
  34. package/docs/SeriesRegistrationUpdateInputs.md +20 -0
  35. package/docs/SeriesRegistrationsApi.md +354 -0
  36. package/docs/SeriesUpdateInputs.md +10 -0
  37. package/docs/Survey.md +18 -0
  38. package/docs/SurveyAllOfCount.md +20 -0
  39. package/docs/SurveyCreateInputs.md +8 -0
  40. package/docs/SurveySubmission.md +6 -0
  41. package/docs/SurveySubmissionUpdateInputs.md +4 -0
  42. package/docs/SurveyUpdateInputs.md +8 -0
  43. package/docs/SurveysApi.md +6 -0
  44. package/package.json +1 -1
@@ -5,6 +5,7 @@ All URIs are relative to *https://admin-api.connected.dev*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**addEventSessionAccount**](#addeventsessionaccount) | **POST** /events/{eventId}/sessions/{sessionId}/accounts/{accountId} | Add Event Session Account|
8
+ |[**addEventSessionBlock**](#addeventsessionblock) | **POST** /events/{eventId}/sessions/{sessionId}/blocks/{blockId} | Add Event Session Block|
8
9
  |[**addEventSessionPassType**](#addeventsessionpasstype) | **POST** /events/{eventId}/sessions/{sessionId}/passTypes/{passTypeId} | Add Event Session Pass Type|
9
10
  |[**addEventSessionSpeaker**](#addeventsessionspeaker) | **POST** /events/{eventId}/sessions/{sessionId}/speakers/{speakerId} | Add Event Session Speaker|
10
11
  |[**addEventSessionSponsor**](#addeventsessionsponsor) | **POST** /events/{eventId}/sessions/{sessionId}/sponsors/{sponsorId} | Add Event Session Sponsor|
@@ -14,6 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
14
15
  |[**getEventSession**](#geteventsession) | **GET** /events/{eventId}/sessions/{sessionId} | Get Event Session|
15
16
  |[**getEventSessionAccesses**](#geteventsessionaccesses) | **GET** /events/{eventId}/sessions/{sessionId}/accesses | Get Event Session Accesses|
16
17
  |[**getEventSessionAccounts**](#geteventsessionaccounts) | **GET** /events/{eventId}/sessions/{sessionId}/accounts | Get Event Session Accounts|
18
+ |[**getEventSessionBlocks**](#geteventsessionblocks) | **GET** /events/{eventId}/sessions/{sessionId}/blocks | Get Event Session Blocks|
17
19
  |[**getEventSessionPassTypes**](#geteventsessionpasstypes) | **GET** /events/{eventId}/sessions/{sessionId}/passTypes | Get Event Session Pass Types|
18
20
  |[**getEventSessionPayments**](#geteventsessionpayments) | **GET** /events/{eventId}/sessions/{sessionId}/payments | Get Event Session Payments|
19
21
  |[**getEventSessionSpeakers**](#geteventsessionspeakers) | **GET** /events/{eventId}/sessions/{sessionId}/speakers | Get Event Session Speakers|
@@ -21,6 +23,7 @@ All URIs are relative to *https://admin-api.connected.dev*
21
23
  |[**getEventSessionTracks**](#geteventsessiontracks) | **GET** /events/{eventId}/sessions/{sessionId}/tracks | Get Event Session Tracks|
22
24
  |[**getEventSessions**](#geteventsessions) | **GET** /events/{eventId}/sessions | Get Event Sessions|
23
25
  |[**removeEventSessionAccount**](#removeeventsessionaccount) | **DELETE** /events/{eventId}/sessions/{sessionId}/accounts/{accountId} | Remove Event Session Account|
26
+ |[**removeEventSessionBlock**](#removeeventsessionblock) | **DELETE** /events/{eventId}/sessions/{sessionId}/blocks/{blockId} | Remove Event Session Block|
24
27
  |[**removeEventSessionPassType**](#removeeventsessionpasstype) | **DELETE** /events/{eventId}/sessions/{sessionId}/passTypes/{passTypeId} | Remove Event Session Pass Type|
25
28
  |[**removeEventSessionSpeaker**](#removeeventsessionspeaker) | **DELETE** /events/{eventId}/sessions/{sessionId}/speakers/{speakerId} | Remove Event Session Speaker|
26
29
  |[**removeEventSessionSponsor**](#removeeventsessionsponsor) | **DELETE** /events/{eventId}/sessions/{sessionId}/sponsors/{sponsorId} | Remove Event Session Sponsor|
@@ -77,6 +80,63 @@ const { status, data } = await apiInstance.addEventSessionAccount(
77
80
  - **Accept**: application/json
78
81
 
79
82
 
83
+ ### HTTP response details
84
+ | Status code | Description | Response headers |
85
+ |-------------|-------------|------------------|
86
+ |**200** | Successful response | - |
87
+
88
+ [[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)
89
+
90
+ # **addEventSessionBlock**
91
+ > CreateEventSession200Response addEventSessionBlock()
92
+
93
+ Add Event Session Block endpoint
94
+
95
+ ### Example
96
+
97
+ ```typescript
98
+ import {
99
+ EventsSessionsApi,
100
+ Configuration
101
+ } from '@connectedxm/admin-sdk';
102
+
103
+ const configuration = new Configuration();
104
+ const apiInstance = new EventsSessionsApi(configuration);
105
+
106
+ let eventId: string; //The event identifier (default to undefined)
107
+ let sessionId: string; //The session identifier (default to undefined)
108
+ let blockId: string; //The block identifier (default to undefined)
109
+
110
+ const { status, data } = await apiInstance.addEventSessionBlock(
111
+ eventId,
112
+ sessionId,
113
+ blockId
114
+ );
115
+ ```
116
+
117
+ ### Parameters
118
+
119
+ |Name | Type | Description | Notes|
120
+ |------------- | ------------- | ------------- | -------------|
121
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
122
+ | **sessionId** | [**string**] | The session identifier | defaults to undefined|
123
+ | **blockId** | [**string**] | The block identifier | defaults to undefined|
124
+
125
+
126
+ ### Return type
127
+
128
+ **CreateEventSession200Response**
129
+
130
+ ### Authorization
131
+
132
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
133
+
134
+ ### HTTP request headers
135
+
136
+ - **Content-Type**: Not defined
137
+ - **Accept**: application/json
138
+
139
+
80
140
  ### HTTP response details
81
141
  | Status code | Description | Response headers |
82
142
  |-------------|-------------|------------------|
@@ -603,6 +663,72 @@ const { status, data } = await apiInstance.getEventSessionAccounts(
603
663
  - **Accept**: application/json
604
664
 
605
665
 
666
+ ### HTTP response details
667
+ | Status code | Description | Response headers |
668
+ |-------------|-------------|------------------|
669
+ |**200** | Successful response | - |
670
+
671
+ [[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)
672
+
673
+ # **getEventSessionBlocks**
674
+ > GetEventBlocks200Response getEventSessionBlocks()
675
+
676
+ Get Event Session Blocks endpoint
677
+
678
+ ### Example
679
+
680
+ ```typescript
681
+ import {
682
+ EventsSessionsApi,
683
+ Configuration
684
+ } from '@connectedxm/admin-sdk';
685
+
686
+ const configuration = new Configuration();
687
+ const apiInstance = new EventsSessionsApi(configuration);
688
+
689
+ let eventId: string; //The event identifier (default to undefined)
690
+ let sessionId: string; //The session identifier (default to undefined)
691
+ let page: number; //Page number (optional) (default to 1)
692
+ let pageSize: number; //Number of items per page (optional) (default to 25)
693
+ let orderBy: string; //Field to order by (optional) (default to undefined)
694
+ let search: string; //Search query (optional) (default to undefined)
695
+
696
+ const { status, data } = await apiInstance.getEventSessionBlocks(
697
+ eventId,
698
+ sessionId,
699
+ page,
700
+ pageSize,
701
+ orderBy,
702
+ search
703
+ );
704
+ ```
705
+
706
+ ### Parameters
707
+
708
+ |Name | Type | Description | Notes|
709
+ |------------- | ------------- | ------------- | -------------|
710
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
711
+ | **sessionId** | [**string**] | The session identifier | defaults to undefined|
712
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
713
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
714
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
715
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
716
+
717
+
718
+ ### Return type
719
+
720
+ **GetEventBlocks200Response**
721
+
722
+ ### Authorization
723
+
724
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
725
+
726
+ ### HTTP request headers
727
+
728
+ - **Content-Type**: Not defined
729
+ - **Accept**: application/json
730
+
731
+
606
732
  ### HTTP response details
607
733
  | Status code | Description | Response headers |
608
734
  |-------------|-------------|------------------|
@@ -1039,6 +1165,63 @@ const { status, data } = await apiInstance.removeEventSessionAccount(
1039
1165
  | **accountId** | [**string**] | The account identifier | defaults to undefined|
1040
1166
 
1041
1167
 
1168
+ ### Return type
1169
+
1170
+ **CreateAccountAddress200Response**
1171
+
1172
+ ### Authorization
1173
+
1174
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
1175
+
1176
+ ### HTTP request headers
1177
+
1178
+ - **Content-Type**: Not defined
1179
+ - **Accept**: application/json
1180
+
1181
+
1182
+ ### HTTP response details
1183
+ | Status code | Description | Response headers |
1184
+ |-------------|-------------|------------------|
1185
+ |**200** | Successful response | - |
1186
+
1187
+ [[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)
1188
+
1189
+ # **removeEventSessionBlock**
1190
+ > CreateAccountAddress200Response removeEventSessionBlock()
1191
+
1192
+ Remove Event Session Block endpoint
1193
+
1194
+ ### Example
1195
+
1196
+ ```typescript
1197
+ import {
1198
+ EventsSessionsApi,
1199
+ Configuration
1200
+ } from '@connectedxm/admin-sdk';
1201
+
1202
+ const configuration = new Configuration();
1203
+ const apiInstance = new EventsSessionsApi(configuration);
1204
+
1205
+ let eventId: string; //The event identifier (default to undefined)
1206
+ let sessionId: string; //The session identifier (default to undefined)
1207
+ let blockId: string; //The block identifier (default to undefined)
1208
+
1209
+ const { status, data } = await apiInstance.removeEventSessionBlock(
1210
+ eventId,
1211
+ sessionId,
1212
+ blockId
1213
+ );
1214
+ ```
1215
+
1216
+ ### Parameters
1217
+
1218
+ |Name | Type | Description | Notes|
1219
+ |------------- | ------------- | ------------- | -------------|
1220
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
1221
+ | **sessionId** | [**string**] | The session identifier | defaults to undefined|
1222
+ | **blockId** | [**string**] | The block identifier | defaults to undefined|
1223
+
1224
+
1042
1225
  ### Return type
1043
1226
 
1044
1227
  **CreateAccountAddress200Response**
@@ -0,0 +1,26 @@
1
+ # GetEventBlocks200Response
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<EventBlock>**](EventBlock.md) | | [default to undefined]
11
+ **count** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { GetEventBlocks200Response } from '@connectedxm/admin-sdk';
17
+
18
+ const instance: GetEventBlocks200Response = {
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/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)