@connectedxm/admin-sdk 8.1.3 → 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.
Files changed (117) hide show
  1. package/.openapi-generator/FILES +30 -1
  2. package/README.md +2 -2
  3. package/api.ts +1384 -2111
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +643 -959
  8. package/dist/api.js +1182 -1491
  9. package/dist/base.d.ts +1 -1
  10. package/dist/base.js +1 -1
  11. package/dist/common.d.ts +1 -1
  12. package/dist/common.js +1 -1
  13. package/dist/configuration.d.ts +1 -1
  14. package/dist/configuration.js +1 -1
  15. package/dist/esm/api.d.ts +643 -959
  16. package/dist/esm/api.js +1167 -1476
  17. package/dist/esm/base.d.ts +1 -1
  18. package/dist/esm/base.js +1 -1
  19. package/dist/esm/common.d.ts +1 -1
  20. package/dist/esm/common.js +1 -1
  21. package/dist/esm/configuration.d.ts +1 -1
  22. package/dist/esm/configuration.js +1 -1
  23. package/docs/ActivitiesApi.md +6 -12
  24. package/docs/AddChannelSubscriberRequest.md +20 -0
  25. package/docs/AddCustomReportUserRequest.md +20 -0
  26. package/docs/{ImportCreateInputsValuesInner.md → AddEventAccessUserRequest.md} +3 -3
  27. package/docs/AddEventAddOnTierRequest.md +20 -0
  28. package/docs/AddRoomToRoomTypeRequest.md +20 -0
  29. package/docs/ApproveEventPassRequest.md +20 -0
  30. package/docs/BenefitsApi.md +5 -5
  31. package/docs/BookingsAvailabilitiesApi.md +5 -5
  32. package/docs/BookingsBlackoutsApi.md +5 -5
  33. package/docs/BookingsPlacesApi.md +5 -5
  34. package/docs/BookingsQuestionsApi.md +7 -6
  35. package/docs/BookingsQuestionsChoicesApi.md +7 -6
  36. package/docs/BookingsSpacesApi.md +5 -5
  37. package/docs/BulkUploadSearchListValuesRequest.md +20 -0
  38. package/docs/ChannelsApi.md +22 -21
  39. package/docs/CreateActivityRequest.md +24 -0
  40. package/docs/CreateEventSessionPriceRequest.md +22 -0
  41. package/docs/CreateGroupInvitationsRequest.md +22 -0
  42. package/docs/CreateOrganizationSideEffectRequest.md +26 -0
  43. package/docs/CreateThreadMessageReactionRequest.md +22 -0
  44. package/docs/DenyEventPassRequest.md +22 -0
  45. package/docs/EventsAccessApi.md +7 -6
  46. package/docs/EventsAddonsApi.md +12 -11
  47. package/docs/EventsBypassApi.md +5 -5
  48. package/docs/EventsCouponsApi.md +7 -6
  49. package/docs/EventsFaqsApi.md +17 -16
  50. package/docs/EventsFollowupsApi.md +26 -23
  51. package/docs/EventsMatchesApi.md +7 -6
  52. package/docs/EventsPackagesApi.md +10 -10
  53. package/docs/EventsPackagesPassesApi.md +5 -5
  54. package/docs/EventsPagesApi.md +5 -5
  55. package/docs/EventsPassesApi.md +25 -24
  56. package/docs/EventsPassesFollowupsApi.md +14 -12
  57. package/docs/EventsPasstypesApi.md +12 -11
  58. package/docs/EventsQuestionsApi.md +31 -28
  59. package/docs/EventsRegistrationsPackagesApi.md +10 -10
  60. package/docs/EventsRoomsApi.md +14 -15
  61. package/docs/EventsRoomtypesApi.md +12 -11
  62. package/docs/EventsSectionsApi.md +26 -23
  63. package/docs/EventsSessionsApi.md +5 -5
  64. package/docs/EventsSessionsLocationsApi.md +5 -5
  65. package/docs/EventsSessionsMatchesApi.md +7 -6
  66. package/docs/EventsSessionsPricesApi.md +13 -17
  67. package/docs/EventsSessionsQuestionsApi.md +31 -28
  68. package/docs/EventsSessionsSectionsApi.md +19 -17
  69. package/docs/EventsSpeakersApi.md +5 -5
  70. package/docs/EventsSponsorshiplevelsApi.md +12 -11
  71. package/docs/EventsSponsorshiplevelsTranslationsApi.md +5 -5
  72. package/docs/EventsSponsorshipsApi.md +12 -11
  73. package/docs/EventsSponsorshipsTranslationsApi.md +5 -5
  74. package/docs/GroupsInvitationsApi.md +7 -9
  75. package/docs/ImportCreateInputs.md +1 -1
  76. package/docs/ImportRoomsRequest.md +22 -0
  77. package/docs/InterestsApi.md +5 -5
  78. package/docs/InvoicesApi.md +5 -5
  79. package/docs/InvoicesLineitemsApi.md +5 -5
  80. package/docs/LoginsApi.md +14 -12
  81. package/docs/MarkNotificationsReadRequest.md +20 -0
  82. package/docs/NotificationsApi.md +7 -6
  83. package/docs/OrganizationApi.md +14 -21
  84. package/docs/OrganizationDomainsApi.md +7 -6
  85. package/docs/OrganizationSideeffectsApi.md +7 -15
  86. package/docs/OrganizationTeammembersApi.md +5 -5
  87. package/docs/OrganizationUsersApi.md +7 -6
  88. package/docs/ReorderBookingSpaceQuestionChoicesRequest.md +20 -0
  89. package/docs/ReorderBookingSpaceQuestionsRequest.md +20 -0
  90. package/docs/ReorderEventFaqSectionQuestionsRequest.md +20 -0
  91. package/docs/ReorderEventSponsorshipLevelsRequest.md +20 -0
  92. package/docs/ReorderEventSponsorshipsRequest.md +20 -0
  93. package/docs/ReportsApi.md +5 -5
  94. package/docs/ReportsUsersApi.md +7 -6
  95. package/docs/SearchlistsValuesApi.md +7 -6
  96. package/docs/SeriesApi.md +5 -5
  97. package/docs/SeriesQuestionsApi.md +5 -5
  98. package/docs/SeriesQuestionsChoicesApi.md +12 -11
  99. package/docs/SponsorsApi.md +5 -5
  100. package/docs/StartEventRoundMatchmakingRequest.md +20 -0
  101. package/docs/StorageFilesApi.md +7 -12
  102. package/docs/StorageVideosCaptionsApi.md +7 -9
  103. package/docs/StreamsApi.md +5 -5
  104. package/docs/StreamsOutputsApi.md +5 -5
  105. package/docs/SurveysQuestionsApi.md +31 -28
  106. package/docs/SurveysSectionsApi.md +19 -17
  107. package/docs/ThreadsMessagesReactionsApi.md +6 -9
  108. package/docs/UpdateEventFollowupQuestionRequest.md +20 -0
  109. package/docs/UpdateEventPassFollowupResponsesRequest.md +20 -0
  110. package/docs/UpdateEventSessionPriceRequest.md +22 -0
  111. package/docs/UpdateLoginPasswordRequest.md +20 -0
  112. package/docs/UpdateOrganizationDomainRequest.md +20 -0
  113. package/docs/UpdateOrganizationIntegrationsRequest.md +26 -0
  114. package/docs/UploadFileRequest.md +24 -0
  115. package/docs/UploadVideoCaptionsRequest.md +22 -0
  116. package/docs/UpsertLinkPreviewRequest.md +20 -0
  117. package/package.json +1 -1
@@ -331,7 +331,7 @@ const { status, data } = await apiInstance.updateOrganization(
331
331
  [[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)
332
332
 
333
333
  # **updateOrganizationIntegrations**
334
- > CreateAccountInvitations200Response updateOrganizationIntegrations()
334
+ > CreateAccountInvitations200Response updateOrganizationIntegrations(updateOrganizationIntegrationsRequest)
335
335
 
336
336
  Enables or disables the organization\'s Ghost blog integration and stores its connection settings (site URL, admin API key, content API key) so published Ghost content can be surfaced in the platform.
337
337
 
@@ -340,22 +340,17 @@ Enables or disables the organization\'s Ghost blog integration and stores its co
340
340
  ```typescript
341
341
  import {
342
342
  OrganizationApi,
343
- Configuration
343
+ Configuration,
344
+ UpdateOrganizationIntegrationsRequest
344
345
  } from '@connectedxm/admin-sdk';
345
346
 
346
347
  const configuration = new Configuration();
347
348
  const apiInstance = new OrganizationApi(configuration);
348
349
 
349
- let ghost: boolean; //Filter by ghost (default to undefined)
350
- let ghostUrl: string; //Filter by ghostUrl (default to undefined)
351
- let ghostAdminKey: string; //Filter by ghostAdminKey (optional) (default to undefined)
352
- let ghostContentKey: string; //Filter by ghostContentKey (optional) (default to undefined)
350
+ let updateOrganizationIntegrationsRequest: UpdateOrganizationIntegrationsRequest; //
353
351
 
354
352
  const { status, data } = await apiInstance.updateOrganizationIntegrations(
355
- ghost,
356
- ghostUrl,
357
- ghostAdminKey,
358
- ghostContentKey
353
+ updateOrganizationIntegrationsRequest
359
354
  );
360
355
  ```
361
356
 
@@ -363,10 +358,7 @@ const { status, data } = await apiInstance.updateOrganizationIntegrations(
363
358
 
364
359
  |Name | Type | Description | Notes|
365
360
  |------------- | ------------- | ------------- | -------------|
366
- | **ghost** | [**boolean**] | Filter by ghost | defaults to undefined|
367
- | **ghostUrl** | [**string**] | Filter by ghostUrl | defaults to undefined|
368
- | **ghostAdminKey** | [**string**] | Filter by ghostAdminKey | (optional) defaults to undefined|
369
- | **ghostContentKey** | [**string**] | Filter by ghostContentKey | (optional) defaults to undefined|
361
+ | **updateOrganizationIntegrationsRequest** | **UpdateOrganizationIntegrationsRequest**| | |
370
362
 
371
363
 
372
364
  ### Return type
@@ -379,7 +371,7 @@ const { status, data } = await apiInstance.updateOrganizationIntegrations(
379
371
 
380
372
  ### HTTP request headers
381
373
 
382
- - **Content-Type**: Not defined
374
+ - **Content-Type**: application/json
383
375
  - **Accept**: application/json
384
376
 
385
377
 
@@ -446,7 +438,7 @@ const { status, data } = await apiInstance.updateOrganizationMembership(
446
438
  [[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)
447
439
 
448
440
  # **upsertLinkPreview**
449
- > UpsertLinkPreview200Response upsertLinkPreview()
441
+ > UpsertLinkPreview200Response upsertLinkPreview(upsertLinkPreviewRequest)
450
442
 
451
443
  Fetches (or returns a cached, up to 7 days old) title, description, image, and site metadata for the given URL, storing the result so it can be reused when rendering link previews.
452
444
 
@@ -455,16 +447,17 @@ Fetches (or returns a cached, up to 7 days old) title, description, image, and s
455
447
  ```typescript
456
448
  import {
457
449
  OrganizationApi,
458
- Configuration
450
+ Configuration,
451
+ UpsertLinkPreviewRequest
459
452
  } from '@connectedxm/admin-sdk';
460
453
 
461
454
  const configuration = new Configuration();
462
455
  const apiInstance = new OrganizationApi(configuration);
463
456
 
464
- let href: string; //Filter by href (default to undefined)
457
+ let upsertLinkPreviewRequest: UpsertLinkPreviewRequest; //
465
458
 
466
459
  const { status, data } = await apiInstance.upsertLinkPreview(
467
- href
460
+ upsertLinkPreviewRequest
468
461
  );
469
462
  ```
470
463
 
@@ -472,7 +465,7 @@ const { status, data } = await apiInstance.upsertLinkPreview(
472
465
 
473
466
  |Name | Type | Description | Notes|
474
467
  |------------- | ------------- | ------------- | -------------|
475
- | **href** | [**string**] | Filter by href | defaults to undefined|
468
+ | **upsertLinkPreviewRequest** | **UpsertLinkPreviewRequest**| | |
476
469
 
477
470
 
478
471
  ### Return type
@@ -485,7 +478,7 @@ const { status, data } = await apiInstance.upsertLinkPreview(
485
478
 
486
479
  ### HTTP request headers
487
480
 
488
- - **Content-Type**: Not defined
481
+ - **Content-Type**: application/json
489
482
  - **Accept**: application/json
490
483
 
491
484
 
@@ -97,7 +97,7 @@ This endpoint does not have any parameters.
97
97
  [[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)
98
98
 
99
99
  # **updateOrganizationDomain**
100
- > UpdateOrganizationDomain200Response updateOrganizationDomain()
100
+ > UpdateOrganizationDomain200Response updateOrganizationDomain(updateOrganizationDomainRequest)
101
101
 
102
102
  Configures a custom domain for the organization by registering it (and its www subdomain, unless it is itself a subdomain) with Vercel, then saves the domain on the organization record; fails if a domain is already set or the domain is invalid, and requires the \"update\" permission on \"org\".
103
103
 
@@ -106,16 +106,17 @@ Configures a custom domain for the organization by registering it (and its www s
106
106
  ```typescript
107
107
  import {
108
108
  OrganizationDomainsApi,
109
- Configuration
109
+ Configuration,
110
+ UpdateOrganizationDomainRequest
110
111
  } from '@connectedxm/admin-sdk';
111
112
 
112
113
  const configuration = new Configuration();
113
114
  const apiInstance = new OrganizationDomainsApi(configuration);
114
115
 
115
- let domain: string; //Filter by domain (default to undefined)
116
+ let updateOrganizationDomainRequest: UpdateOrganizationDomainRequest; //
116
117
 
117
118
  const { status, data } = await apiInstance.updateOrganizationDomain(
118
- domain
119
+ updateOrganizationDomainRequest
119
120
  );
120
121
  ```
121
122
 
@@ -123,7 +124,7 @@ const { status, data } = await apiInstance.updateOrganizationDomain(
123
124
 
124
125
  |Name | Type | Description | Notes|
125
126
  |------------- | ------------- | ------------- | -------------|
126
- | **domain** | [**string**] | Filter by domain | defaults to undefined|
127
+ | **updateOrganizationDomainRequest** | **UpdateOrganizationDomainRequest**| | |
127
128
 
128
129
 
129
130
  ### Return type
@@ -136,7 +137,7 @@ const { status, data } = await apiInstance.updateOrganizationDomain(
136
137
 
137
138
  ### HTTP request headers
138
139
 
139
- - **Content-Type**: Not defined
140
+ - **Content-Type**: application/json
140
141
  - **Accept**: application/json
141
142
 
142
143
 
@@ -10,7 +10,7 @@ All URIs are relative to *https://admin-api.connected.dev*
10
10
  |[**getOrganizationSideEffects**](#getorganizationsideeffects) | **GET** /organization/sideEffects | List an organization\'s side effects|
11
11
 
12
12
  # **createOrganizationSideEffect**
13
- > CreateOrganizationSideEffect200Response createOrganizationSideEffect()
13
+ > CreateOrganizationSideEffect200Response createOrganizationSideEffect(createOrganizationSideEffectRequest)
14
14
 
15
15
  Creates a side effect that automatically performs an action (such as adding a member to a tier or sending a webhook) when a specified trigger occurs (such as a new account tier or a checked-in event pass), requiring update permission on the resources associated with the chosen trigger and action types.
16
16
 
@@ -19,22 +19,17 @@ Creates a side effect that automatically performs an action (such as adding a me
19
19
  ```typescript
20
20
  import {
21
21
  OrganizationSideeffectsApi,
22
- Configuration
22
+ Configuration,
23
+ CreateOrganizationSideEffectRequest
23
24
  } from '@connectedxm/admin-sdk';
24
25
 
25
26
  const configuration = new Configuration();
26
27
  const apiInstance = new OrganizationSideeffectsApi(configuration);
27
28
 
28
- let triggerType: SideEffectTriggerType; //Filter by triggerType (default to undefined)
29
- let triggerId: string; //Filter by triggerId (default to undefined)
30
- let actionType: SideEffectActionType; //Filter by actionType (default to undefined)
31
- let actionId: string; //Filter by actionId (default to undefined)
29
+ let createOrganizationSideEffectRequest: CreateOrganizationSideEffectRequest; //
32
30
 
33
31
  const { status, data } = await apiInstance.createOrganizationSideEffect(
34
- triggerType,
35
- triggerId,
36
- actionType,
37
- actionId
32
+ createOrganizationSideEffectRequest
38
33
  );
39
34
  ```
40
35
 
@@ -42,10 +37,7 @@ const { status, data } = await apiInstance.createOrganizationSideEffect(
42
37
 
43
38
  |Name | Type | Description | Notes|
44
39
  |------------- | ------------- | ------------- | -------------|
45
- | **triggerType** | **SideEffectTriggerType** | Filter by triggerType | defaults to undefined|
46
- | **triggerId** | [**string**] | Filter by triggerId | defaults to undefined|
47
- | **actionType** | **SideEffectActionType** | Filter by actionType | defaults to undefined|
48
- | **actionId** | [**string**] | Filter by actionId | defaults to undefined|
40
+ | **createOrganizationSideEffectRequest** | **CreateOrganizationSideEffectRequest**| | |
49
41
 
50
42
 
51
43
  ### Return type
@@ -58,7 +50,7 @@ const { status, data } = await apiInstance.createOrganizationSideEffect(
58
50
 
59
51
  ### HTTP request headers
60
52
 
61
- - **Content-Type**: Not defined
53
+ - **Content-Type**: application/json
62
54
  - **Accept**: application/json
63
55
 
64
56
 
@@ -225,7 +225,7 @@ const { status, data } = await apiInstance.getOrganizationTeamMembers(
225
225
  [[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)
226
226
 
227
227
  # **updateOrganizationTeamMember**
228
- > CreateOrganizationTeamMember200Response updateOrganizationTeamMember()
228
+ > CreateOrganizationTeamMember200Response updateOrganizationTeamMember(organizationTeamMemberUpdateInputs)
229
229
 
230
230
  Updates the specified team member\'s details (name, title, image, etc.) and, if a new display priority is provided, re-sequences the priority of the other team members accordingly; requires update permission on the organization.
231
231
 
@@ -242,11 +242,11 @@ const configuration = new Configuration();
242
242
  const apiInstance = new OrganizationTeammembersApi(configuration);
243
243
 
244
244
  let teamMemberId: string; //The teamMember identifier (default to undefined)
245
- let teamMember: OrganizationTeamMemberUpdateInputs; //Filter by teamMember (default to undefined)
245
+ let organizationTeamMemberUpdateInputs: OrganizationTeamMemberUpdateInputs; //
246
246
 
247
247
  const { status, data } = await apiInstance.updateOrganizationTeamMember(
248
248
  teamMemberId,
249
- teamMember
249
+ organizationTeamMemberUpdateInputs
250
250
  );
251
251
  ```
252
252
 
@@ -254,8 +254,8 @@ const { status, data } = await apiInstance.updateOrganizationTeamMember(
254
254
 
255
255
  |Name | Type | Description | Notes|
256
256
  |------------- | ------------- | ------------- | -------------|
257
+ | **organizationTeamMemberUpdateInputs** | **OrganizationTeamMemberUpdateInputs**| | |
257
258
  | **teamMemberId** | [**string**] | The teamMember identifier | defaults to undefined|
258
- | **teamMember** | **OrganizationTeamMemberUpdateInputs** | Filter by teamMember | defaults to undefined|
259
259
 
260
260
 
261
261
  ### Return type
@@ -268,7 +268,7 @@ const { status, data } = await apiInstance.updateOrganizationTeamMember(
268
268
 
269
269
  ### HTTP request headers
270
270
 
271
- - **Content-Type**: Not defined
271
+ - **Content-Type**: application/json
272
272
  - **Accept**: application/json
273
273
 
274
274
 
@@ -9,7 +9,7 @@ All URIs are relative to *https://admin-api.connected.dev*
9
9
  |[**getOrganizationUsers**](#getorganizationusers) | **GET** /organization/users | List organization member users|
10
10
 
11
11
  # **addOrganizationUser**
12
- > AddOrganizationUser200Response addOrganizationUser()
12
+ > AddOrganizationUser200Response addOrganizationUser(addEventAccessUserRequest)
13
13
 
14
14
  Looks up an existing platform user by email and creates an organization membership for them with default (no) permissions, granting them access as an admin team member; requires create permission on users.
15
15
 
@@ -18,16 +18,17 @@ Looks up an existing platform user by email and creates an organization membersh
18
18
  ```typescript
19
19
  import {
20
20
  OrganizationUsersApi,
21
- Configuration
21
+ Configuration,
22
+ AddEventAccessUserRequest
22
23
  } from '@connectedxm/admin-sdk';
23
24
 
24
25
  const configuration = new Configuration();
25
26
  const apiInstance = new OrganizationUsersApi(configuration);
26
27
 
27
- let email: string; //Filter by email (default to undefined)
28
+ let addEventAccessUserRequest: AddEventAccessUserRequest; //
28
29
 
29
30
  const { status, data } = await apiInstance.addOrganizationUser(
30
- email
31
+ addEventAccessUserRequest
31
32
  );
32
33
  ```
33
34
 
@@ -35,7 +36,7 @@ const { status, data } = await apiInstance.addOrganizationUser(
35
36
 
36
37
  |Name | Type | Description | Notes|
37
38
  |------------- | ------------- | ------------- | -------------|
38
- | **email** | [**string**] | Filter by email | defaults to undefined|
39
+ | **addEventAccessUserRequest** | **AddEventAccessUserRequest**| | |
39
40
 
40
41
 
41
42
  ### Return type
@@ -48,7 +49,7 @@ const { status, data } = await apiInstance.addOrganizationUser(
48
49
 
49
50
  ### HTTP request headers
50
51
 
51
- - **Content-Type**: Not defined
52
+ - **Content-Type**: application/json
52
53
  - **Accept**: application/json
53
54
 
54
55
 
@@ -0,0 +1,20 @@
1
+ # ReorderBookingSpaceQuestionChoicesRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **choicesIds** | **Array<string>** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorderBookingSpaceQuestionChoicesRequest } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: ReorderBookingSpaceQuestionChoicesRequest = {
16
+ choicesIds,
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
+ # ReorderBookingSpaceQuestionsRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **questionsIds** | **Array<string>** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorderBookingSpaceQuestionsRequest } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: ReorderBookingSpaceQuestionsRequest = {
16
+ questionsIds,
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
+ # ReorderEventFaqSectionQuestionsRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **questionIds** | **Array<string>** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorderEventFaqSectionQuestionsRequest } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: ReorderEventFaqSectionQuestionsRequest = {
16
+ questionIds,
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
+ # ReorderEventSponsorshipLevelsRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **levelIds** | **Array<string>** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorderEventSponsorshipLevelsRequest } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: ReorderEventSponsorshipLevelsRequest = {
16
+ levelIds,
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
+ # ReorderEventSponsorshipsRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **sponsorshipIds** | **Array<string>** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorderEventSponsorshipsRequest } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: ReorderEventSponsorshipsRequest = {
16
+ sponsorshipIds,
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)
@@ -501,7 +501,7 @@ const { status, data } = await apiInstance.getReports(
501
501
  [[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)
502
502
 
503
503
  # **updateCustomReport**
504
- > GetCustomReport200Response updateCustomReport()
504
+ > GetCustomReport200Response updateCustomReport(customReportUpdateInputs)
505
505
 
506
506
  Updates the configuration (filters, name, sharing settings, etc.) of an existing custom report; only the report owner, or a shared user when the report isn\'t restricted to specific users, may update it, and changing the shared setting itself is restricted to the owner, requiring the update permission on the reports domain.
507
507
 
@@ -518,11 +518,11 @@ const configuration = new Configuration();
518
518
  const apiInstance = new ReportsApi(configuration);
519
519
 
520
520
  let reportId: string; //The report identifier (default to undefined)
521
- let report: CustomReportUpdateInputs; //Filter by report (default to undefined)
521
+ let customReportUpdateInputs: CustomReportUpdateInputs; //
522
522
 
523
523
  const { status, data } = await apiInstance.updateCustomReport(
524
524
  reportId,
525
- report
525
+ customReportUpdateInputs
526
526
  );
527
527
  ```
528
528
 
@@ -530,8 +530,8 @@ const { status, data } = await apiInstance.updateCustomReport(
530
530
 
531
531
  |Name | Type | Description | Notes|
532
532
  |------------- | ------------- | ------------- | -------------|
533
+ | **customReportUpdateInputs** | **CustomReportUpdateInputs**| | |
533
534
  | **reportId** | [**string**] | The report identifier | defaults to undefined|
534
- | **report** | **CustomReportUpdateInputs** | Filter by report | defaults to undefined|
535
535
 
536
536
 
537
537
  ### Return type
@@ -544,7 +544,7 @@ const { status, data } = await apiInstance.updateCustomReport(
544
544
 
545
545
  ### HTTP request headers
546
546
 
547
- - **Content-Type**: Not defined
547
+ - **Content-Type**: application/json
548
548
  - **Accept**: application/json
549
549
 
550
550
 
@@ -9,7 +9,7 @@ All URIs are relative to *https://admin-api.connected.dev*
9
9
  |[**removeCustomReportUser**](#removecustomreportuser) | **DELETE** /reports/custom/{reportId}/users/{userId} | Unshare a custom report from a user|
10
10
 
11
11
  # **addCustomReportUser**
12
- > CreateAccountInvitations200Response addCustomReportUser()
12
+ > CreateAccountInvitations200Response addCustomReportUser(addCustomReportUserRequest)
13
13
 
14
14
  Grants another user access to a custom report by adding them to its shared users list; only the report\'s owner may add users, and this requires the update permission on the reports domain.
15
15
 
@@ -18,18 +18,19 @@ Grants another user access to a custom report by adding them to its shared users
18
18
  ```typescript
19
19
  import {
20
20
  ReportsUsersApi,
21
- Configuration
21
+ Configuration,
22
+ AddCustomReportUserRequest
22
23
  } from '@connectedxm/admin-sdk';
23
24
 
24
25
  const configuration = new Configuration();
25
26
  const apiInstance = new ReportsUsersApi(configuration);
26
27
 
27
28
  let reportId: string; //The report identifier (default to undefined)
28
- let userId: string; //Filter by userId (default to undefined)
29
+ let addCustomReportUserRequest: AddCustomReportUserRequest; //
29
30
 
30
31
  const { status, data } = await apiInstance.addCustomReportUser(
31
32
  reportId,
32
- userId
33
+ addCustomReportUserRequest
33
34
  );
34
35
  ```
35
36
 
@@ -37,8 +38,8 @@ const { status, data } = await apiInstance.addCustomReportUser(
37
38
 
38
39
  |Name | Type | Description | Notes|
39
40
  |------------- | ------------- | ------------- | -------------|
41
+ | **addCustomReportUserRequest** | **AddCustomReportUserRequest**| | |
40
42
  | **reportId** | [**string**] | The report identifier | defaults to undefined|
41
- | **userId** | [**string**] | Filter by userId | defaults to undefined|
42
43
 
43
44
 
44
45
  ### Return type
@@ -51,7 +52,7 @@ const { status, data } = await apiInstance.addCustomReportUser(
51
52
 
52
53
  ### HTTP request headers
53
54
 
54
- - **Content-Type**: Not defined
55
+ - **Content-Type**: application/json
55
56
  - **Accept**: application/json
56
57
 
57
58
 
@@ -13,7 +13,7 @@ All URIs are relative to *https://admin-api.connected.dev*
13
13
  |[**updateSearchListValue**](#updatesearchlistvalue) | **PUT** /searchlists/{searchListId}/values/{valueId} | Update a search list value|
14
14
 
15
15
  # **bulkUploadSearchListValues**
16
- > BulkUploadSearchListValues200Response bulkUploadSearchListValues()
16
+ > BulkUploadSearchListValues200Response bulkUploadSearchListValues(bulkUploadSearchListValuesRequest)
17
17
 
18
18
  Creates many values on the given search list in a single request from an array of strings, skipping duplicates, and requires organization read and update permissions.
19
19
 
@@ -22,18 +22,19 @@ Creates many values on the given search list in a single request from an array o
22
22
  ```typescript
23
23
  import {
24
24
  SearchlistsValuesApi,
25
- Configuration
25
+ Configuration,
26
+ BulkUploadSearchListValuesRequest
26
27
  } from '@connectedxm/admin-sdk';
27
28
 
28
29
  const configuration = new Configuration();
29
30
  const apiInstance = new SearchlistsValuesApi(configuration);
30
31
 
31
32
  let searchListId: string; //The searchList identifier (default to undefined)
32
- let values: Array<string>; //Filter by values (default to undefined)
33
+ let bulkUploadSearchListValuesRequest: BulkUploadSearchListValuesRequest; //
33
34
 
34
35
  const { status, data } = await apiInstance.bulkUploadSearchListValues(
35
36
  searchListId,
36
- values
37
+ bulkUploadSearchListValuesRequest
37
38
  );
38
39
  ```
39
40
 
@@ -41,8 +42,8 @@ const { status, data } = await apiInstance.bulkUploadSearchListValues(
41
42
 
42
43
  |Name | Type | Description | Notes|
43
44
  |------------- | ------------- | ------------- | -------------|
45
+ | **bulkUploadSearchListValuesRequest** | **BulkUploadSearchListValuesRequest**| | |
44
46
  | **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
45
- | **values** | **Array&lt;string&gt;** | Filter by values | defaults to undefined|
46
47
 
47
48
 
48
49
  ### Return type
@@ -55,7 +56,7 @@ const { status, data } = await apiInstance.bulkUploadSearchListValues(
55
56
 
56
57
  ### HTTP request headers
57
58
 
58
- - **Content-Type**: Not defined
59
+ - **Content-Type**: application/json
59
60
  - **Accept**: application/json
60
61
 
61
62
 
package/docs/SeriesApi.md CHANGED
@@ -463,7 +463,7 @@ const { status, data } = await apiInstance.removeSeriesEvent(
463
463
  [[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)
464
464
 
465
465
  # **updateSeries**
466
- > CreateSeries200Response updateSeries()
466
+ > CreateSeries200Response updateSeries(seriesUpdateInputs)
467
467
 
468
468
  Updates the details of an existing event series, excluding its id, image, and timestamps, requiring \"read\" and \"update\" permission on events.
469
469
 
@@ -480,11 +480,11 @@ const configuration = new Configuration();
480
480
  const apiInstance = new SeriesApi(configuration);
481
481
 
482
482
  let seriesId: string; //The series identifier (default to undefined)
483
- let series: SeriesUpdateInputs; //Filter by series (default to undefined)
483
+ let seriesUpdateInputs: SeriesUpdateInputs; //
484
484
 
485
485
  const { status, data } = await apiInstance.updateSeries(
486
486
  seriesId,
487
- series
487
+ seriesUpdateInputs
488
488
  );
489
489
  ```
490
490
 
@@ -492,8 +492,8 @@ const { status, data } = await apiInstance.updateSeries(
492
492
 
493
493
  |Name | Type | Description | Notes|
494
494
  |------------- | ------------- | ------------- | -------------|
495
+ | **seriesUpdateInputs** | **SeriesUpdateInputs**| | |
495
496
  | **seriesId** | [**string**] | The series identifier | defaults to undefined|
496
- | **series** | **SeriesUpdateInputs** | Filter by series | defaults to undefined|
497
497
 
498
498
 
499
499
  ### Return type
@@ -506,7 +506,7 @@ const { status, data } = await apiInstance.updateSeries(
506
506
 
507
507
  ### HTTP request headers
508
508
 
509
- - **Content-Type**: Not defined
509
+ - **Content-Type**: application/json
510
510
  - **Accept**: application/json
511
511
 
512
512
 
@@ -362,7 +362,7 @@ const { status, data } = await apiInstance.getSeriesQuestions(
362
362
  [[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)
363
363
 
364
364
  # **updateSeriesQuestion**
365
- > CreateSeriesQuestion200Response updateSeriesQuestion()
365
+ > CreateSeriesQuestion200Response updateSeriesQuestion(seriesQuestionUpdateInputs)
366
366
 
367
367
  Updates the properties of a registration question on a series, such as its label, type, or required flag, and re-sequences sortOrder among sibling questions if a new sortOrder is supplied; requires update permission on events.
368
368
 
@@ -380,12 +380,12 @@ const apiInstance = new SeriesQuestionsApi(configuration);
380
380
 
381
381
  let seriesId: string; //The series identifier (default to undefined)
382
382
  let questionId: string; //The question identifier (default to undefined)
383
- let question: SeriesQuestionUpdateInputs; //Filter by question (default to undefined)
383
+ let seriesQuestionUpdateInputs: SeriesQuestionUpdateInputs; //
384
384
 
385
385
  const { status, data } = await apiInstance.updateSeriesQuestion(
386
386
  seriesId,
387
387
  questionId,
388
- question
388
+ seriesQuestionUpdateInputs
389
389
  );
390
390
  ```
391
391
 
@@ -393,9 +393,9 @@ const { status, data } = await apiInstance.updateSeriesQuestion(
393
393
 
394
394
  |Name | Type | Description | Notes|
395
395
  |------------- | ------------- | ------------- | -------------|
396
+ | **seriesQuestionUpdateInputs** | **SeriesQuestionUpdateInputs**| | |
396
397
  | **seriesId** | [**string**] | The series identifier | defaults to undefined|
397
398
  | **questionId** | [**string**] | The question identifier | defaults to undefined|
398
- | **question** | **SeriesQuestionUpdateInputs** | Filter by question | defaults to undefined|
399
399
 
400
400
 
401
401
  ### Return type
@@ -408,7 +408,7 @@ const { status, data } = await apiInstance.updateSeriesQuestion(
408
408
 
409
409
  ### HTTP request headers
410
410
 
411
- - **Content-Type**: Not defined
411
+ - **Content-Type**: application/json
412
412
  - **Accept**: application/json
413
413
 
414
414