@connectedxm/admin-sdk 7.5.1 → 7.8.1
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 +1 -0
- package/README.md +3 -0
- package/api.ts +210 -14
- package/dist/api.d.ts +119 -14
- package/dist/api.js +146 -0
- package/dist/esm/api.d.ts +119 -14
- package/dist/esm/api.js +146 -0
- package/docs/BaseEvent.md +6 -0
- package/docs/BaseEventSessionLocation.md +4 -0
- package/docs/Event.md +10 -0
- package/docs/EventCreateInputs.md +0 -14
- package/docs/EventLocationInputs.md +38 -0
- package/docs/EventSessionLocation.md +8 -0
- package/docs/EventSessionLocationCreateInputs.md +8 -0
- package/docs/EventSessionLocationUpdateInputs.md +8 -0
- package/docs/EventUpdateInputs.md +0 -14
- package/docs/EventsApi.md +108 -0
- package/package.json +1 -1
|
@@ -7,13 +7,17 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**name** | **string** | | [default to undefined]
|
|
10
|
+
**room** | **string** | | [default to undefined]
|
|
10
11
|
**address1** | **string** | | [default to undefined]
|
|
11
12
|
**address2** | **string** | | [default to undefined]
|
|
12
13
|
**zip** | **string** | | [default to undefined]
|
|
13
14
|
**city** | **string** | | [default to undefined]
|
|
14
15
|
**state** | **string** | | [default to undefined]
|
|
15
16
|
**country** | **string** | | [default to undefined]
|
|
17
|
+
**location** | **string** | | [default to undefined]
|
|
16
18
|
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
19
|
+
**latitude** | **number** | | [default to undefined]
|
|
20
|
+
**longitude** | **number** | | [default to undefined]
|
|
17
21
|
**description** | **string** | | [default to undefined]
|
|
18
22
|
**createdAt** | **string** | | [default to undefined]
|
|
19
23
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -26,13 +30,17 @@ import { EventSessionLocation } from '@connectedxm/admin-sdk';
|
|
|
26
30
|
const instance: EventSessionLocation = {
|
|
27
31
|
id,
|
|
28
32
|
name,
|
|
33
|
+
room,
|
|
29
34
|
address1,
|
|
30
35
|
address2,
|
|
31
36
|
zip,
|
|
32
37
|
city,
|
|
33
38
|
state,
|
|
34
39
|
country,
|
|
40
|
+
location,
|
|
35
41
|
image,
|
|
42
|
+
latitude,
|
|
43
|
+
longitude,
|
|
36
44
|
description,
|
|
37
45
|
createdAt,
|
|
38
46
|
updatedAt,
|
|
@@ -5,7 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**location** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**name** | **string** | | [default to undefined]
|
|
10
|
+
**room** | **string** | | [optional] [default to undefined]
|
|
9
11
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
12
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
11
13
|
**address1** | **string** | | [optional] [default to undefined]
|
|
@@ -14,6 +16,8 @@ Name | Type | Description | Notes
|
|
|
14
16
|
**state** | **string** | | [optional] [default to undefined]
|
|
15
17
|
**country** | **string** | | [optional] [default to undefined]
|
|
16
18
|
**zip** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**latitude** | **number** | | [optional] [default to undefined]
|
|
20
|
+
**longitude** | **number** | | [optional] [default to undefined]
|
|
17
21
|
|
|
18
22
|
## Example
|
|
19
23
|
|
|
@@ -21,7 +25,9 @@ Name | Type | Description | Notes
|
|
|
21
25
|
import { EventSessionLocationCreateInputs } from '@connectedxm/admin-sdk';
|
|
22
26
|
|
|
23
27
|
const instance: EventSessionLocationCreateInputs = {
|
|
28
|
+
location,
|
|
24
29
|
name,
|
|
30
|
+
room,
|
|
25
31
|
description,
|
|
26
32
|
imageId,
|
|
27
33
|
address1,
|
|
@@ -30,6 +36,8 @@ const instance: EventSessionLocationCreateInputs = {
|
|
|
30
36
|
state,
|
|
31
37
|
country,
|
|
32
38
|
zip,
|
|
39
|
+
latitude,
|
|
40
|
+
longitude,
|
|
33
41
|
};
|
|
34
42
|
```
|
|
35
43
|
|
|
@@ -5,7 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**location** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**room** | **string** | | [optional] [default to undefined]
|
|
9
11
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
12
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
11
13
|
**address1** | **string** | | [optional] [default to undefined]
|
|
@@ -14,6 +16,8 @@ Name | Type | Description | Notes
|
|
|
14
16
|
**state** | **string** | | [optional] [default to undefined]
|
|
15
17
|
**country** | **string** | | [optional] [default to undefined]
|
|
16
18
|
**zip** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**latitude** | **number** | | [optional] [default to undefined]
|
|
20
|
+
**longitude** | **number** | | [optional] [default to undefined]
|
|
17
21
|
|
|
18
22
|
## Example
|
|
19
23
|
|
|
@@ -21,7 +25,9 @@ Name | Type | Description | Notes
|
|
|
21
25
|
import { EventSessionLocationUpdateInputs } from '@connectedxm/admin-sdk';
|
|
22
26
|
|
|
23
27
|
const instance: EventSessionLocationUpdateInputs = {
|
|
28
|
+
location,
|
|
24
29
|
name,
|
|
30
|
+
room,
|
|
25
31
|
description,
|
|
26
32
|
imageId,
|
|
27
33
|
address1,
|
|
@@ -30,6 +36,8 @@ const instance: EventSessionLocationUpdateInputs = {
|
|
|
30
36
|
state,
|
|
31
37
|
country,
|
|
32
38
|
zip,
|
|
39
|
+
latitude,
|
|
40
|
+
longitude,
|
|
33
41
|
};
|
|
34
42
|
```
|
|
35
43
|
|
|
@@ -23,13 +23,6 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
24
24
|
**squareImageId** | **string** | | [optional] [default to undefined]
|
|
25
25
|
**backgroundImageId** | **string** | | [optional] [default to undefined]
|
|
26
|
-
**venue** | **string** | | [optional] [default to undefined]
|
|
27
|
-
**address1** | **string** | | [optional] [default to undefined]
|
|
28
|
-
**address2** | **string** | | [optional] [default to undefined]
|
|
29
|
-
**city** | **string** | | [optional] [default to undefined]
|
|
30
|
-
**state** | **string** | | [optional] [default to undefined]
|
|
31
|
-
**country** | **string** | | [optional] [default to undefined]
|
|
32
|
-
**zip** | **string** | | [optional] [default to undefined]
|
|
33
26
|
**creatorId** | **string** | | [optional] [default to undefined]
|
|
34
27
|
**seriesId** | **string** | | [optional] [default to undefined]
|
|
35
28
|
**registration** | **boolean** | | [optional] [default to undefined]
|
|
@@ -92,13 +85,6 @@ const instance: EventUpdateInputs = {
|
|
|
92
85
|
imageId,
|
|
93
86
|
squareImageId,
|
|
94
87
|
backgroundImageId,
|
|
95
|
-
venue,
|
|
96
|
-
address1,
|
|
97
|
-
address2,
|
|
98
|
-
city,
|
|
99
|
-
state,
|
|
100
|
-
country,
|
|
101
|
-
zip,
|
|
102
88
|
creatorId,
|
|
103
89
|
seriesId,
|
|
104
90
|
registration,
|
package/docs/EventsApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
7
7
|
|[**cloneEvent**](#cloneevent) | **POST** /events/{eventId}/clone | Clone an event|
|
|
8
8
|
|[**createEvent**](#createevent) | **POST** /events | Create an event|
|
|
9
9
|
|[**deleteEvent**](#deleteevent) | **DELETE** /events/{eventId} | Delete an event|
|
|
10
|
+
|[**deleteEventLocation**](#deleteeventlocation) | **DELETE** /events/{eventId}/location | Delete an event\'s location|
|
|
10
11
|
|[**disableEventBuildMode**](#disableeventbuildmode) | **DELETE** /events/{eventId}/build-mode | Disable build mode for an event|
|
|
11
12
|
|[**enableEventBuildMode**](#enableeventbuildmode) | **POST** /events/{eventId}/build-mode | Enable build mode for an event|
|
|
12
13
|
|[**getEvent**](#getevent) | **GET** /events/{eventId} | Get an event|
|
|
@@ -14,6 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
14
15
|
|[**getEventPayments**](#geteventpayments) | **GET** /events/{eventId}/payments | List an event\'s payments|
|
|
15
16
|
|[**getEventTiers**](#geteventtiers) | **GET** /events/{eventId}/tiers | List an event\'s account tiers|
|
|
16
17
|
|[**getEvents**](#getevents) | **GET** /events | List events|
|
|
18
|
+
|[**setEventLocation**](#seteventlocation) | **PUT** /events/{eventId}/location | Set an event\'s location|
|
|
17
19
|
|[**updateEvent**](#updateevent) | **PUT** /events/{eventId} | Update an event|
|
|
18
20
|
|
|
19
21
|
# **cloneEvent**
|
|
@@ -167,6 +169,57 @@ const { status, data } = await apiInstance.deleteEvent(
|
|
|
167
169
|
- **Accept**: application/json
|
|
168
170
|
|
|
169
171
|
|
|
172
|
+
### HTTP response details
|
|
173
|
+
| Status code | Description | Response headers |
|
|
174
|
+
|-------------|-------------|------------------|
|
|
175
|
+
|**200** | Successful response | - |
|
|
176
|
+
|
|
177
|
+
[[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)
|
|
178
|
+
|
|
179
|
+
# **deleteEventLocation**
|
|
180
|
+
> CreateEvent200Response deleteEventLocation()
|
|
181
|
+
|
|
182
|
+
Clears the location details of an existing event, requiring the update events permission.
|
|
183
|
+
|
|
184
|
+
### Example
|
|
185
|
+
|
|
186
|
+
```typescript
|
|
187
|
+
import {
|
|
188
|
+
EventsApi,
|
|
189
|
+
Configuration
|
|
190
|
+
} from '@connectedxm/admin-sdk';
|
|
191
|
+
|
|
192
|
+
const configuration = new Configuration();
|
|
193
|
+
const apiInstance = new EventsApi(configuration);
|
|
194
|
+
|
|
195
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
196
|
+
|
|
197
|
+
const { status, data } = await apiInstance.deleteEventLocation(
|
|
198
|
+
eventId
|
|
199
|
+
);
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Parameters
|
|
203
|
+
|
|
204
|
+
|Name | Type | Description | Notes|
|
|
205
|
+
|------------- | ------------- | ------------- | -------------|
|
|
206
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
### Return type
|
|
210
|
+
|
|
211
|
+
**CreateEvent200Response**
|
|
212
|
+
|
|
213
|
+
### Authorization
|
|
214
|
+
|
|
215
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
216
|
+
|
|
217
|
+
### HTTP request headers
|
|
218
|
+
|
|
219
|
+
- **Content-Type**: Not defined
|
|
220
|
+
- **Accept**: application/json
|
|
221
|
+
|
|
222
|
+
|
|
170
223
|
### HTTP response details
|
|
171
224
|
| Status code | Description | Response headers |
|
|
172
225
|
|-------------|-------------|------------------|
|
|
@@ -569,6 +622,61 @@ const { status, data } = await apiInstance.getEvents(
|
|
|
569
622
|
- **Accept**: application/json
|
|
570
623
|
|
|
571
624
|
|
|
625
|
+
### HTTP response details
|
|
626
|
+
| Status code | Description | Response headers |
|
|
627
|
+
|-------------|-------------|------------------|
|
|
628
|
+
|**200** | Successful response | - |
|
|
629
|
+
|
|
630
|
+
[[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)
|
|
631
|
+
|
|
632
|
+
# **setEventLocation**
|
|
633
|
+
> CreateEvent200Response setEventLocation(eventLocationInputs)
|
|
634
|
+
|
|
635
|
+
Sets or updates the location details of an existing event, requiring the update events permission.
|
|
636
|
+
|
|
637
|
+
### Example
|
|
638
|
+
|
|
639
|
+
```typescript
|
|
640
|
+
import {
|
|
641
|
+
EventsApi,
|
|
642
|
+
Configuration,
|
|
643
|
+
EventLocationInputs
|
|
644
|
+
} from '@connectedxm/admin-sdk';
|
|
645
|
+
|
|
646
|
+
const configuration = new Configuration();
|
|
647
|
+
const apiInstance = new EventsApi(configuration);
|
|
648
|
+
|
|
649
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
650
|
+
let eventLocationInputs: EventLocationInputs; //
|
|
651
|
+
|
|
652
|
+
const { status, data } = await apiInstance.setEventLocation(
|
|
653
|
+
eventId,
|
|
654
|
+
eventLocationInputs
|
|
655
|
+
);
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
### Parameters
|
|
659
|
+
|
|
660
|
+
|Name | Type | Description | Notes|
|
|
661
|
+
|------------- | ------------- | ------------- | -------------|
|
|
662
|
+
| **eventLocationInputs** | **EventLocationInputs**| | |
|
|
663
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
### Return type
|
|
667
|
+
|
|
668
|
+
**CreateEvent200Response**
|
|
669
|
+
|
|
670
|
+
### Authorization
|
|
671
|
+
|
|
672
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
673
|
+
|
|
674
|
+
### HTTP request headers
|
|
675
|
+
|
|
676
|
+
- **Content-Type**: application/json
|
|
677
|
+
- **Accept**: application/json
|
|
678
|
+
|
|
679
|
+
|
|
572
680
|
### HTTP response details
|
|
573
681
|
| Status code | Description | Response headers |
|
|
574
682
|
|-------------|-------------|------------------|
|