@connectedxm/admin-sdk 7.8.0 → 7.9.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.
Files changed (35) hide show
  1. package/.openapi-generator/FILES +12 -1
  2. package/AdminApi.ts +3 -0
  3. package/README.md +17 -2
  4. package/api.ts +915 -106
  5. package/dist/AdminApi.d.ts +2 -1
  6. package/dist/AdminApi.js +1 -0
  7. package/dist/api.d.ts +520 -58
  8. package/dist/api.js +624 -107
  9. package/dist/esm/AdminApi.d.ts +2 -1
  10. package/dist/esm/AdminApi.js +2 -1
  11. package/dist/esm/api.d.ts +520 -58
  12. package/dist/esm/api.js +592 -79
  13. package/docs/AccountsApi.md +0 -55
  14. package/docs/AddEventPassTypeExchangeTarget200Response.md +24 -0
  15. package/docs/BaseEventPassTypeExchangeTarget.md +38 -0
  16. package/docs/BaseEventSessionLocation.md +2 -0
  17. package/docs/BasePassExchange.md +32 -0
  18. package/docs/Event.md +2 -0
  19. package/docs/EventCreateInputs.md +2 -0
  20. package/docs/EventPassTypeExchangeTarget.md +42 -0
  21. package/docs/EventSessionLocation.md +2 -0
  22. package/docs/EventSessionLocationCreateInputs.md +6 -0
  23. package/docs/EventSessionLocationUpdateInputs.md +6 -0
  24. package/docs/EventUpdateInputs.md +2 -0
  25. package/docs/EventsPasstypesExchangetargetsApi.md +393 -0
  26. package/docs/ExchangeType.md +12 -0
  27. package/docs/GetEventPassTypeExchangeTargetExchanges200Response.md +26 -0
  28. package/docs/GetEventPassTypeExchangeTargets200Response.md +26 -0
  29. package/docs/{ImpersonateAccount200Response.md → JoinMeeting200Response.md} +3 -3
  30. package/docs/MeetingsApi.md +2 -2
  31. package/docs/PassExchange.md +38 -0
  32. package/docs/PassTypeExchangeTargetCreateInputs.md +30 -0
  33. package/docs/PassTypeExchangeTargetUpdateInputs.md +28 -0
  34. package/docs/Payment.md +2 -0
  35. package/package.json +1 -1
@@ -21,7 +21,6 @@ All URIs are relative to *https://admin-api.connected.dev*
21
21
  |[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads | List an account\'s message threads|
22
22
  |[**getAccounts**](#getaccounts) | **GET** /accounts | List accounts in the organization|
23
23
  |[**getAccountsByInternalRefId**](#getaccountsbyinternalrefid) | **GET** /accounts/internal-ref-id/{internalRefId} | Find accounts by internal reference ID|
24
- |[**impersonateAccount**](#impersonateaccount) | **POST** /accounts/{accountId}/impersonate/{username} | Impersonate account|
25
24
  |[**syncAccount**](#syncaccount) | **POST** /accounts/{accountId}/sync | Sync a single account|
26
25
  |[**syncAccounts**](#syncaccounts) | **POST** /accounts/sync | Sync all accounts|
27
26
  |[**updateAccount**](#updateaccount) | **PUT** /accounts/{accountId} | Update an account|
@@ -1031,60 +1030,6 @@ const { status, data } = await apiInstance.getAccountsByInternalRefId(
1031
1030
  - **Accept**: application/json
1032
1031
 
1033
1032
 
1034
- ### HTTP response details
1035
- | Status code | Description | Response headers |
1036
- |-------------|-------------|------------------|
1037
- |**200** | Successful response | - |
1038
-
1039
- [[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)
1040
-
1041
- # **impersonateAccount**
1042
- > ImpersonateAccount200Response impersonateAccount()
1043
-
1044
- Starts an admin impersonation session for the specified account, returning a token that lets an admin act as the given user identified by account ID and username.
1045
-
1046
- ### Example
1047
-
1048
- ```typescript
1049
- import {
1050
- AccountsApi,
1051
- Configuration
1052
- } from '@connectedxm/admin-sdk';
1053
-
1054
- const configuration = new Configuration();
1055
- const apiInstance = new AccountsApi(configuration);
1056
-
1057
- let accountId: string; //The account identifier (default to undefined)
1058
- let username: string; //The username identifier (default to undefined)
1059
-
1060
- const { status, data } = await apiInstance.impersonateAccount(
1061
- accountId,
1062
- username
1063
- );
1064
- ```
1065
-
1066
- ### Parameters
1067
-
1068
- |Name | Type | Description | Notes|
1069
- |------------- | ------------- | ------------- | -------------|
1070
- | **accountId** | [**string**] | The account identifier | defaults to undefined|
1071
- | **username** | [**string**] | The username identifier | defaults to undefined|
1072
-
1073
-
1074
- ### Return type
1075
-
1076
- **ImpersonateAccount200Response**
1077
-
1078
- ### Authorization
1079
-
1080
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
1081
-
1082
- ### HTTP request headers
1083
-
1084
- - **Content-Type**: Not defined
1085
- - **Accept**: application/json
1086
-
1087
-
1088
1033
  ### HTTP response details
1089
1034
  | Status code | Description | Response headers |
1090
1035
  |-------------|-------------|------------------|
@@ -0,0 +1,24 @@
1
+ # AddEventPassTypeExchangeTarget200Response
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** | [**EventPassTypeExchangeTarget**](EventPassTypeExchangeTarget.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AddEventPassTypeExchangeTarget200Response } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: AddEventPassTypeExchangeTarget200Response = {
18
+ status,
19
+ message,
20
+ data,
21
+ };
22
+ ```
23
+
24
+ [[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,38 @@
1
+ # BaseEventPassTypeExchangeTarget
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **enabled** | **boolean** | | [default to undefined]
10
+ **sourcePassTypeId** | **string** | | [default to undefined]
11
+ **sourcePassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
12
+ **targetPassTypeId** | **string** | | [default to undefined]
13
+ **targetPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
14
+ **fixedPricing** | **boolean** | | [default to undefined]
15
+ **amount** | **number** | | [default to undefined]
16
+ **startDate** | **string** | | [default to undefined]
17
+ **endDate** | **string** | | [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { BaseEventPassTypeExchangeTarget } from '@connectedxm/admin-sdk';
23
+
24
+ const instance: BaseEventPassTypeExchangeTarget = {
25
+ id,
26
+ enabled,
27
+ sourcePassTypeId,
28
+ sourcePassType,
29
+ targetPassTypeId,
30
+ targetPassType,
31
+ fixedPricing,
32
+ amount,
33
+ startDate,
34
+ endDate,
35
+ };
36
+ ```
37
+
38
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -7,6 +7,7 @@ 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]
@@ -24,6 +25,7 @@ import { BaseEventSessionLocation } from '@connectedxm/admin-sdk';
24
25
  const instance: BaseEventSessionLocation = {
25
26
  id,
26
27
  name,
28
+ room,
27
29
  address1,
28
30
  address2,
29
31
  zip,
@@ -0,0 +1,32 @@
1
+ # BasePassExchange
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **accountId** | **string** | | [default to undefined]
10
+ **passId** | **string** | | [default to undefined]
11
+ **exchangeType** | [**ExchangeType**](ExchangeType.md) | | [default to undefined]
12
+ **exchangeTargetId** | **string** | | [default to undefined]
13
+ **exchangeTarget** | [**EventPassTypeExchangeTarget**](EventPassTypeExchangeTarget.md) | | [default to undefined]
14
+ **lineItem** | [**BasePaymentLineItem**](BasePaymentLineItem.md) | | [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { BasePassExchange } from '@connectedxm/admin-sdk';
20
+
21
+ const instance: BasePassExchange = {
22
+ id,
23
+ accountId,
24
+ passId,
25
+ exchangeType,
26
+ exchangeTargetId,
27
+ exchangeTarget,
28
+ lineItem,
29
+ };
30
+ ```
31
+
32
+ [[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/Event.md CHANGED
@@ -73,6 +73,7 @@ Name | Type | Description | Notes
73
73
  **groupId** | **string** | | [default to undefined]
74
74
  **group** | [**BaseGroup**](BaseGroup.md) | | [default to undefined]
75
75
  **groupOnly** | **boolean** | | [default to undefined]
76
+ **guestRegistration** | **boolean** | | [default to undefined]
76
77
  **backgroundImageId** | **string** | | [default to undefined]
77
78
  **backgroundImage** | [**BaseImage**](BaseImage.md) | | [default to undefined]
78
79
  **registrationHeaderImageId** | **string** | | [default to undefined]
@@ -164,6 +165,7 @@ const instance: Event = {
164
165
  groupId,
165
166
  group,
166
167
  groupOnly,
168
+ guestRegistration,
167
169
  backgroundImageId,
168
170
  backgroundImage,
169
171
  registrationHeaderImageId,
@@ -47,6 +47,7 @@ Name | Type | Description | Notes
47
47
  **streamReplayId** | **string** | | [optional] [default to undefined]
48
48
  **groupId** | **string** | | [optional] [default to undefined]
49
49
  **groupOnly** | **boolean** | | [optional] [default to undefined]
50
+ **guestRegistration** | **boolean** | | [optional] [default to undefined]
50
51
  **passSupply** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
51
52
  **passLimitPerAccount** | [**EventCreateInputsPassLimitPerAccount**](EventCreateInputsPassLimitPerAccount.md) | | [optional] [default to undefined]
52
53
  **roundName** | **string** | | [optional] [default to undefined]
@@ -109,6 +110,7 @@ const instance: EventCreateInputs = {
109
110
  streamReplayId,
110
111
  groupId,
111
112
  groupOnly,
113
+ guestRegistration,
112
114
  passSupply,
113
115
  passLimitPerAccount,
114
116
  roundName,
@@ -0,0 +1,42 @@
1
+ # EventPassTypeExchangeTarget
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **enabled** | **boolean** | | [default to undefined]
10
+ **sourcePassTypeId** | **string** | | [default to undefined]
11
+ **sourcePassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
12
+ **targetPassTypeId** | **string** | | [default to undefined]
13
+ **targetPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
14
+ **fixedPricing** | **boolean** | | [default to undefined]
15
+ **amount** | **number** | | [default to undefined]
16
+ **startDate** | **string** | | [default to undefined]
17
+ **endDate** | **string** | | [default to undefined]
18
+ **createdAt** | **string** | | [default to undefined]
19
+ **updatedAt** | **string** | | [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { EventPassTypeExchangeTarget } from '@connectedxm/admin-sdk';
25
+
26
+ const instance: EventPassTypeExchangeTarget = {
27
+ id,
28
+ enabled,
29
+ sourcePassTypeId,
30
+ sourcePassType,
31
+ targetPassTypeId,
32
+ targetPassType,
33
+ fixedPricing,
34
+ amount,
35
+ startDate,
36
+ endDate,
37
+ createdAt,
38
+ updatedAt,
39
+ };
40
+ ```
41
+
42
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -7,6 +7,7 @@ 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]
@@ -29,6 +30,7 @@ import { EventSessionLocation } from '@connectedxm/admin-sdk';
29
30
  const instance: EventSessionLocation = {
30
31
  id,
31
32
  name,
33
+ room,
32
34
  address1,
33
35
  address2,
34
36
  zip,
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **location** | **string** | | [optional] [default to undefined]
9
9
  **name** | **string** | | [default to undefined]
10
+ **room** | **string** | | [optional] [default to undefined]
10
11
  **description** | **string** | | [optional] [default to undefined]
11
12
  **imageId** | **string** | | [optional] [default to undefined]
12
13
  **address1** | **string** | | [optional] [default to undefined]
@@ -15,6 +16,8 @@ Name | Type | Description | Notes
15
16
  **state** | **string** | | [optional] [default to undefined]
16
17
  **country** | **string** | | [optional] [default to undefined]
17
18
  **zip** | **string** | | [optional] [default to undefined]
19
+ **latitude** | **number** | | [optional] [default to undefined]
20
+ **longitude** | **number** | | [optional] [default to undefined]
18
21
 
19
22
  ## Example
20
23
 
@@ -24,6 +27,7 @@ import { EventSessionLocationCreateInputs } from '@connectedxm/admin-sdk';
24
27
  const instance: EventSessionLocationCreateInputs = {
25
28
  location,
26
29
  name,
30
+ room,
27
31
  description,
28
32
  imageId,
29
33
  address1,
@@ -32,6 +36,8 @@ const instance: EventSessionLocationCreateInputs = {
32
36
  state,
33
37
  country,
34
38
  zip,
39
+ latitude,
40
+ longitude,
35
41
  };
36
42
  ```
37
43
 
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **location** | **string** | | [optional] [default to undefined]
9
9
  **name** | **string** | | [optional] [default to undefined]
10
+ **room** | **string** | | [optional] [default to undefined]
10
11
  **description** | **string** | | [optional] [default to undefined]
11
12
  **imageId** | **string** | | [optional] [default to undefined]
12
13
  **address1** | **string** | | [optional] [default to undefined]
@@ -15,6 +16,8 @@ Name | Type | Description | Notes
15
16
  **state** | **string** | | [optional] [default to undefined]
16
17
  **country** | **string** | | [optional] [default to undefined]
17
18
  **zip** | **string** | | [optional] [default to undefined]
19
+ **latitude** | **number** | | [optional] [default to undefined]
20
+ **longitude** | **number** | | [optional] [default to undefined]
18
21
 
19
22
  ## Example
20
23
 
@@ -24,6 +27,7 @@ import { EventSessionLocationUpdateInputs } from '@connectedxm/admin-sdk';
24
27
  const instance: EventSessionLocationUpdateInputs = {
25
28
  location,
26
29
  name,
30
+ room,
27
31
  description,
28
32
  imageId,
29
33
  address1,
@@ -32,6 +36,8 @@ const instance: EventSessionLocationUpdateInputs = {
32
36
  state,
33
37
  country,
34
38
  zip,
39
+ latitude,
40
+ longitude,
35
41
  };
36
42
  ```
37
43
 
@@ -48,6 +48,7 @@ Name | Type | Description | Notes
48
48
  **streamReplayId** | **string** | | [optional] [default to undefined]
49
49
  **groupId** | **string** | | [optional] [default to undefined]
50
50
  **groupOnly** | **boolean** | | [optional] [default to undefined]
51
+ **guestRegistration** | **boolean** | | [optional] [default to undefined]
51
52
  **passSupply** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
52
53
  **passLimitPerAccount** | [**EventCreateInputsPassLimitPerAccount**](EventCreateInputsPassLimitPerAccount.md) | | [optional] [default to undefined]
53
54
  **roundName** | **string** | | [optional] [default to undefined]
@@ -110,6 +111,7 @@ const instance: EventUpdateInputs = {
110
111
  streamReplayId,
111
112
  groupId,
112
113
  groupOnly,
114
+ guestRegistration,
113
115
  passSupply,
114
116
  passLimitPerAccount,
115
117
  roundName,