@connectedxm/admin-sdk 8.1.2 → 8.1.4
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 +30 -1
- package/README.md +8 -2559
- package/api.ts +1384 -2111
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +643 -959
- package/dist/api.js +1182 -1491
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +643 -959
- package/dist/esm/api.js +1167 -1476
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/ActivitiesApi.md +6 -12
- package/docs/AddChannelSubscriberRequest.md +20 -0
- package/docs/AddCustomReportUserRequest.md +20 -0
- package/docs/{ImportCreateInputsValuesInner.md → AddEventAccessUserRequest.md} +3 -3
- package/docs/AddEventAddOnTierRequest.md +20 -0
- package/docs/AddRoomToRoomTypeRequest.md +20 -0
- package/docs/ApproveEventPassRequest.md +20 -0
- package/docs/BenefitsApi.md +5 -5
- package/docs/BookingsAvailabilitiesApi.md +5 -5
- package/docs/BookingsBlackoutsApi.md +5 -5
- package/docs/BookingsPlacesApi.md +5 -5
- package/docs/BookingsQuestionsApi.md +7 -6
- package/docs/BookingsQuestionsChoicesApi.md +7 -6
- package/docs/BookingsSpacesApi.md +5 -5
- package/docs/BulkUploadSearchListValuesRequest.md +20 -0
- package/docs/ChannelsApi.md +22 -21
- package/docs/CreateActivityRequest.md +24 -0
- package/docs/CreateEventSessionPriceRequest.md +22 -0
- package/docs/CreateGroupInvitationsRequest.md +22 -0
- package/docs/CreateOrganizationSideEffectRequest.md +26 -0
- package/docs/CreateThreadMessageReactionRequest.md +22 -0
- package/docs/DenyEventPassRequest.md +22 -0
- package/docs/EventsAccessApi.md +7 -6
- package/docs/EventsAddonsApi.md +12 -11
- package/docs/EventsBypassApi.md +5 -5
- package/docs/EventsCouponsApi.md +7 -6
- package/docs/EventsFaqsApi.md +17 -16
- package/docs/EventsFollowupsApi.md +26 -23
- package/docs/EventsMatchesApi.md +7 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +5 -5
- package/docs/EventsPagesApi.md +5 -5
- package/docs/EventsPassesApi.md +25 -24
- package/docs/EventsPassesFollowupsApi.md +14 -12
- package/docs/EventsPasstypesApi.md +12 -11
- package/docs/EventsQuestionsApi.md +31 -28
- package/docs/EventsRegistrationsPackagesApi.md +10 -10
- package/docs/EventsRoomsApi.md +14 -15
- package/docs/EventsRoomtypesApi.md +12 -11
- package/docs/EventsSectionsApi.md +26 -23
- package/docs/EventsSessionsApi.md +5 -5
- package/docs/EventsSessionsLocationsApi.md +5 -5
- package/docs/EventsSessionsMatchesApi.md +7 -6
- package/docs/EventsSessionsPricesApi.md +13 -17
- package/docs/EventsSessionsQuestionsApi.md +31 -28
- package/docs/EventsSessionsSectionsApi.md +19 -17
- package/docs/EventsSpeakersApi.md +5 -5
- package/docs/EventsSponsorshiplevelsApi.md +12 -11
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +5 -5
- package/docs/EventsSponsorshipsApi.md +12 -11
- package/docs/EventsSponsorshipsTranslationsApi.md +5 -5
- package/docs/GroupsInvitationsApi.md +7 -9
- package/docs/ImportCreateInputs.md +1 -1
- package/docs/ImportRoomsRequest.md +22 -0
- package/docs/InterestsApi.md +5 -5
- package/docs/InvoicesApi.md +5 -5
- package/docs/InvoicesLineitemsApi.md +5 -5
- package/docs/LoginsApi.md +14 -12
- package/docs/MarkNotificationsReadRequest.md +20 -0
- package/docs/NotificationsApi.md +7 -6
- package/docs/OrganizationApi.md +14 -21
- package/docs/OrganizationDomainsApi.md +7 -6
- package/docs/OrganizationSideeffectsApi.md +7 -15
- package/docs/OrganizationTeammembersApi.md +5 -5
- package/docs/OrganizationUsersApi.md +7 -6
- package/docs/ReorderBookingSpaceQuestionChoicesRequest.md +20 -0
- package/docs/ReorderBookingSpaceQuestionsRequest.md +20 -0
- package/docs/ReorderEventFaqSectionQuestionsRequest.md +20 -0
- package/docs/ReorderEventSponsorshipLevelsRequest.md +20 -0
- package/docs/ReorderEventSponsorshipsRequest.md +20 -0
- package/docs/ReportsApi.md +5 -5
- package/docs/ReportsUsersApi.md +7 -6
- package/docs/SearchlistsValuesApi.md +7 -6
- package/docs/SeriesApi.md +5 -5
- package/docs/SeriesQuestionsApi.md +5 -5
- package/docs/SeriesQuestionsChoicesApi.md +12 -11
- package/docs/SponsorsApi.md +5 -5
- package/docs/StartEventRoundMatchmakingRequest.md +20 -0
- package/docs/StorageFilesApi.md +7 -12
- package/docs/StorageVideosCaptionsApi.md +7 -9
- package/docs/StreamsApi.md +5 -5
- package/docs/StreamsOutputsApi.md +5 -5
- package/docs/SurveysQuestionsApi.md +31 -28
- package/docs/SurveysSectionsApi.md +19 -17
- package/docs/ThreadsMessagesReactionsApi.md +6 -9
- package/docs/UpdateEventFollowupQuestionRequest.md +20 -0
- package/docs/UpdateEventPassFollowupResponsesRequest.md +20 -0
- package/docs/UpdateEventSessionPriceRequest.md +22 -0
- package/docs/UpdateLoginPasswordRequest.md +20 -0
- package/docs/UpdateOrganizationDomainRequest.md +20 -0
- package/docs/UpdateOrganizationIntegrationsRequest.md +26 -0
- package/docs/UploadFileRequest.md +24 -0
- package/docs/UploadVideoCaptionsRequest.md +22 -0
- package/docs/UpsertLinkPreviewRequest.md +20 -0
- package/package.json +1 -1
|
@@ -190,7 +190,7 @@ const { status, data } = await apiInstance.getEventSponsorshipLevelTranslations(
|
|
|
190
190
|
[[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)
|
|
191
191
|
|
|
192
192
|
# **updateEventSponsorshipLevelTranslation**
|
|
193
|
-
> GetEventSponsorshipLevelTranslation200Response updateEventSponsorshipLevelTranslation()
|
|
193
|
+
> GetEventSponsorshipLevelTranslation200Response updateEventSponsorshipLevelTranslation(eventSponsorshipLevelTranslationUpdateInputs)
|
|
194
194
|
|
|
195
195
|
Updates the translated fields (e.g. name, description) for a specific locale of an event sponsorship level, creating or overwriting that locale\'s translation; requires update permission on events.
|
|
196
196
|
|
|
@@ -209,13 +209,13 @@ const apiInstance = new EventsSponsorshiplevelsTranslationsApi(configuration);
|
|
|
209
209
|
let eventId: string; //The event identifier (default to undefined)
|
|
210
210
|
let levelId: string; //The level identifier (default to undefined)
|
|
211
211
|
let locale: string; //The locale identifier (default to undefined)
|
|
212
|
-
let
|
|
212
|
+
let eventSponsorshipLevelTranslationUpdateInputs: EventSponsorshipLevelTranslationUpdateInputs; //
|
|
213
213
|
|
|
214
214
|
const { status, data } = await apiInstance.updateEventSponsorshipLevelTranslation(
|
|
215
215
|
eventId,
|
|
216
216
|
levelId,
|
|
217
217
|
locale,
|
|
218
|
-
|
|
218
|
+
eventSponsorshipLevelTranslationUpdateInputs
|
|
219
219
|
);
|
|
220
220
|
```
|
|
221
221
|
|
|
@@ -223,10 +223,10 @@ const { status, data } = await apiInstance.updateEventSponsorshipLevelTranslatio
|
|
|
223
223
|
|
|
224
224
|
|Name | Type | Description | Notes|
|
|
225
225
|
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **eventSponsorshipLevelTranslationUpdateInputs** | **EventSponsorshipLevelTranslationUpdateInputs**| | |
|
|
226
227
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
227
228
|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
|
|
228
229
|
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
229
|
-
| **translation** | **EventSponsorshipLevelTranslationUpdateInputs** | Filter by translation | defaults to undefined|
|
|
230
230
|
|
|
231
231
|
|
|
232
232
|
### Return type
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.updateEventSponsorshipLevelTranslatio
|
|
|
239
239
|
|
|
240
240
|
### HTTP request headers
|
|
241
241
|
|
|
242
|
-
- **Content-Type**:
|
|
242
|
+
- **Content-Type**: application/json
|
|
243
243
|
- **Accept**: application/json
|
|
244
244
|
|
|
245
245
|
|
|
@@ -250,7 +250,7 @@ const { status, data } = await apiInstance.getEventSponsorships(
|
|
|
250
250
|
[[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)
|
|
251
251
|
|
|
252
252
|
# **reorderEventSponsorships**
|
|
253
|
-
> ReorderEventSponsorships200Response reorderEventSponsorships()
|
|
253
|
+
> ReorderEventSponsorships200Response reorderEventSponsorships(reorderEventSponsorshipsRequest)
|
|
254
254
|
|
|
255
255
|
Sets the display order of the sponsorships within an event sponsorship level by supplying the full ordered list of sponsorship IDs; requires update permission on events.
|
|
256
256
|
|
|
@@ -259,7 +259,8 @@ Sets the display order of the sponsorships within an event sponsorship level by
|
|
|
259
259
|
```typescript
|
|
260
260
|
import {
|
|
261
261
|
EventsSponsorshipsApi,
|
|
262
|
-
Configuration
|
|
262
|
+
Configuration,
|
|
263
|
+
ReorderEventSponsorshipsRequest
|
|
263
264
|
} from '@connectedxm/admin-sdk';
|
|
264
265
|
|
|
265
266
|
const configuration = new Configuration();
|
|
@@ -267,12 +268,12 @@ const apiInstance = new EventsSponsorshipsApi(configuration);
|
|
|
267
268
|
|
|
268
269
|
let eventId: string; //The event identifier (default to undefined)
|
|
269
270
|
let levelId: string; //The level identifier (default to undefined)
|
|
270
|
-
let
|
|
271
|
+
let reorderEventSponsorshipsRequest: ReorderEventSponsorshipsRequest; //
|
|
271
272
|
|
|
272
273
|
const { status, data } = await apiInstance.reorderEventSponsorships(
|
|
273
274
|
eventId,
|
|
274
275
|
levelId,
|
|
275
|
-
|
|
276
|
+
reorderEventSponsorshipsRequest
|
|
276
277
|
);
|
|
277
278
|
```
|
|
278
279
|
|
|
@@ -280,9 +281,9 @@ const { status, data } = await apiInstance.reorderEventSponsorships(
|
|
|
280
281
|
|
|
281
282
|
|Name | Type | Description | Notes|
|
|
282
283
|
|------------- | ------------- | ------------- | -------------|
|
|
284
|
+
| **reorderEventSponsorshipsRequest** | **ReorderEventSponsorshipsRequest**| | |
|
|
283
285
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
284
286
|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
|
|
285
|
-
| **sponsorshipIds** | **Array<string>** | Filter by sponsorshipIds | defaults to undefined|
|
|
286
287
|
|
|
287
288
|
|
|
288
289
|
### Return type
|
|
@@ -295,7 +296,7 @@ const { status, data } = await apiInstance.reorderEventSponsorships(
|
|
|
295
296
|
|
|
296
297
|
### HTTP request headers
|
|
297
298
|
|
|
298
|
-
- **Content-Type**:
|
|
299
|
+
- **Content-Type**: application/json
|
|
299
300
|
- **Accept**: application/json
|
|
300
301
|
|
|
301
302
|
|
|
@@ -307,7 +308,7 @@ const { status, data } = await apiInstance.reorderEventSponsorships(
|
|
|
307
308
|
[[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)
|
|
308
309
|
|
|
309
310
|
# **updateEventSponsorship**
|
|
310
|
-
> CreateEventSponsorship200Response updateEventSponsorship()
|
|
311
|
+
> CreateEventSponsorship200Response updateEventSponsorship(eventSponsorshipUpdateInputs)
|
|
311
312
|
|
|
312
313
|
Updates the details of a sponsorship record at a given sponsorship level for an event, such as its name, description, or links, and requires update permission on events.
|
|
313
314
|
|
|
@@ -326,13 +327,13 @@ const apiInstance = new EventsSponsorshipsApi(configuration);
|
|
|
326
327
|
let eventId: string; //The event identifier (default to undefined)
|
|
327
328
|
let levelId: string; //The level identifier (default to undefined)
|
|
328
329
|
let sponsorshipId: string; //The sponsorship identifier (default to undefined)
|
|
329
|
-
let
|
|
330
|
+
let eventSponsorshipUpdateInputs: EventSponsorshipUpdateInputs; //
|
|
330
331
|
|
|
331
332
|
const { status, data } = await apiInstance.updateEventSponsorship(
|
|
332
333
|
eventId,
|
|
333
334
|
levelId,
|
|
334
335
|
sponsorshipId,
|
|
335
|
-
|
|
336
|
+
eventSponsorshipUpdateInputs
|
|
336
337
|
);
|
|
337
338
|
```
|
|
338
339
|
|
|
@@ -340,10 +341,10 @@ const { status, data } = await apiInstance.updateEventSponsorship(
|
|
|
340
341
|
|
|
341
342
|
|Name | Type | Description | Notes|
|
|
342
343
|
|------------- | ------------- | ------------- | -------------|
|
|
344
|
+
| **eventSponsorshipUpdateInputs** | **EventSponsorshipUpdateInputs**| | |
|
|
343
345
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
344
346
|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
|
|
345
347
|
| **sponsorshipId** | [**string**] | The sponsorship identifier | defaults to undefined|
|
|
346
|
-
| **sponsorship** | **EventSponsorshipUpdateInputs** | Filter by sponsorship | defaults to undefined|
|
|
347
348
|
|
|
348
349
|
|
|
349
350
|
### Return type
|
|
@@ -356,7 +357,7 @@ const { status, data } = await apiInstance.updateEventSponsorship(
|
|
|
356
357
|
|
|
357
358
|
### HTTP request headers
|
|
358
359
|
|
|
359
|
-
- **Content-Type**:
|
|
360
|
+
- **Content-Type**: application/json
|
|
360
361
|
- **Accept**: application/json
|
|
361
362
|
|
|
362
363
|
|
|
@@ -199,7 +199,7 @@ const { status, data } = await apiInstance.getEventSponsorshipTranslations(
|
|
|
199
199
|
[[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)
|
|
200
200
|
|
|
201
201
|
# **updateEventSponsorshipTranslation**
|
|
202
|
-
> GetEventSponsorshipTranslation200Response updateEventSponsorshipTranslation()
|
|
202
|
+
> GetEventSponsorshipTranslation200Response updateEventSponsorshipTranslation(eventSponsorshipTranslationUpdateInputs)
|
|
203
203
|
|
|
204
204
|
Updates the translated fields (e.g. name, description) for a specific locale of a sponsorship within an event sponsorship level, creating or overwriting that locale\'s translation; requires update permission on events.
|
|
205
205
|
|
|
@@ -219,14 +219,14 @@ let eventId: string; //The event identifier (default to undefined)
|
|
|
219
219
|
let levelId: string; //The level identifier (default to undefined)
|
|
220
220
|
let sponsorshipId: string; //The sponsorship identifier (default to undefined)
|
|
221
221
|
let locale: string; //The locale identifier (default to undefined)
|
|
222
|
-
let
|
|
222
|
+
let eventSponsorshipTranslationUpdateInputs: EventSponsorshipTranslationUpdateInputs; //
|
|
223
223
|
|
|
224
224
|
const { status, data } = await apiInstance.updateEventSponsorshipTranslation(
|
|
225
225
|
eventId,
|
|
226
226
|
levelId,
|
|
227
227
|
sponsorshipId,
|
|
228
228
|
locale,
|
|
229
|
-
|
|
229
|
+
eventSponsorshipTranslationUpdateInputs
|
|
230
230
|
);
|
|
231
231
|
```
|
|
232
232
|
|
|
@@ -234,11 +234,11 @@ const { status, data } = await apiInstance.updateEventSponsorshipTranslation(
|
|
|
234
234
|
|
|
235
235
|
|Name | Type | Description | Notes|
|
|
236
236
|
|------------- | ------------- | ------------- | -------------|
|
|
237
|
+
| **eventSponsorshipTranslationUpdateInputs** | **EventSponsorshipTranslationUpdateInputs**| | |
|
|
237
238
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
238
239
|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
|
|
239
240
|
| **sponsorshipId** | [**string**] | The sponsorship identifier | defaults to undefined|
|
|
240
241
|
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
241
|
-
| **translation** | **EventSponsorshipTranslationUpdateInputs** | Filter by translation | defaults to undefined|
|
|
242
242
|
|
|
243
243
|
|
|
244
244
|
### Return type
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.updateEventSponsorshipTranslation(
|
|
|
251
251
|
|
|
252
252
|
### HTTP request headers
|
|
253
253
|
|
|
254
|
-
- **Content-Type**:
|
|
254
|
+
- **Content-Type**: application/json
|
|
255
255
|
- **Accept**: application/json
|
|
256
256
|
|
|
257
257
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.cancelGroupInvitation(
|
|
|
66
66
|
[[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)
|
|
67
67
|
|
|
68
68
|
# **createGroupInvitations**
|
|
69
|
-
> CreateGroupInvitations200Response createGroupInvitations()
|
|
69
|
+
> CreateGroupInvitations200Response createGroupInvitations(createGroupInvitationsRequest)
|
|
70
70
|
|
|
71
71
|
Creates up to 10 pending invitations for the given account IDs to join a group on behalf of a moderator account, requiring update permission on groups; the group\'s invitations list is invalidated.
|
|
72
72
|
|
|
@@ -75,20 +75,19 @@ Creates up to 10 pending invitations for the given account IDs to join a group o
|
|
|
75
75
|
```typescript
|
|
76
76
|
import {
|
|
77
77
|
GroupsInvitationsApi,
|
|
78
|
-
Configuration
|
|
78
|
+
Configuration,
|
|
79
|
+
CreateGroupInvitationsRequest
|
|
79
80
|
} from '@connectedxm/admin-sdk';
|
|
80
81
|
|
|
81
82
|
const configuration = new Configuration();
|
|
82
83
|
const apiInstance = new GroupsInvitationsApi(configuration);
|
|
83
84
|
|
|
84
85
|
let groupId: string; //The group identifier (default to undefined)
|
|
85
|
-
let
|
|
86
|
-
let accountIds: Array<string>; //Filter by accountIds (default to undefined)
|
|
86
|
+
let createGroupInvitationsRequest: CreateGroupInvitationsRequest; //
|
|
87
87
|
|
|
88
88
|
const { status, data } = await apiInstance.createGroupInvitations(
|
|
89
89
|
groupId,
|
|
90
|
-
|
|
91
|
-
accountIds
|
|
90
|
+
createGroupInvitationsRequest
|
|
92
91
|
);
|
|
93
92
|
```
|
|
94
93
|
|
|
@@ -96,9 +95,8 @@ const { status, data } = await apiInstance.createGroupInvitations(
|
|
|
96
95
|
|
|
97
96
|
|Name | Type | Description | Notes|
|
|
98
97
|
|------------- | ------------- | ------------- | -------------|
|
|
98
|
+
| **createGroupInvitationsRequest** | **CreateGroupInvitationsRequest**| | |
|
|
99
99
|
| **groupId** | [**string**] | The group identifier | defaults to undefined|
|
|
100
|
-
| **moderatorId** | [**string**] | Filter by moderatorId | defaults to undefined|
|
|
101
|
-
| **accountIds** | **Array<string>** | Filter by accountIds | defaults to undefined|
|
|
102
100
|
|
|
103
101
|
|
|
104
102
|
### Return type
|
|
@@ -111,7 +109,7 @@ const { status, data } = await apiInstance.createGroupInvitations(
|
|
|
111
109
|
|
|
112
110
|
### HTTP request headers
|
|
113
111
|
|
|
114
|
-
- **Content-Type**:
|
|
112
|
+
- **Content-Type**: application/json
|
|
115
113
|
- **Accept**: application/json
|
|
116
114
|
|
|
117
115
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**values** | [**Array<
|
|
8
|
+
**values** | [**Array<AddEventAccessUserRequest>**](AddEventAccessUserRequest.md) | | [optional] [default to undefined]
|
|
9
9
|
**type** | [**ImportType**](ImportType.md) | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ImportRoomsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**roomNames** | **Array<string>** | | [default to undefined]
|
|
9
|
+
**roomTypeId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ImportRoomsRequest } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: ImportRoomsRequest = {
|
|
17
|
+
roomNames,
|
|
18
|
+
roomTypeId,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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/InterestsApi.md
CHANGED
|
@@ -612,7 +612,7 @@ const { status, data } = await apiInstance.getInterests(
|
|
|
612
612
|
[[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)
|
|
613
613
|
|
|
614
614
|
# **updateInterest**
|
|
615
|
-
> CreateInterest200Response updateInterest()
|
|
615
|
+
> CreateInterest200Response updateInterest(interestUpdateInputs)
|
|
616
616
|
|
|
617
617
|
Updates the details of an existing interest identified by interestId and requires the \"update\" permission on interests.
|
|
618
618
|
|
|
@@ -629,11 +629,11 @@ const configuration = new Configuration();
|
|
|
629
629
|
const apiInstance = new InterestsApi(configuration);
|
|
630
630
|
|
|
631
631
|
let interestId: string; //The interest identifier (default to undefined)
|
|
632
|
-
let
|
|
632
|
+
let interestUpdateInputs: InterestUpdateInputs; //
|
|
633
633
|
|
|
634
634
|
const { status, data } = await apiInstance.updateInterest(
|
|
635
635
|
interestId,
|
|
636
|
-
|
|
636
|
+
interestUpdateInputs
|
|
637
637
|
);
|
|
638
638
|
```
|
|
639
639
|
|
|
@@ -641,8 +641,8 @@ const { status, data } = await apiInstance.updateInterest(
|
|
|
641
641
|
|
|
642
642
|
|Name | Type | Description | Notes|
|
|
643
643
|
|------------- | ------------- | ------------- | -------------|
|
|
644
|
+
| **interestUpdateInputs** | **InterestUpdateInputs**| | |
|
|
644
645
|
| **interestId** | [**string**] | The interest identifier | defaults to undefined|
|
|
645
|
-
| **interest** | **InterestUpdateInputs** | Filter by interest | defaults to undefined|
|
|
646
646
|
|
|
647
647
|
|
|
648
648
|
### Return type
|
|
@@ -655,7 +655,7 @@ const { status, data } = await apiInstance.updateInterest(
|
|
|
655
655
|
|
|
656
656
|
### HTTP request headers
|
|
657
657
|
|
|
658
|
-
- **Content-Type**:
|
|
658
|
+
- **Content-Type**: application/json
|
|
659
659
|
- **Accept**: application/json
|
|
660
660
|
|
|
661
661
|
|
package/docs/InvoicesApi.md
CHANGED
|
@@ -470,7 +470,7 @@ const { status, data } = await apiInstance.sendInvoice(
|
|
|
470
470
|
[[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)
|
|
471
471
|
|
|
472
472
|
# **updateInvoice**
|
|
473
|
-
> CreateInvoice200Response updateInvoice()
|
|
473
|
+
> CreateInvoice200Response updateInvoice(invoiceUpdateInputs)
|
|
474
474
|
|
|
475
475
|
Updates the fields of an existing, unpaid invoice such as its account, event, payment integration, or status, and requires the \"update\" permission on invoices.
|
|
476
476
|
|
|
@@ -487,11 +487,11 @@ const configuration = new Configuration();
|
|
|
487
487
|
const apiInstance = new InvoicesApi(configuration);
|
|
488
488
|
|
|
489
489
|
let invoiceId: string; //The invoice identifier (default to undefined)
|
|
490
|
-
let
|
|
490
|
+
let invoiceUpdateInputs: InvoiceUpdateInputs; //
|
|
491
491
|
|
|
492
492
|
const { status, data } = await apiInstance.updateInvoice(
|
|
493
493
|
invoiceId,
|
|
494
|
-
|
|
494
|
+
invoiceUpdateInputs
|
|
495
495
|
);
|
|
496
496
|
```
|
|
497
497
|
|
|
@@ -499,8 +499,8 @@ const { status, data } = await apiInstance.updateInvoice(
|
|
|
499
499
|
|
|
500
500
|
|Name | Type | Description | Notes|
|
|
501
501
|
|------------- | ------------- | ------------- | -------------|
|
|
502
|
+
| **invoiceUpdateInputs** | **InvoiceUpdateInputs**| | |
|
|
502
503
|
| **invoiceId** | [**string**] | The invoice identifier | defaults to undefined|
|
|
503
|
-
| **invoice** | **InvoiceUpdateInputs** | Filter by invoice | defaults to undefined|
|
|
504
504
|
|
|
505
505
|
|
|
506
506
|
### Return type
|
|
@@ -513,7 +513,7 @@ const { status, data } = await apiInstance.updateInvoice(
|
|
|
513
513
|
|
|
514
514
|
### HTTP request headers
|
|
515
515
|
|
|
516
|
-
- **Content-Type**:
|
|
516
|
+
- **Content-Type**: application/json
|
|
517
517
|
- **Accept**: application/json
|
|
518
518
|
|
|
519
519
|
|
|
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteInvoiceLineItem(
|
|
|
118
118
|
[[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)
|
|
119
119
|
|
|
120
120
|
# **updateInvoiceLineItem**
|
|
121
|
-
> CreateInvoiceLineItem200Response updateInvoiceLineItem()
|
|
121
|
+
> CreateInvoiceLineItem200Response updateInvoiceLineItem(invoiceLineItemUpdateInputs)
|
|
122
122
|
|
|
123
123
|
Updates the fields of an existing line item on the specified invoice, which must currently be in \"draft\" status, and requires the \"update\" permission on invoices.
|
|
124
124
|
|
|
@@ -136,12 +136,12 @@ const apiInstance = new InvoicesLineitemsApi(configuration);
|
|
|
136
136
|
|
|
137
137
|
let invoiceId: string; //The invoice identifier (default to undefined)
|
|
138
138
|
let lineItemId: string; //The lineItem identifier (default to undefined)
|
|
139
|
-
let
|
|
139
|
+
let invoiceLineItemUpdateInputs: InvoiceLineItemUpdateInputs; //
|
|
140
140
|
|
|
141
141
|
const { status, data } = await apiInstance.updateInvoiceLineItem(
|
|
142
142
|
invoiceId,
|
|
143
143
|
lineItemId,
|
|
144
|
-
|
|
144
|
+
invoiceLineItemUpdateInputs
|
|
145
145
|
);
|
|
146
146
|
```
|
|
147
147
|
|
|
@@ -149,9 +149,9 @@ const { status, data } = await apiInstance.updateInvoiceLineItem(
|
|
|
149
149
|
|
|
150
150
|
|Name | Type | Description | Notes|
|
|
151
151
|
|------------- | ------------- | ------------- | -------------|
|
|
152
|
+
| **invoiceLineItemUpdateInputs** | **InvoiceLineItemUpdateInputs**| | |
|
|
152
153
|
| **invoiceId** | [**string**] | The invoice identifier | defaults to undefined|
|
|
153
154
|
| **lineItemId** | [**string**] | The lineItem identifier | defaults to undefined|
|
|
154
|
-
| **invoiceLineItem** | **InvoiceLineItemUpdateInputs** | Filter by invoiceLineItem | defaults to undefined|
|
|
155
155
|
|
|
156
156
|
|
|
157
157
|
### Return type
|
|
@@ -164,7 +164,7 @@ const { status, data } = await apiInstance.updateInvoiceLineItem(
|
|
|
164
164
|
|
|
165
165
|
### HTTP request headers
|
|
166
166
|
|
|
167
|
-
- **Content-Type**:
|
|
167
|
+
- **Content-Type**: application/json
|
|
168
168
|
- **Accept**: application/json
|
|
169
169
|
|
|
170
170
|
|
package/docs/LoginsApi.md
CHANGED
|
@@ -356,7 +356,7 @@ const { status, data } = await apiInstance.getLogins(
|
|
|
356
356
|
[[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)
|
|
357
357
|
|
|
358
358
|
# **updateLoginEmail**
|
|
359
|
-
> GetLogin200Response updateLoginEmail()
|
|
359
|
+
> GetLogin200Response updateLoginEmail(addEventAccessUserRequest)
|
|
360
360
|
|
|
361
361
|
Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
|
|
362
362
|
|
|
@@ -365,18 +365,19 @@ Changes the email address for the given login username in both the database and
|
|
|
365
365
|
```typescript
|
|
366
366
|
import {
|
|
367
367
|
LoginsApi,
|
|
368
|
-
Configuration
|
|
368
|
+
Configuration,
|
|
369
|
+
AddEventAccessUserRequest
|
|
369
370
|
} from '@connectedxm/admin-sdk';
|
|
370
371
|
|
|
371
372
|
const configuration = new Configuration();
|
|
372
373
|
const apiInstance = new LoginsApi(configuration);
|
|
373
374
|
|
|
374
375
|
let username: string; //The username identifier (default to undefined)
|
|
375
|
-
let
|
|
376
|
+
let addEventAccessUserRequest: AddEventAccessUserRequest; //
|
|
376
377
|
|
|
377
378
|
const { status, data } = await apiInstance.updateLoginEmail(
|
|
378
379
|
username,
|
|
379
|
-
|
|
380
|
+
addEventAccessUserRequest
|
|
380
381
|
);
|
|
381
382
|
```
|
|
382
383
|
|
|
@@ -384,8 +385,8 @@ const { status, data } = await apiInstance.updateLoginEmail(
|
|
|
384
385
|
|
|
385
386
|
|Name | Type | Description | Notes|
|
|
386
387
|
|------------- | ------------- | ------------- | -------------|
|
|
388
|
+
| **addEventAccessUserRequest** | **AddEventAccessUserRequest**| | |
|
|
387
389
|
| **username** | [**string**] | The username identifier | defaults to undefined|
|
|
388
|
-
| **email** | [**string**] | Filter by email | defaults to undefined|
|
|
389
390
|
|
|
390
391
|
|
|
391
392
|
### Return type
|
|
@@ -398,7 +399,7 @@ const { status, data } = await apiInstance.updateLoginEmail(
|
|
|
398
399
|
|
|
399
400
|
### HTTP request headers
|
|
400
401
|
|
|
401
|
-
- **Content-Type**:
|
|
402
|
+
- **Content-Type**: application/json
|
|
402
403
|
- **Accept**: application/json
|
|
403
404
|
|
|
404
405
|
|
|
@@ -410,7 +411,7 @@ const { status, data } = await apiInstance.updateLoginEmail(
|
|
|
410
411
|
[[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)
|
|
411
412
|
|
|
412
413
|
# **updateLoginPassword**
|
|
413
|
-
> GetLogin200Response updateLoginPassword()
|
|
414
|
+
> GetLogin200Response updateLoginPassword(updateLoginPasswordRequest)
|
|
414
415
|
|
|
415
416
|
Sets a permanent new password for the Cognito login identified by username, requiring both read and update permissions on accounts; existing logins and login/logins list caches are invalidated on success.
|
|
416
417
|
|
|
@@ -419,18 +420,19 @@ Sets a permanent new password for the Cognito login identified by username, requ
|
|
|
419
420
|
```typescript
|
|
420
421
|
import {
|
|
421
422
|
LoginsApi,
|
|
422
|
-
Configuration
|
|
423
|
+
Configuration,
|
|
424
|
+
UpdateLoginPasswordRequest
|
|
423
425
|
} from '@connectedxm/admin-sdk';
|
|
424
426
|
|
|
425
427
|
const configuration = new Configuration();
|
|
426
428
|
const apiInstance = new LoginsApi(configuration);
|
|
427
429
|
|
|
428
430
|
let username: string; //The username identifier (default to undefined)
|
|
429
|
-
let
|
|
431
|
+
let updateLoginPasswordRequest: UpdateLoginPasswordRequest; //
|
|
430
432
|
|
|
431
433
|
const { status, data } = await apiInstance.updateLoginPassword(
|
|
432
434
|
username,
|
|
433
|
-
|
|
435
|
+
updateLoginPasswordRequest
|
|
434
436
|
);
|
|
435
437
|
```
|
|
436
438
|
|
|
@@ -438,8 +440,8 @@ const { status, data } = await apiInstance.updateLoginPassword(
|
|
|
438
440
|
|
|
439
441
|
|Name | Type | Description | Notes|
|
|
440
442
|
|------------- | ------------- | ------------- | -------------|
|
|
443
|
+
| **updateLoginPasswordRequest** | **UpdateLoginPasswordRequest**| | |
|
|
441
444
|
| **username** | [**string**] | The username identifier | defaults to undefined|
|
|
442
|
-
| **password** | [**string**] | Filter by password | defaults to undefined|
|
|
443
445
|
|
|
444
446
|
|
|
445
447
|
### Return type
|
|
@@ -452,7 +454,7 @@ const { status, data } = await apiInstance.updateLoginPassword(
|
|
|
452
454
|
|
|
453
455
|
### HTTP request headers
|
|
454
456
|
|
|
455
|
-
- **Content-Type**:
|
|
457
|
+
- **Content-Type**: application/json
|
|
456
458
|
- **Accept**: application/json
|
|
457
459
|
|
|
458
460
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# MarkNotificationsReadRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**notificationIds** | **Array<string>** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { MarkNotificationsReadRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: MarkNotificationsReadRequest = {
|
|
16
|
+
notificationIds,
|
|
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)
|
package/docs/NotificationsApi.md
CHANGED
|
@@ -170,7 +170,7 @@ const { status, data } = await apiInstance.getNotifications(
|
|
|
170
170
|
[[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)
|
|
171
171
|
|
|
172
172
|
# **markNotificationsRead**
|
|
173
|
-
> SyncAccounts200Response markNotificationsRead()
|
|
173
|
+
> SyncAccounts200Response markNotificationsRead(markNotificationsReadRequest)
|
|
174
174
|
|
|
175
175
|
Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
176
176
|
|
|
@@ -179,16 +179,17 @@ Marks the given list of notification IDs as read for the current organization me
|
|
|
179
179
|
```typescript
|
|
180
180
|
import {
|
|
181
181
|
NotificationsApi,
|
|
182
|
-
Configuration
|
|
182
|
+
Configuration,
|
|
183
|
+
MarkNotificationsReadRequest
|
|
183
184
|
} from '@connectedxm/admin-sdk';
|
|
184
185
|
|
|
185
186
|
const configuration = new Configuration();
|
|
186
187
|
const apiInstance = new NotificationsApi(configuration);
|
|
187
188
|
|
|
188
|
-
let
|
|
189
|
+
let markNotificationsReadRequest: MarkNotificationsReadRequest; //
|
|
189
190
|
|
|
190
191
|
const { status, data } = await apiInstance.markNotificationsRead(
|
|
191
|
-
|
|
192
|
+
markNotificationsReadRequest
|
|
192
193
|
);
|
|
193
194
|
```
|
|
194
195
|
|
|
@@ -196,7 +197,7 @@ const { status, data } = await apiInstance.markNotificationsRead(
|
|
|
196
197
|
|
|
197
198
|
|Name | Type | Description | Notes|
|
|
198
199
|
|------------- | ------------- | ------------- | -------------|
|
|
199
|
-
| **
|
|
200
|
+
| **markNotificationsReadRequest** | **MarkNotificationsReadRequest**| | |
|
|
200
201
|
|
|
201
202
|
|
|
202
203
|
### Return type
|
|
@@ -209,7 +210,7 @@ const { status, data } = await apiInstance.markNotificationsRead(
|
|
|
209
210
|
|
|
210
211
|
### HTTP request headers
|
|
211
212
|
|
|
212
|
-
- **Content-Type**:
|
|
213
|
+
- **Content-Type**: application/json
|
|
213
214
|
- **Accept**: application/json
|
|
214
215
|
|
|
215
216
|
|