@connectedxm/admin-sdk 11.23.1 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/.openapi-generator/FILES +42 -2
  2. package/AdminApi.ts +9 -0
  3. package/README.md +2 -2
  4. package/api.ts +2857 -214
  5. package/base.ts +1 -1
  6. package/common.ts +1 -1
  7. package/configuration.ts +1 -1
  8. package/dist/AdminApi.d.ts +4 -1
  9. package/dist/AdminApi.js +3 -0
  10. package/dist/api.d.ts +1601 -151
  11. package/dist/api.js +2074 -196
  12. package/dist/base.d.ts +1 -1
  13. package/dist/base.js +1 -1
  14. package/dist/common.d.ts +1 -1
  15. package/dist/common.js +1 -1
  16. package/dist/configuration.d.ts +1 -1
  17. package/dist/configuration.js +1 -1
  18. package/dist/esm/AdminApi.d.ts +4 -1
  19. package/dist/esm/AdminApi.js +4 -1
  20. package/dist/esm/api.d.ts +1601 -151
  21. package/dist/esm/api.js +2028 -163
  22. package/dist/esm/base.d.ts +1 -1
  23. package/dist/esm/base.js +1 -1
  24. package/dist/esm/common.d.ts +1 -1
  25. package/dist/esm/common.js +1 -1
  26. package/dist/esm/configuration.d.ts +1 -1
  27. package/dist/esm/configuration.js +1 -1
  28. package/docs/Announcement.md +10 -24
  29. package/docs/AnnouncementAudience.md +44 -0
  30. package/docs/AnnouncementAudienceCondition.md +98 -0
  31. package/docs/AnnouncementAudienceConditionAccountAttribute.md +26 -0
  32. package/docs/AnnouncementAudienceConditionChoice.md +22 -0
  33. package/docs/AnnouncementAudienceConditionComparator.md +14 -0
  34. package/docs/AnnouncementAudienceConditionCreateInputs.md +60 -0
  35. package/docs/AnnouncementAudienceConditionEvent.md +24 -0
  36. package/docs/AnnouncementAudienceConditionInputs.md +58 -0
  37. package/docs/AnnouncementAudienceConditionQuestion.md +24 -0
  38. package/docs/AnnouncementAudienceConditionReference.md +22 -0
  39. package/docs/AnnouncementAudienceConditionType.md +40 -0
  40. package/docs/AnnouncementAudienceConditionUpdateInputs.md +60 -0
  41. package/docs/AnnouncementAudienceCreateInputs.md +30 -0
  42. package/docs/AnnouncementAudienceFilter.md +32 -0
  43. package/docs/AnnouncementAudienceFilterCreateInputs.md +24 -0
  44. package/docs/AnnouncementAudienceFilterUpdateInputs.md +22 -0
  45. package/docs/AnnouncementAudienceOperator.md +10 -0
  46. package/docs/AnnouncementAudienceReference.md +26 -0
  47. package/docs/AnnouncementAudienceScope.md +24 -0
  48. package/docs/AnnouncementAudienceUpdateInputs.md +24 -0
  49. package/docs/AnnouncementCreateInputs.md +5 -13
  50. package/docs/AnnouncementFilters.md +4 -10
  51. package/docs/AnnouncementMergeField.md +24 -0
  52. package/docs/AnnouncementTemplate.md +32 -0
  53. package/docs/AnnouncementTemplateCreateInputs.md +26 -0
  54. package/docs/AnnouncementTemplateTranslation.md +30 -0
  55. package/docs/AnnouncementTemplateTranslationUpdateInputs.md +22 -0
  56. package/docs/AnnouncementTemplateUpdateInputs.md +26 -0
  57. package/docs/AnnouncementUpdateInputs.md +2 -2
  58. package/docs/AnnouncementsApi.md +69 -20
  59. package/docs/AnnouncementsAudiencesApi.md +698 -0
  60. package/docs/AnnouncementsTemplatesApi.md +281 -0
  61. package/docs/AnnouncementsTemplatesTranslationsApi.md +240 -0
  62. package/docs/BaseAnnouncement.md +6 -8
  63. package/docs/BaseAnnouncementAudience.md +36 -0
  64. package/docs/CreateAnnouncementAudience200Response.md +24 -0
  65. package/docs/CreateAnnouncementAudienceCondition200Response.md +24 -0
  66. package/docs/CreateAnnouncementAudienceFilter200Response.md +24 -0
  67. package/docs/CreateAnnouncementTemplate200Response.md +24 -0
  68. package/docs/{GetAnnouncementAudience200Response.md → GetAnnouncementAudienceAccounts200Response.md} +3 -3
  69. package/docs/GetAnnouncementAudiences200Response.md +26 -0
  70. package/docs/GetAnnouncementMergeFields200Response.md +24 -0
  71. package/docs/GetAnnouncementTemplateTranslation200Response.md +24 -0
  72. package/docs/GetAnnouncementTemplateTranslations200Response.md +26 -0
  73. package/docs/GetAnnouncementTemplates200Response.md +26 -0
  74. package/docs/SendAnnouncementPreviewRequest.md +20 -0
  75. package/docs/UpdateAnnouncementTemplateTranslation200Response.md +24 -0
  76. package/package.json +1 -1
  77. package/docs/EventAnnouncementFilters.md +0 -30
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.23.1
7
+ * The version of the OpenAPI document: 12.0.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -125,6 +125,43 @@ export var AdvertisementType;
125
125
  AdvertisementType["Square"] = "square";
126
126
  AdvertisementType["Rectangle"] = "rectangle";
127
127
  })(AdvertisementType || (AdvertisementType = {}));
128
+ export var AnnouncementAudienceConditionComparator;
129
+ (function (AnnouncementAudienceConditionComparator) {
130
+ AnnouncementAudienceConditionComparator["Equals"] = "equals";
131
+ AnnouncementAudienceConditionComparator["Contains"] = "contains";
132
+ AnnouncementAudienceConditionComparator["IsSet"] = "isSet";
133
+ AnnouncementAudienceConditionComparator["NotSet"] = "notSet";
134
+ })(AnnouncementAudienceConditionComparator || (AnnouncementAudienceConditionComparator = {}));
135
+ export var AnnouncementAudienceConditionType;
136
+ (function (AnnouncementAudienceConditionType) {
137
+ AnnouncementAudienceConditionType["EventPass"] = "eventPass";
138
+ AnnouncementAudienceConditionType["EventPassType"] = "eventPassType";
139
+ AnnouncementAudienceConditionType["EventCheckedIn"] = "eventCheckedIn";
140
+ AnnouncementAudienceConditionType["EventAddOn"] = "eventAddOn";
141
+ AnnouncementAudienceConditionType["EventSessionAccess"] = "eventSessionAccess";
142
+ AnnouncementAudienceConditionType["EventSessionCheckedIn"] = "eventSessionCheckedIn";
143
+ AnnouncementAudienceConditionType["EventRoomType"] = "eventRoomType";
144
+ AnnouncementAudienceConditionType["EventQuestionChoice"] = "eventQuestionChoice";
145
+ AnnouncementAudienceConditionType["EventPassAttribute"] = "eventPassAttribute";
146
+ AnnouncementAudienceConditionType["Tier"] = "tier";
147
+ AnnouncementAudienceConditionType["Group"] = "group";
148
+ AnnouncementAudienceConditionType["Channel"] = "channel";
149
+ AnnouncementAudienceConditionType["SponsorshipLevel"] = "sponsorshipLevel";
150
+ AnnouncementAudienceConditionType["Series"] = "series";
151
+ AnnouncementAudienceConditionType["AccountAttribute"] = "accountAttribute";
152
+ AnnouncementAudienceConditionType["Verified"] = "verified";
153
+ AnnouncementAudienceConditionType["Account"] = "account";
154
+ })(AnnouncementAudienceConditionType || (AnnouncementAudienceConditionType = {}));
155
+ export var AnnouncementAudienceOperator;
156
+ (function (AnnouncementAudienceOperator) {
157
+ AnnouncementAudienceOperator["And"] = "AND";
158
+ AnnouncementAudienceOperator["Or"] = "OR";
159
+ })(AnnouncementAudienceOperator || (AnnouncementAudienceOperator = {}));
160
+ export var AnnouncementMergeFieldGroupEnum;
161
+ (function (AnnouncementMergeFieldGroupEnum) {
162
+ AnnouncementMergeFieldGroupEnum["Account"] = "Account";
163
+ AnnouncementMergeFieldGroupEnum["Attributes"] = "Attributes";
164
+ })(AnnouncementMergeFieldGroupEnum || (AnnouncementMergeFieldGroupEnum = {}));
128
165
  export var AuthLayout;
129
166
  (function (AuthLayout) {
130
167
  AuthLayout["Default"] = "default";
@@ -230,6 +267,22 @@ export var CreateAnnouncement200ResponseStatusEnum;
230
267
  (function (CreateAnnouncement200ResponseStatusEnum) {
231
268
  CreateAnnouncement200ResponseStatusEnum["Ok"] = "ok";
232
269
  })(CreateAnnouncement200ResponseStatusEnum || (CreateAnnouncement200ResponseStatusEnum = {}));
270
+ export var CreateAnnouncementAudience200ResponseStatusEnum;
271
+ (function (CreateAnnouncementAudience200ResponseStatusEnum) {
272
+ CreateAnnouncementAudience200ResponseStatusEnum["Ok"] = "ok";
273
+ })(CreateAnnouncementAudience200ResponseStatusEnum || (CreateAnnouncementAudience200ResponseStatusEnum = {}));
274
+ export var CreateAnnouncementAudienceCondition200ResponseStatusEnum;
275
+ (function (CreateAnnouncementAudienceCondition200ResponseStatusEnum) {
276
+ CreateAnnouncementAudienceCondition200ResponseStatusEnum["Ok"] = "ok";
277
+ })(CreateAnnouncementAudienceCondition200ResponseStatusEnum || (CreateAnnouncementAudienceCondition200ResponseStatusEnum = {}));
278
+ export var CreateAnnouncementAudienceFilter200ResponseStatusEnum;
279
+ (function (CreateAnnouncementAudienceFilter200ResponseStatusEnum) {
280
+ CreateAnnouncementAudienceFilter200ResponseStatusEnum["Ok"] = "ok";
281
+ })(CreateAnnouncementAudienceFilter200ResponseStatusEnum || (CreateAnnouncementAudienceFilter200ResponseStatusEnum = {}));
282
+ export var CreateAnnouncementTemplate200ResponseStatusEnum;
283
+ (function (CreateAnnouncementTemplate200ResponseStatusEnum) {
284
+ CreateAnnouncementTemplate200ResponseStatusEnum["Ok"] = "ok";
285
+ })(CreateAnnouncementTemplate200ResponseStatusEnum || (CreateAnnouncementTemplate200ResponseStatusEnum = {}));
233
286
  export var CreateBenefit200ResponseStatusEnum;
234
287
  (function (CreateBenefit200ResponseStatusEnum) {
235
288
  CreateBenefit200ResponseStatusEnum["Ok"] = "ok";
@@ -629,10 +682,6 @@ export var EventAgendaVisibility;
629
682
  EventAgendaVisibility["Registered"] = "registered";
630
683
  EventAgendaVisibility["Hidden"] = "hidden";
631
684
  })(EventAgendaVisibility || (EventAgendaVisibility = {}));
632
- export var EventAnnouncementFiltersTypeEnum;
633
- (function (EventAnnouncementFiltersTypeEnum) {
634
- EventAnnouncementFiltersTypeEnum["Event"] = "event";
635
- })(EventAnnouncementFiltersTypeEnum || (EventAnnouncementFiltersTypeEnum = {}));
636
685
  export var EventEmailType;
637
686
  (function (EventEmailType) {
638
687
  EventEmailType["Confirmation"] = "confirmation";
@@ -827,10 +876,30 @@ export var GetAllAccountMerges200ResponseStatusEnum;
827
876
  (function (GetAllAccountMerges200ResponseStatusEnum) {
828
877
  GetAllAccountMerges200ResponseStatusEnum["Ok"] = "ok";
829
878
  })(GetAllAccountMerges200ResponseStatusEnum || (GetAllAccountMerges200ResponseStatusEnum = {}));
830
- export var GetAnnouncementAudience200ResponseStatusEnum;
831
- (function (GetAnnouncementAudience200ResponseStatusEnum) {
832
- GetAnnouncementAudience200ResponseStatusEnum["Ok"] = "ok";
833
- })(GetAnnouncementAudience200ResponseStatusEnum || (GetAnnouncementAudience200ResponseStatusEnum = {}));
879
+ export var GetAnnouncementAudienceAccounts200ResponseStatusEnum;
880
+ (function (GetAnnouncementAudienceAccounts200ResponseStatusEnum) {
881
+ GetAnnouncementAudienceAccounts200ResponseStatusEnum["Ok"] = "ok";
882
+ })(GetAnnouncementAudienceAccounts200ResponseStatusEnum || (GetAnnouncementAudienceAccounts200ResponseStatusEnum = {}));
883
+ export var GetAnnouncementAudiences200ResponseStatusEnum;
884
+ (function (GetAnnouncementAudiences200ResponseStatusEnum) {
885
+ GetAnnouncementAudiences200ResponseStatusEnum["Ok"] = "ok";
886
+ })(GetAnnouncementAudiences200ResponseStatusEnum || (GetAnnouncementAudiences200ResponseStatusEnum = {}));
887
+ export var GetAnnouncementMergeFields200ResponseStatusEnum;
888
+ (function (GetAnnouncementMergeFields200ResponseStatusEnum) {
889
+ GetAnnouncementMergeFields200ResponseStatusEnum["Ok"] = "ok";
890
+ })(GetAnnouncementMergeFields200ResponseStatusEnum || (GetAnnouncementMergeFields200ResponseStatusEnum = {}));
891
+ export var GetAnnouncementTemplateTranslation200ResponseStatusEnum;
892
+ (function (GetAnnouncementTemplateTranslation200ResponseStatusEnum) {
893
+ GetAnnouncementTemplateTranslation200ResponseStatusEnum["Ok"] = "ok";
894
+ })(GetAnnouncementTemplateTranslation200ResponseStatusEnum || (GetAnnouncementTemplateTranslation200ResponseStatusEnum = {}));
895
+ export var GetAnnouncementTemplateTranslations200ResponseStatusEnum;
896
+ (function (GetAnnouncementTemplateTranslations200ResponseStatusEnum) {
897
+ GetAnnouncementTemplateTranslations200ResponseStatusEnum["Ok"] = "ok";
898
+ })(GetAnnouncementTemplateTranslations200ResponseStatusEnum || (GetAnnouncementTemplateTranslations200ResponseStatusEnum = {}));
899
+ export var GetAnnouncementTemplates200ResponseStatusEnum;
900
+ (function (GetAnnouncementTemplates200ResponseStatusEnum) {
901
+ GetAnnouncementTemplates200ResponseStatusEnum["Ok"] = "ok";
902
+ })(GetAnnouncementTemplates200ResponseStatusEnum || (GetAnnouncementTemplates200ResponseStatusEnum = {}));
834
903
  export var GetAnnouncementTranslation200ResponseStatusEnum;
835
904
  (function (GetAnnouncementTranslation200ResponseStatusEnum) {
836
905
  GetAnnouncementTranslation200ResponseStatusEnum["Ok"] = "ok";
@@ -2861,6 +2930,10 @@ export var ThreadType;
2861
2930
  ThreadType["Direct"] = "direct";
2862
2931
  ThreadType["Default"] = "default";
2863
2932
  })(ThreadType || (ThreadType = {}));
2933
+ export var UpdateAnnouncementTemplateTranslation200ResponseStatusEnum;
2934
+ (function (UpdateAnnouncementTemplateTranslation200ResponseStatusEnum) {
2935
+ UpdateAnnouncementTemplateTranslation200ResponseStatusEnum["Ok"] = "ok";
2936
+ })(UpdateAnnouncementTemplateTranslation200ResponseStatusEnum || (UpdateAnnouncementTemplateTranslation200ResponseStatusEnum = {}));
2864
2937
  export var UpdateBookingSpaceQuestionChoiceTranslation200ResponseStatusEnum;
2865
2938
  (function (UpdateBookingSpaceQuestionChoiceTranslation200ResponseStatusEnum) {
2866
2939
  UpdateBookingSpaceQuestionChoiceTranslation200ResponseStatusEnum["Ok"] = "ok";
@@ -9220,7 +9293,7 @@ export class AdvertisementsApi extends BaseAPI {
9220
9293
  export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9221
9294
  return {
9222
9295
  /**
9223
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
9296
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
9224
9297
  * @summary Create an announcement
9225
9298
  * @param {AnnouncementCreateInputs} announcementCreateInputs
9226
9299
  * @param {*} [options] Override http request option.
@@ -9323,9 +9396,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9323
9396
  };
9324
9397
  }),
9325
9398
  /**
9326
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
9327
- * @summary List an announcement\'s target audience
9399
+ * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
9400
+ * @summary List an announcement\'s email delivery receipts
9328
9401
  * @param {string} announcementId The announcement identifier
9402
+ * @param {EmailReceiptStatus} [status] Filter by status
9329
9403
  * @param {number} [page] Page number
9330
9404
  * @param {number} [pageSize] Number of items per page
9331
9405
  * @param {string} [orderBy] Field to order by
@@ -9333,10 +9407,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9333
9407
  * @param {*} [options] Override http request option.
9334
9408
  * @throws {RequiredError}
9335
9409
  */
9336
- getAnnouncementAudience: (announcementId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [announcementId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (announcementId, page, pageSize, orderBy, search, options = {}) {
9410
+ getAnnouncementEmailReceipts: (announcementId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [announcementId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (announcementId, status, page, pageSize, orderBy, search, options = {}) {
9337
9411
  // verify required parameter 'announcementId' is not null or undefined
9338
- assertParamExists('getAnnouncementAudience', 'announcementId', announcementId);
9339
- const localVarPath = `/announcements/{announcementId}/audience`
9412
+ assertParamExists('getAnnouncementEmailReceipts', 'announcementId', announcementId);
9413
+ const localVarPath = `/announcements/{announcementId}/email-receipts`
9340
9414
  .replace('{announcementId}', encodeURIComponent(String(announcementId)));
9341
9415
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9342
9416
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -9351,6 +9425,9 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9351
9425
  yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
9352
9426
  // authentication OrganizationId required
9353
9427
  yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
9428
+ if (status !== undefined) {
9429
+ localVarQueryParameter['status'] = status;
9430
+ }
9354
9431
  if (page !== undefined) {
9355
9432
  localVarQueryParameter['page'] = page;
9356
9433
  }
@@ -9373,10 +9450,39 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9373
9450
  };
9374
9451
  }),
9375
9452
  /**
9376
- * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
9377
- * @summary List an announcement\'s email delivery receipts
9453
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
9454
+ * @summary List announcement merge fields
9455
+ * @param {*} [options] Override http request option.
9456
+ * @throws {RequiredError}
9457
+ */
9458
+ getAnnouncementMergeFields: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
9459
+ const localVarPath = `/announcements/merge-fields`;
9460
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9461
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9462
+ let baseOptions;
9463
+ if (configuration) {
9464
+ baseOptions = configuration.baseOptions;
9465
+ }
9466
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
9467
+ const localVarHeaderParameter = {};
9468
+ const localVarQueryParameter = {};
9469
+ // authentication ApiKeyAuth required
9470
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
9471
+ // authentication OrganizationId required
9472
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
9473
+ localVarHeaderParameter['Accept'] = 'application/json';
9474
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9475
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9476
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9477
+ return {
9478
+ url: toPathString(localVarUrlObj),
9479
+ options: localVarRequestOptions,
9480
+ };
9481
+ }),
9482
+ /**
9483
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
9484
+ * @summary List an announcement\'s recipients
9378
9485
  * @param {string} announcementId The announcement identifier
9379
- * @param {EmailReceiptStatus} [status] Filter by status
9380
9486
  * @param {number} [page] Page number
9381
9487
  * @param {number} [pageSize] Number of items per page
9382
9488
  * @param {string} [orderBy] Field to order by
@@ -9384,10 +9490,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9384
9490
  * @param {*} [options] Override http request option.
9385
9491
  * @throws {RequiredError}
9386
9492
  */
9387
- getAnnouncementEmailReceipts: (announcementId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [announcementId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (announcementId, status, page, pageSize, orderBy, search, options = {}) {
9493
+ getAnnouncementRecipients: (announcementId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [announcementId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (announcementId, page, pageSize, orderBy, search, options = {}) {
9388
9494
  // verify required parameter 'announcementId' is not null or undefined
9389
- assertParamExists('getAnnouncementEmailReceipts', 'announcementId', announcementId);
9390
- const localVarPath = `/announcements/{announcementId}/email-receipts`
9495
+ assertParamExists('getAnnouncementRecipients', 'announcementId', announcementId);
9496
+ const localVarPath = `/announcements/{announcementId}/audience`
9391
9497
  .replace('{announcementId}', encodeURIComponent(String(announcementId)));
9392
9498
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9393
9499
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -9402,9 +9508,6 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9402
9508
  yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
9403
9509
  // authentication OrganizationId required
9404
9510
  yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
9405
- if (status !== undefined) {
9406
- localVarQueryParameter['status'] = status;
9407
- }
9408
9511
  if (page !== undefined) {
9409
9512
  localVarQueryParameter['page'] = page;
9410
9513
  }
@@ -9427,7 +9530,7 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9427
9530
  };
9428
9531
  }),
9429
9532
  /**
9430
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
9533
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
9431
9534
  * @summary List announcements
9432
9535
  * @param {AnnouncementFilters} [filters] Filter by filters
9433
9536
  * @param {number} [page] Page number
@@ -9479,13 +9582,14 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9479
9582
  };
9480
9583
  }),
9481
9584
  /**
9482
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
9585
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
9483
9586
  * @summary Send a preview of an announcement
9484
9587
  * @param {string} announcementId The announcement identifier
9588
+ * @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
9485
9589
  * @param {*} [options] Override http request option.
9486
9590
  * @throws {RequiredError}
9487
9591
  */
9488
- sendAnnouncementPreview: (announcementId_1, ...args_1) => __awaiter(this, [announcementId_1, ...args_1], void 0, function* (announcementId, options = {}) {
9592
+ sendAnnouncementPreview: (announcementId_1, sendAnnouncementPreviewRequest_1, ...args_1) => __awaiter(this, [announcementId_1, sendAnnouncementPreviewRequest_1, ...args_1], void 0, function* (announcementId, sendAnnouncementPreviewRequest, options = {}) {
9489
9593
  // verify required parameter 'announcementId' is not null or undefined
9490
9594
  assertParamExists('sendAnnouncementPreview', 'announcementId', announcementId);
9491
9595
  const localVarPath = `/announcements/{announcementId}/preview`
@@ -9503,10 +9607,12 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration) {
9503
9607
  yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
9504
9608
  // authentication OrganizationId required
9505
9609
  yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
9610
+ localVarHeaderParameter['Content-Type'] = 'application/json';
9506
9611
  localVarHeaderParameter['Accept'] = 'application/json';
9507
9612
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9508
9613
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9509
9614
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9615
+ localVarRequestOptions.data = serializeDataIfNeeded(sendAnnouncementPreviewRequest, localVarRequestOptions, configuration);
9510
9616
  return {
9511
9617
  url: toPathString(localVarUrlObj),
9512
9618
  options: localVarRequestOptions,
@@ -9560,7 +9666,7 @@ export const AnnouncementsApiFp = function (configuration) {
9560
9666
  const localVarAxiosParamCreator = AnnouncementsApiAxiosParamCreator(configuration);
9561
9667
  return {
9562
9668
  /**
9563
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
9669
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
9564
9670
  * @summary Create an announcement
9565
9671
  * @param {AnnouncementCreateInputs} announcementCreateInputs
9566
9672
  * @param {*} [options] Override http request option.
@@ -9608,9 +9714,10 @@ export const AnnouncementsApiFp = function (configuration) {
9608
9714
  });
9609
9715
  },
9610
9716
  /**
9611
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
9612
- * @summary List an announcement\'s target audience
9717
+ * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
9718
+ * @summary List an announcement\'s email delivery receipts
9613
9719
  * @param {string} announcementId The announcement identifier
9720
+ * @param {EmailReceiptStatus} [status] Filter by status
9614
9721
  * @param {number} [page] Page number
9615
9722
  * @param {number} [pageSize] Number of items per page
9616
9723
  * @param {string} [orderBy] Field to order by
@@ -9618,20 +9725,34 @@ export const AnnouncementsApiFp = function (configuration) {
9618
9725
  * @param {*} [options] Override http request option.
9619
9726
  * @throws {RequiredError}
9620
9727
  */
9621
- getAnnouncementAudience(announcementId, page, pageSize, orderBy, search, options) {
9728
+ getAnnouncementEmailReceipts(announcementId, status, page, pageSize, orderBy, search, options) {
9622
9729
  return __awaiter(this, void 0, void 0, function* () {
9623
9730
  var _a, _b, _c;
9624
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementAudience(announcementId, page, pageSize, orderBy, search, options);
9731
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementEmailReceipts(announcementId, status, page, pageSize, orderBy, search, options);
9625
9732
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
9626
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsApi.getAnnouncementAudience']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9733
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsApi.getAnnouncementEmailReceipts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9627
9734
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9628
9735
  });
9629
9736
  },
9630
9737
  /**
9631
- * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
9632
- * @summary List an announcement\'s email delivery receipts
9738
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
9739
+ * @summary List announcement merge fields
9740
+ * @param {*} [options] Override http request option.
9741
+ * @throws {RequiredError}
9742
+ */
9743
+ getAnnouncementMergeFields(options) {
9744
+ return __awaiter(this, void 0, void 0, function* () {
9745
+ var _a, _b, _c;
9746
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementMergeFields(options);
9747
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
9748
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsApi.getAnnouncementMergeFields']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9749
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9750
+ });
9751
+ },
9752
+ /**
9753
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
9754
+ * @summary List an announcement\'s recipients
9633
9755
  * @param {string} announcementId The announcement identifier
9634
- * @param {EmailReceiptStatus} [status] Filter by status
9635
9756
  * @param {number} [page] Page number
9636
9757
  * @param {number} [pageSize] Number of items per page
9637
9758
  * @param {string} [orderBy] Field to order by
@@ -9639,17 +9760,17 @@ export const AnnouncementsApiFp = function (configuration) {
9639
9760
  * @param {*} [options] Override http request option.
9640
9761
  * @throws {RequiredError}
9641
9762
  */
9642
- getAnnouncementEmailReceipts(announcementId, status, page, pageSize, orderBy, search, options) {
9763
+ getAnnouncementRecipients(announcementId, page, pageSize, orderBy, search, options) {
9643
9764
  return __awaiter(this, void 0, void 0, function* () {
9644
9765
  var _a, _b, _c;
9645
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementEmailReceipts(announcementId, status, page, pageSize, orderBy, search, options);
9766
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementRecipients(announcementId, page, pageSize, orderBy, search, options);
9646
9767
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
9647
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsApi.getAnnouncementEmailReceipts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9768
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsApi.getAnnouncementRecipients']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9648
9769
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9649
9770
  });
9650
9771
  },
9651
9772
  /**
9652
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
9773
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
9653
9774
  * @summary List announcements
9654
9775
  * @param {AnnouncementFilters} [filters] Filter by filters
9655
9776
  * @param {number} [page] Page number
@@ -9669,16 +9790,17 @@ export const AnnouncementsApiFp = function (configuration) {
9669
9790
  });
9670
9791
  },
9671
9792
  /**
9672
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
9793
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
9673
9794
  * @summary Send a preview of an announcement
9674
9795
  * @param {string} announcementId The announcement identifier
9796
+ * @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
9675
9797
  * @param {*} [options] Override http request option.
9676
9798
  * @throws {RequiredError}
9677
9799
  */
9678
- sendAnnouncementPreview(announcementId, options) {
9800
+ sendAnnouncementPreview(announcementId, sendAnnouncementPreviewRequest, options) {
9679
9801
  return __awaiter(this, void 0, void 0, function* () {
9680
9802
  var _a, _b, _c;
9681
- const localVarAxiosArgs = yield localVarAxiosParamCreator.sendAnnouncementPreview(announcementId, options);
9803
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.sendAnnouncementPreview(announcementId, sendAnnouncementPreviewRequest, options);
9682
9804
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
9683
9805
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsApi.sendAnnouncementPreview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9684
9806
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -9710,7 +9832,7 @@ export const AnnouncementsApiFactory = function (configuration, basePath, axios)
9710
9832
  const localVarFp = AnnouncementsApiFp(configuration);
9711
9833
  return {
9712
9834
  /**
9713
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
9835
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
9714
9836
  * @summary Create an announcement
9715
9837
  * @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
9716
9838
  * @param {*} [options] Override http request option.
@@ -9739,16 +9861,6 @@ export const AnnouncementsApiFactory = function (configuration, basePath, axios)
9739
9861
  getAnnouncement(requestParameters, options) {
9740
9862
  return localVarFp.getAnnouncement(requestParameters.announcementId, options).then((request) => request(axios, basePath));
9741
9863
  },
9742
- /**
9743
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
9744
- * @summary List an announcement\'s target audience
9745
- * @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
9746
- * @param {*} [options] Override http request option.
9747
- * @throws {RequiredError}
9748
- */
9749
- getAnnouncementAudience(requestParameters, options) {
9750
- return localVarFp.getAnnouncementAudience(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
9751
- },
9752
9864
  /**
9753
9865
  * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
9754
9866
  * @summary List an announcement\'s email delivery receipts
@@ -9760,7 +9872,26 @@ export const AnnouncementsApiFactory = function (configuration, basePath, axios)
9760
9872
  return localVarFp.getAnnouncementEmailReceipts(requestParameters.announcementId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
9761
9873
  },
9762
9874
  /**
9763
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
9875
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
9876
+ * @summary List announcement merge fields
9877
+ * @param {*} [options] Override http request option.
9878
+ * @throws {RequiredError}
9879
+ */
9880
+ getAnnouncementMergeFields(options) {
9881
+ return localVarFp.getAnnouncementMergeFields(options).then((request) => request(axios, basePath));
9882
+ },
9883
+ /**
9884
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
9885
+ * @summary List an announcement\'s recipients
9886
+ * @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
9887
+ * @param {*} [options] Override http request option.
9888
+ * @throws {RequiredError}
9889
+ */
9890
+ getAnnouncementRecipients(requestParameters, options) {
9891
+ return localVarFp.getAnnouncementRecipients(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
9892
+ },
9893
+ /**
9894
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
9764
9895
  * @summary List announcements
9765
9896
  * @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
9766
9897
  * @param {*} [options] Override http request option.
@@ -9770,14 +9901,14 @@ export const AnnouncementsApiFactory = function (configuration, basePath, axios)
9770
9901
  return localVarFp.getAnnouncements(requestParameters.filters, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
9771
9902
  },
9772
9903
  /**
9773
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
9904
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
9774
9905
  * @summary Send a preview of an announcement
9775
9906
  * @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
9776
9907
  * @param {*} [options] Override http request option.
9777
9908
  * @throws {RequiredError}
9778
9909
  */
9779
9910
  sendAnnouncementPreview(requestParameters, options) {
9780
- return localVarFp.sendAnnouncementPreview(requestParameters.announcementId, options).then((request) => request(axios, basePath));
9911
+ return localVarFp.sendAnnouncementPreview(requestParameters.announcementId, requestParameters.sendAnnouncementPreviewRequest, options).then((request) => request(axios, basePath));
9781
9912
  },
9782
9913
  /**
9783
9914
  * Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
@@ -9796,7 +9927,7 @@ export const AnnouncementsApiFactory = function (configuration, basePath, axios)
9796
9927
  */
9797
9928
  export class AnnouncementsApi extends BaseAPI {
9798
9929
  /**
9799
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
9930
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
9800
9931
  * @summary Create an announcement
9801
9932
  * @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
9802
9933
  * @param {*} [options] Override http request option.
@@ -9825,16 +9956,6 @@ export class AnnouncementsApi extends BaseAPI {
9825
9956
  getAnnouncement(requestParameters, options) {
9826
9957
  return AnnouncementsApiFp(this.configuration).getAnnouncement(requestParameters.announcementId, options).then((request) => request(this.axios, this.basePath));
9827
9958
  }
9828
- /**
9829
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
9830
- * @summary List an announcement\'s target audience
9831
- * @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
9832
- * @param {*} [options] Override http request option.
9833
- * @throws {RequiredError}
9834
- */
9835
- getAnnouncementAudience(requestParameters, options) {
9836
- return AnnouncementsApiFp(this.configuration).getAnnouncementAudience(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
9837
- }
9838
9959
  /**
9839
9960
  * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
9840
9961
  * @summary List an announcement\'s email delivery receipts
@@ -9846,7 +9967,26 @@ export class AnnouncementsApi extends BaseAPI {
9846
9967
  return AnnouncementsApiFp(this.configuration).getAnnouncementEmailReceipts(requestParameters.announcementId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
9847
9968
  }
9848
9969
  /**
9849
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
9970
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
9971
+ * @summary List announcement merge fields
9972
+ * @param {*} [options] Override http request option.
9973
+ * @throws {RequiredError}
9974
+ */
9975
+ getAnnouncementMergeFields(options) {
9976
+ return AnnouncementsApiFp(this.configuration).getAnnouncementMergeFields(options).then((request) => request(this.axios, this.basePath));
9977
+ }
9978
+ /**
9979
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
9980
+ * @summary List an announcement\'s recipients
9981
+ * @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
9982
+ * @param {*} [options] Override http request option.
9983
+ * @throws {RequiredError}
9984
+ */
9985
+ getAnnouncementRecipients(requestParameters, options) {
9986
+ return AnnouncementsApiFp(this.configuration).getAnnouncementRecipients(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
9987
+ }
9988
+ /**
9989
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
9850
9990
  * @summary List announcements
9851
9991
  * @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
9852
9992
  * @param {*} [options] Override http request option.
@@ -9856,14 +9996,14 @@ export class AnnouncementsApi extends BaseAPI {
9856
9996
  return AnnouncementsApiFp(this.configuration).getAnnouncements(requestParameters.filters, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
9857
9997
  }
9858
9998
  /**
9859
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
9999
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
9860
10000
  * @summary Send a preview of an announcement
9861
10001
  * @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
9862
10002
  * @param {*} [options] Override http request option.
9863
10003
  * @throws {RequiredError}
9864
10004
  */
9865
10005
  sendAnnouncementPreview(requestParameters, options) {
9866
- return AnnouncementsApiFp(this.configuration).sendAnnouncementPreview(requestParameters.announcementId, options).then((request) => request(this.axios, this.basePath));
10006
+ return AnnouncementsApiFp(this.configuration).sendAnnouncementPreview(requestParameters.announcementId, requestParameters.sendAnnouncementPreviewRequest, options).then((request) => request(this.axios, this.basePath));
9867
10007
  }
9868
10008
  /**
9869
10009
  * Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
@@ -9877,66 +10017,71 @@ export class AnnouncementsApi extends BaseAPI {
9877
10017
  }
9878
10018
  }
9879
10019
  /**
9880
- * AnnouncementsScheduleApi - axios parameter creator
10020
+ * AnnouncementsAudiencesApi - axios parameter creator
9881
10021
  */
9882
- export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration) {
10022
+ export const AnnouncementsAudiencesApiAxiosParamCreator = function (configuration) {
9883
10023
  return {
9884
10024
  /**
9885
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
9886
- * @summary Cancel an announcement\'s scheduled send
9887
- * @param {string} announcementId The announcement identifier
10025
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
10026
+ * @summary Create an announcement audience
10027
+ * @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
9888
10028
  * @param {*} [options] Override http request option.
9889
10029
  * @throws {RequiredError}
9890
10030
  */
9891
- cancelAnnouncementSchedule: (announcementId_1, ...args_1) => __awaiter(this, [announcementId_1, ...args_1], void 0, function* (announcementId, options = {}) {
9892
- // verify required parameter 'announcementId' is not null or undefined
9893
- assertParamExists('cancelAnnouncementSchedule', 'announcementId', announcementId);
9894
- const localVarPath = `/announcements/{announcementId}/schedule`
9895
- .replace('{announcementId}', encodeURIComponent(String(announcementId)));
10031
+ createAnnouncementAudience: (announcementAudienceCreateInputs_1, ...args_1) => __awaiter(this, [announcementAudienceCreateInputs_1, ...args_1], void 0, function* (announcementAudienceCreateInputs, options = {}) {
10032
+ // verify required parameter 'announcementAudienceCreateInputs' is not null or undefined
10033
+ assertParamExists('createAnnouncementAudience', 'announcementAudienceCreateInputs', announcementAudienceCreateInputs);
10034
+ const localVarPath = `/announcements/audiences`;
9896
10035
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9897
10036
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9898
10037
  let baseOptions;
9899
10038
  if (configuration) {
9900
10039
  baseOptions = configuration.baseOptions;
9901
10040
  }
9902
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
10041
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
9903
10042
  const localVarHeaderParameter = {};
9904
10043
  const localVarQueryParameter = {};
9905
10044
  // authentication ApiKeyAuth required
9906
10045
  yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
9907
10046
  // authentication OrganizationId required
9908
10047
  yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10048
+ localVarHeaderParameter['Content-Type'] = 'application/json';
9909
10049
  localVarHeaderParameter['Accept'] = 'application/json';
9910
10050
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9911
10051
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9912
10052
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10053
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceCreateInputs, localVarRequestOptions, configuration);
9913
10054
  return {
9914
10055
  url: toPathString(localVarUrlObj),
9915
10056
  options: localVarRequestOptions,
9916
10057
  };
9917
10058
  }),
9918
10059
  /**
9919
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
9920
- * @summary Schedule or reschedule an announcement send
9921
- * @param {string} announcementId The announcement identifier
9922
- * @param {object} body
10060
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
10061
+ * @summary Create an audience condition
10062
+ * @param {string} audienceId The audience identifier
10063
+ * @param {string} filterId The filter identifier
10064
+ * @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
9923
10065
  * @param {*} [options] Override http request option.
9924
10066
  * @throws {RequiredError}
9925
10067
  */
9926
- updateAnnouncementSchedule: (announcementId_1, body_1, ...args_1) => __awaiter(this, [announcementId_1, body_1, ...args_1], void 0, function* (announcementId, body, options = {}) {
9927
- // verify required parameter 'announcementId' is not null or undefined
9928
- assertParamExists('updateAnnouncementSchedule', 'announcementId', announcementId);
9929
- // verify required parameter 'body' is not null or undefined
9930
- assertParamExists('updateAnnouncementSchedule', 'body', body);
9931
- const localVarPath = `/announcements/{announcementId}/schedule`
9932
- .replace('{announcementId}', encodeURIComponent(String(announcementId)));
10068
+ createAnnouncementAudienceCondition: (audienceId_1, filterId_1, announcementAudienceConditionCreateInputs_1, ...args_1) => __awaiter(this, [audienceId_1, filterId_1, announcementAudienceConditionCreateInputs_1, ...args_1], void 0, function* (audienceId, filterId, announcementAudienceConditionCreateInputs, options = {}) {
10069
+ // verify required parameter 'audienceId' is not null or undefined
10070
+ assertParamExists('createAnnouncementAudienceCondition', 'audienceId', audienceId);
10071
+ // verify required parameter 'filterId' is not null or undefined
10072
+ assertParamExists('createAnnouncementAudienceCondition', 'filterId', filterId);
10073
+ // verify required parameter 'announcementAudienceConditionCreateInputs' is not null or undefined
10074
+ assertParamExists('createAnnouncementAudienceCondition', 'announcementAudienceConditionCreateInputs', announcementAudienceConditionCreateInputs);
10075
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}/conditions`
10076
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
10077
+ .replace('{filterId}', encodeURIComponent(String(filterId)));
9933
10078
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9934
10079
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9935
10080
  let baseOptions;
9936
10081
  if (configuration) {
9937
10082
  baseOptions = configuration.baseOptions;
9938
10083
  }
9939
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
10084
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
9940
10085
  const localVarHeaderParameter = {};
9941
10086
  const localVarQueryParameter = {};
9942
10087
  // authentication ApiKeyAuth required
@@ -9948,106 +10093,1826 @@ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration
9948
10093
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9949
10094
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9950
10095
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9951
- localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
10096
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceConditionCreateInputs, localVarRequestOptions, configuration);
9952
10097
  return {
9953
10098
  url: toPathString(localVarUrlObj),
9954
10099
  options: localVarRequestOptions,
9955
10100
  };
9956
10101
  }),
9957
- };
9958
- };
9959
- /**
9960
- * AnnouncementsScheduleApi - functional programming interface
9961
- */
9962
- export const AnnouncementsScheduleApiFp = function (configuration) {
9963
- const localVarAxiosParamCreator = AnnouncementsScheduleApiAxiosParamCreator(configuration);
9964
- return {
9965
10102
  /**
9966
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
9967
- * @summary Cancel an announcement\'s scheduled send
9968
- * @param {string} announcementId The announcement identifier
10103
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
10104
+ * @summary Create an audience filter group
10105
+ * @param {string} audienceId The audience identifier
10106
+ * @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
9969
10107
  * @param {*} [options] Override http request option.
9970
10108
  * @throws {RequiredError}
9971
10109
  */
9972
- cancelAnnouncementSchedule(announcementId, options) {
9973
- return __awaiter(this, void 0, void 0, function* () {
9974
- var _a, _b, _c;
9975
- const localVarAxiosArgs = yield localVarAxiosParamCreator.cancelAnnouncementSchedule(announcementId, options);
9976
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
9977
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsScheduleApi.cancelAnnouncementSchedule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9978
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9979
- });
9980
- },
10110
+ createAnnouncementAudienceFilter: (audienceId_1, announcementAudienceFilterCreateInputs_1, ...args_1) => __awaiter(this, [audienceId_1, announcementAudienceFilterCreateInputs_1, ...args_1], void 0, function* (audienceId, announcementAudienceFilterCreateInputs, options = {}) {
10111
+ // verify required parameter 'audienceId' is not null or undefined
10112
+ assertParamExists('createAnnouncementAudienceFilter', 'audienceId', audienceId);
10113
+ // verify required parameter 'announcementAudienceFilterCreateInputs' is not null or undefined
10114
+ assertParamExists('createAnnouncementAudienceFilter', 'announcementAudienceFilterCreateInputs', announcementAudienceFilterCreateInputs);
10115
+ const localVarPath = `/announcements/audiences/{audienceId}/filters`
10116
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
10117
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10118
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10119
+ let baseOptions;
10120
+ if (configuration) {
10121
+ baseOptions = configuration.baseOptions;
10122
+ }
10123
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
10124
+ const localVarHeaderParameter = {};
10125
+ const localVarQueryParameter = {};
10126
+ // authentication ApiKeyAuth required
10127
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10128
+ // authentication OrganizationId required
10129
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10130
+ localVarHeaderParameter['Content-Type'] = 'application/json';
10131
+ localVarHeaderParameter['Accept'] = 'application/json';
10132
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10133
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10134
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10135
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceFilterCreateInputs, localVarRequestOptions, configuration);
10136
+ return {
10137
+ url: toPathString(localVarUrlObj),
10138
+ options: localVarRequestOptions,
10139
+ };
10140
+ }),
9981
10141
  /**
9982
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
9983
- * @summary Schedule or reschedule an announcement send
9984
- * @param {string} announcementId The announcement identifier
9985
- * @param {object} body
10142
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
10143
+ * @summary Delete an announcement audience
10144
+ * @param {string} audienceId The audience identifier
9986
10145
  * @param {*} [options] Override http request option.
9987
10146
  * @throws {RequiredError}
9988
10147
  */
9989
- updateAnnouncementSchedule(announcementId, body, options) {
9990
- return __awaiter(this, void 0, void 0, function* () {
9991
- var _a, _b, _c;
9992
- const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAnnouncementSchedule(announcementId, body, options);
9993
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
9994
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsScheduleApi.updateAnnouncementSchedule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9995
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9996
- });
9997
- },
9998
- };
9999
- };
10000
- /**
10001
- * AnnouncementsScheduleApi - factory interface
10002
- */
10003
- export const AnnouncementsScheduleApiFactory = function (configuration, basePath, axios) {
10004
- const localVarFp = AnnouncementsScheduleApiFp(configuration);
10005
- return {
10148
+ deleteAnnouncementAudience: (audienceId_1, ...args_1) => __awaiter(this, [audienceId_1, ...args_1], void 0, function* (audienceId, options = {}) {
10149
+ // verify required parameter 'audienceId' is not null or undefined
10150
+ assertParamExists('deleteAnnouncementAudience', 'audienceId', audienceId);
10151
+ const localVarPath = `/announcements/audiences/{audienceId}`
10152
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
10153
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10154
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10155
+ let baseOptions;
10156
+ if (configuration) {
10157
+ baseOptions = configuration.baseOptions;
10158
+ }
10159
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
10160
+ const localVarHeaderParameter = {};
10161
+ const localVarQueryParameter = {};
10162
+ // authentication ApiKeyAuth required
10163
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10164
+ // authentication OrganizationId required
10165
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10166
+ localVarHeaderParameter['Accept'] = 'application/json';
10167
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10168
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10169
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10170
+ return {
10171
+ url: toPathString(localVarUrlObj),
10172
+ options: localVarRequestOptions,
10173
+ };
10174
+ }),
10006
10175
  /**
10007
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
10008
- * @summary Cancel an announcement\'s scheduled send
10009
- * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
10176
+ * Removes a condition from its filter group; requires update permission on announcements.
10177
+ * @summary Delete an audience condition
10178
+ * @param {string} audienceId The audience identifier
10179
+ * @param {string} filterId The filter identifier
10180
+ * @param {string} conditionId The condition identifier
10010
10181
  * @param {*} [options] Override http request option.
10011
10182
  * @throws {RequiredError}
10012
10183
  */
10013
- cancelAnnouncementSchedule(requestParameters, options) {
10014
- return localVarFp.cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(axios, basePath));
10015
- },
10184
+ deleteAnnouncementAudienceCondition: (audienceId_1, filterId_1, conditionId_1, ...args_1) => __awaiter(this, [audienceId_1, filterId_1, conditionId_1, ...args_1], void 0, function* (audienceId, filterId, conditionId, options = {}) {
10185
+ // verify required parameter 'audienceId' is not null or undefined
10186
+ assertParamExists('deleteAnnouncementAudienceCondition', 'audienceId', audienceId);
10187
+ // verify required parameter 'filterId' is not null or undefined
10188
+ assertParamExists('deleteAnnouncementAudienceCondition', 'filterId', filterId);
10189
+ // verify required parameter 'conditionId' is not null or undefined
10190
+ assertParamExists('deleteAnnouncementAudienceCondition', 'conditionId', conditionId);
10191
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}/conditions/{conditionId}`
10192
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
10193
+ .replace('{filterId}', encodeURIComponent(String(filterId)))
10194
+ .replace('{conditionId}', encodeURIComponent(String(conditionId)));
10195
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10196
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10197
+ let baseOptions;
10198
+ if (configuration) {
10199
+ baseOptions = configuration.baseOptions;
10200
+ }
10201
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
10202
+ const localVarHeaderParameter = {};
10203
+ const localVarQueryParameter = {};
10204
+ // authentication ApiKeyAuth required
10205
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10206
+ // authentication OrganizationId required
10207
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10208
+ localVarHeaderParameter['Accept'] = 'application/json';
10209
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10210
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10211
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10212
+ return {
10213
+ url: toPathString(localVarUrlObj),
10214
+ options: localVarRequestOptions,
10215
+ };
10216
+ }),
10016
10217
  /**
10017
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
10018
- * @summary Schedule or reschedule an announcement send
10019
- * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
10218
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
10219
+ * @summary Delete an audience filter group
10220
+ * @param {string} audienceId The audience identifier
10221
+ * @param {string} filterId The filter identifier
10020
10222
  * @param {*} [options] Override http request option.
10021
10223
  * @throws {RequiredError}
10022
10224
  */
10023
- updateAnnouncementSchedule(requestParameters, options) {
10024
- return localVarFp.updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(axios, basePath));
10025
- },
10026
- };
10027
- };
10028
- /**
10029
- * AnnouncementsScheduleApi - object-oriented interface
10030
- */
10031
- export class AnnouncementsScheduleApi extends BaseAPI {
10032
- /**
10033
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
10225
+ deleteAnnouncementAudienceFilter: (audienceId_1, filterId_1, ...args_1) => __awaiter(this, [audienceId_1, filterId_1, ...args_1], void 0, function* (audienceId, filterId, options = {}) {
10226
+ // verify required parameter 'audienceId' is not null or undefined
10227
+ assertParamExists('deleteAnnouncementAudienceFilter', 'audienceId', audienceId);
10228
+ // verify required parameter 'filterId' is not null or undefined
10229
+ assertParamExists('deleteAnnouncementAudienceFilter', 'filterId', filterId);
10230
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}`
10231
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
10232
+ .replace('{filterId}', encodeURIComponent(String(filterId)));
10233
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10234
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10235
+ let baseOptions;
10236
+ if (configuration) {
10237
+ baseOptions = configuration.baseOptions;
10238
+ }
10239
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
10240
+ const localVarHeaderParameter = {};
10241
+ const localVarQueryParameter = {};
10242
+ // authentication ApiKeyAuth required
10243
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10244
+ // authentication OrganizationId required
10245
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10246
+ localVarHeaderParameter['Accept'] = 'application/json';
10247
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10248
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10249
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10250
+ return {
10251
+ url: toPathString(localVarUrlObj),
10252
+ options: localVarRequestOptions,
10253
+ };
10254
+ }),
10255
+ /**
10256
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
10257
+ * @summary Get an announcement audience
10258
+ * @param {string} audienceId The audience identifier
10259
+ * @param {*} [options] Override http request option.
10260
+ * @throws {RequiredError}
10261
+ */
10262
+ getAnnouncementAudience: (audienceId_1, ...args_1) => __awaiter(this, [audienceId_1, ...args_1], void 0, function* (audienceId, options = {}) {
10263
+ // verify required parameter 'audienceId' is not null or undefined
10264
+ assertParamExists('getAnnouncementAudience', 'audienceId', audienceId);
10265
+ const localVarPath = `/announcements/audiences/{audienceId}`
10266
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
10267
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10268
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10269
+ let baseOptions;
10270
+ if (configuration) {
10271
+ baseOptions = configuration.baseOptions;
10272
+ }
10273
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
10274
+ const localVarHeaderParameter = {};
10275
+ const localVarQueryParameter = {};
10276
+ // authentication ApiKeyAuth required
10277
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10278
+ // authentication OrganizationId required
10279
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10280
+ localVarHeaderParameter['Accept'] = 'application/json';
10281
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10282
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10283
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10284
+ return {
10285
+ url: toPathString(localVarUrlObj),
10286
+ options: localVarRequestOptions,
10287
+ };
10288
+ }),
10289
+ /**
10290
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
10291
+ * @summary List the accounts in an announcement audience
10292
+ * @param {string} audienceId The audience identifier
10293
+ * @param {number} [page] Page number
10294
+ * @param {number} [pageSize] Number of items per page
10295
+ * @param {string} [orderBy] Field to order by
10296
+ * @param {string} [search] Search query
10297
+ * @param {*} [options] Override http request option.
10298
+ * @throws {RequiredError}
10299
+ */
10300
+ getAnnouncementAudienceAccounts: (audienceId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [audienceId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (audienceId, page, pageSize, orderBy, search, options = {}) {
10301
+ // verify required parameter 'audienceId' is not null or undefined
10302
+ assertParamExists('getAnnouncementAudienceAccounts', 'audienceId', audienceId);
10303
+ const localVarPath = `/announcements/audiences/{audienceId}/accounts`
10304
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
10305
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10306
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10307
+ let baseOptions;
10308
+ if (configuration) {
10309
+ baseOptions = configuration.baseOptions;
10310
+ }
10311
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
10312
+ const localVarHeaderParameter = {};
10313
+ const localVarQueryParameter = {};
10314
+ // authentication ApiKeyAuth required
10315
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10316
+ // authentication OrganizationId required
10317
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10318
+ if (page !== undefined) {
10319
+ localVarQueryParameter['page'] = page;
10320
+ }
10321
+ if (pageSize !== undefined) {
10322
+ localVarQueryParameter['pageSize'] = pageSize;
10323
+ }
10324
+ if (orderBy !== undefined) {
10325
+ localVarQueryParameter['orderBy'] = orderBy;
10326
+ }
10327
+ if (search !== undefined) {
10328
+ localVarQueryParameter['search'] = search;
10329
+ }
10330
+ localVarHeaderParameter['Accept'] = 'application/json';
10331
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10332
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10333
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10334
+ return {
10335
+ url: toPathString(localVarUrlObj),
10336
+ options: localVarRequestOptions,
10337
+ };
10338
+ }),
10339
+ /**
10340
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
10341
+ * @summary List announcement audiences
10342
+ * @param {AnnouncementAudienceScope} [scope] Filter by scope
10343
+ * @param {number} [page] Page number
10344
+ * @param {number} [pageSize] Number of items per page
10345
+ * @param {string} [orderBy] Field to order by
10346
+ * @param {string} [search] Search query
10347
+ * @param {*} [options] Override http request option.
10348
+ * @throws {RequiredError}
10349
+ */
10350
+ getAnnouncementAudiences: (scope_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [scope_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (scope, page, pageSize, orderBy, search, options = {}) {
10351
+ const localVarPath = `/announcements/audiences`;
10352
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10353
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10354
+ let baseOptions;
10355
+ if (configuration) {
10356
+ baseOptions = configuration.baseOptions;
10357
+ }
10358
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
10359
+ const localVarHeaderParameter = {};
10360
+ const localVarQueryParameter = {};
10361
+ // authentication ApiKeyAuth required
10362
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10363
+ // authentication OrganizationId required
10364
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10365
+ if (scope !== undefined) {
10366
+ for (const [key, value] of Object.entries(scope)) {
10367
+ localVarQueryParameter[key] = value;
10368
+ }
10369
+ }
10370
+ if (page !== undefined) {
10371
+ localVarQueryParameter['page'] = page;
10372
+ }
10373
+ if (pageSize !== undefined) {
10374
+ localVarQueryParameter['pageSize'] = pageSize;
10375
+ }
10376
+ if (orderBy !== undefined) {
10377
+ localVarQueryParameter['orderBy'] = orderBy;
10378
+ }
10379
+ if (search !== undefined) {
10380
+ localVarQueryParameter['search'] = search;
10381
+ }
10382
+ localVarHeaderParameter['Accept'] = 'application/json';
10383
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10384
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10385
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10386
+ return {
10387
+ url: toPathString(localVarUrlObj),
10388
+ options: localVarRequestOptions,
10389
+ };
10390
+ }),
10391
+ /**
10392
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
10393
+ * @summary Update an announcement audience
10394
+ * @param {string} audienceId The audience identifier
10395
+ * @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
10396
+ * @param {*} [options] Override http request option.
10397
+ * @throws {RequiredError}
10398
+ */
10399
+ updateAnnouncementAudience: (audienceId_1, announcementAudienceUpdateInputs_1, ...args_1) => __awaiter(this, [audienceId_1, announcementAudienceUpdateInputs_1, ...args_1], void 0, function* (audienceId, announcementAudienceUpdateInputs, options = {}) {
10400
+ // verify required parameter 'audienceId' is not null or undefined
10401
+ assertParamExists('updateAnnouncementAudience', 'audienceId', audienceId);
10402
+ // verify required parameter 'announcementAudienceUpdateInputs' is not null or undefined
10403
+ assertParamExists('updateAnnouncementAudience', 'announcementAudienceUpdateInputs', announcementAudienceUpdateInputs);
10404
+ const localVarPath = `/announcements/audiences/{audienceId}`
10405
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
10406
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10407
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10408
+ let baseOptions;
10409
+ if (configuration) {
10410
+ baseOptions = configuration.baseOptions;
10411
+ }
10412
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
10413
+ const localVarHeaderParameter = {};
10414
+ const localVarQueryParameter = {};
10415
+ // authentication ApiKeyAuth required
10416
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10417
+ // authentication OrganizationId required
10418
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10419
+ localVarHeaderParameter['Content-Type'] = 'application/json';
10420
+ localVarHeaderParameter['Accept'] = 'application/json';
10421
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10422
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10423
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10424
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceUpdateInputs, localVarRequestOptions, configuration);
10425
+ return {
10426
+ url: toPathString(localVarUrlObj),
10427
+ options: localVarRequestOptions,
10428
+ };
10429
+ }),
10430
+ /**
10431
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
10432
+ * @summary Update an audience condition
10433
+ * @param {string} audienceId The audience identifier
10434
+ * @param {string} filterId The filter identifier
10435
+ * @param {string} conditionId The condition identifier
10436
+ * @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
10437
+ * @param {*} [options] Override http request option.
10438
+ * @throws {RequiredError}
10439
+ */
10440
+ updateAnnouncementAudienceCondition: (audienceId_1, filterId_1, conditionId_1, announcementAudienceConditionUpdateInputs_1, ...args_1) => __awaiter(this, [audienceId_1, filterId_1, conditionId_1, announcementAudienceConditionUpdateInputs_1, ...args_1], void 0, function* (audienceId, filterId, conditionId, announcementAudienceConditionUpdateInputs, options = {}) {
10441
+ // verify required parameter 'audienceId' is not null or undefined
10442
+ assertParamExists('updateAnnouncementAudienceCondition', 'audienceId', audienceId);
10443
+ // verify required parameter 'filterId' is not null or undefined
10444
+ assertParamExists('updateAnnouncementAudienceCondition', 'filterId', filterId);
10445
+ // verify required parameter 'conditionId' is not null or undefined
10446
+ assertParamExists('updateAnnouncementAudienceCondition', 'conditionId', conditionId);
10447
+ // verify required parameter 'announcementAudienceConditionUpdateInputs' is not null or undefined
10448
+ assertParamExists('updateAnnouncementAudienceCondition', 'announcementAudienceConditionUpdateInputs', announcementAudienceConditionUpdateInputs);
10449
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}/conditions/{conditionId}`
10450
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
10451
+ .replace('{filterId}', encodeURIComponent(String(filterId)))
10452
+ .replace('{conditionId}', encodeURIComponent(String(conditionId)));
10453
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10454
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10455
+ let baseOptions;
10456
+ if (configuration) {
10457
+ baseOptions = configuration.baseOptions;
10458
+ }
10459
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
10460
+ const localVarHeaderParameter = {};
10461
+ const localVarQueryParameter = {};
10462
+ // authentication ApiKeyAuth required
10463
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10464
+ // authentication OrganizationId required
10465
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10466
+ localVarHeaderParameter['Content-Type'] = 'application/json';
10467
+ localVarHeaderParameter['Accept'] = 'application/json';
10468
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10469
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10470
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10471
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceConditionUpdateInputs, localVarRequestOptions, configuration);
10472
+ return {
10473
+ url: toPathString(localVarUrlObj),
10474
+ options: localVarRequestOptions,
10475
+ };
10476
+ }),
10477
+ /**
10478
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
10479
+ * @summary Update an audience filter group
10480
+ * @param {string} audienceId The audience identifier
10481
+ * @param {string} filterId The filter identifier
10482
+ * @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
10483
+ * @param {*} [options] Override http request option.
10484
+ * @throws {RequiredError}
10485
+ */
10486
+ updateAnnouncementAudienceFilter: (audienceId_1, filterId_1, announcementAudienceFilterUpdateInputs_1, ...args_1) => __awaiter(this, [audienceId_1, filterId_1, announcementAudienceFilterUpdateInputs_1, ...args_1], void 0, function* (audienceId, filterId, announcementAudienceFilterUpdateInputs, options = {}) {
10487
+ // verify required parameter 'audienceId' is not null or undefined
10488
+ assertParamExists('updateAnnouncementAudienceFilter', 'audienceId', audienceId);
10489
+ // verify required parameter 'filterId' is not null or undefined
10490
+ assertParamExists('updateAnnouncementAudienceFilter', 'filterId', filterId);
10491
+ // verify required parameter 'announcementAudienceFilterUpdateInputs' is not null or undefined
10492
+ assertParamExists('updateAnnouncementAudienceFilter', 'announcementAudienceFilterUpdateInputs', announcementAudienceFilterUpdateInputs);
10493
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}`
10494
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
10495
+ .replace('{filterId}', encodeURIComponent(String(filterId)));
10496
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10497
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10498
+ let baseOptions;
10499
+ if (configuration) {
10500
+ baseOptions = configuration.baseOptions;
10501
+ }
10502
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
10503
+ const localVarHeaderParameter = {};
10504
+ const localVarQueryParameter = {};
10505
+ // authentication ApiKeyAuth required
10506
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
10507
+ // authentication OrganizationId required
10508
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
10509
+ localVarHeaderParameter['Content-Type'] = 'application/json';
10510
+ localVarHeaderParameter['Accept'] = 'application/json';
10511
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10512
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10513
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
10514
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceFilterUpdateInputs, localVarRequestOptions, configuration);
10515
+ return {
10516
+ url: toPathString(localVarUrlObj),
10517
+ options: localVarRequestOptions,
10518
+ };
10519
+ }),
10520
+ };
10521
+ };
10522
+ /**
10523
+ * AnnouncementsAudiencesApi - functional programming interface
10524
+ */
10525
+ export const AnnouncementsAudiencesApiFp = function (configuration) {
10526
+ const localVarAxiosParamCreator = AnnouncementsAudiencesApiAxiosParamCreator(configuration);
10527
+ return {
10528
+ /**
10529
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
10530
+ * @summary Create an announcement audience
10531
+ * @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
10532
+ * @param {*} [options] Override http request option.
10533
+ * @throws {RequiredError}
10534
+ */
10535
+ createAnnouncementAudience(announcementAudienceCreateInputs, options) {
10536
+ return __awaiter(this, void 0, void 0, function* () {
10537
+ var _a, _b, _c;
10538
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createAnnouncementAudience(announcementAudienceCreateInputs, options);
10539
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10540
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.createAnnouncementAudience']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10541
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10542
+ });
10543
+ },
10544
+ /**
10545
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
10546
+ * @summary Create an audience condition
10547
+ * @param {string} audienceId The audience identifier
10548
+ * @param {string} filterId The filter identifier
10549
+ * @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
10550
+ * @param {*} [options] Override http request option.
10551
+ * @throws {RequiredError}
10552
+ */
10553
+ createAnnouncementAudienceCondition(audienceId, filterId, announcementAudienceConditionCreateInputs, options) {
10554
+ return __awaiter(this, void 0, void 0, function* () {
10555
+ var _a, _b, _c;
10556
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createAnnouncementAudienceCondition(audienceId, filterId, announcementAudienceConditionCreateInputs, options);
10557
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10558
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.createAnnouncementAudienceCondition']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10559
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10560
+ });
10561
+ },
10562
+ /**
10563
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
10564
+ * @summary Create an audience filter group
10565
+ * @param {string} audienceId The audience identifier
10566
+ * @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
10567
+ * @param {*} [options] Override http request option.
10568
+ * @throws {RequiredError}
10569
+ */
10570
+ createAnnouncementAudienceFilter(audienceId, announcementAudienceFilterCreateInputs, options) {
10571
+ return __awaiter(this, void 0, void 0, function* () {
10572
+ var _a, _b, _c;
10573
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createAnnouncementAudienceFilter(audienceId, announcementAudienceFilterCreateInputs, options);
10574
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10575
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.createAnnouncementAudienceFilter']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10576
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10577
+ });
10578
+ },
10579
+ /**
10580
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
10581
+ * @summary Delete an announcement audience
10582
+ * @param {string} audienceId The audience identifier
10583
+ * @param {*} [options] Override http request option.
10584
+ * @throws {RequiredError}
10585
+ */
10586
+ deleteAnnouncementAudience(audienceId, options) {
10587
+ return __awaiter(this, void 0, void 0, function* () {
10588
+ var _a, _b, _c;
10589
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteAnnouncementAudience(audienceId, options);
10590
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10591
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.deleteAnnouncementAudience']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10592
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10593
+ });
10594
+ },
10595
+ /**
10596
+ * Removes a condition from its filter group; requires update permission on announcements.
10597
+ * @summary Delete an audience condition
10598
+ * @param {string} audienceId The audience identifier
10599
+ * @param {string} filterId The filter identifier
10600
+ * @param {string} conditionId The condition identifier
10601
+ * @param {*} [options] Override http request option.
10602
+ * @throws {RequiredError}
10603
+ */
10604
+ deleteAnnouncementAudienceCondition(audienceId, filterId, conditionId, options) {
10605
+ return __awaiter(this, void 0, void 0, function* () {
10606
+ var _a, _b, _c;
10607
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteAnnouncementAudienceCondition(audienceId, filterId, conditionId, options);
10608
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10609
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.deleteAnnouncementAudienceCondition']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10610
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10611
+ });
10612
+ },
10613
+ /**
10614
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
10615
+ * @summary Delete an audience filter group
10616
+ * @param {string} audienceId The audience identifier
10617
+ * @param {string} filterId The filter identifier
10618
+ * @param {*} [options] Override http request option.
10619
+ * @throws {RequiredError}
10620
+ */
10621
+ deleteAnnouncementAudienceFilter(audienceId, filterId, options) {
10622
+ return __awaiter(this, void 0, void 0, function* () {
10623
+ var _a, _b, _c;
10624
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteAnnouncementAudienceFilter(audienceId, filterId, options);
10625
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10626
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.deleteAnnouncementAudienceFilter']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10627
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10628
+ });
10629
+ },
10630
+ /**
10631
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
10632
+ * @summary Get an announcement audience
10633
+ * @param {string} audienceId The audience identifier
10634
+ * @param {*} [options] Override http request option.
10635
+ * @throws {RequiredError}
10636
+ */
10637
+ getAnnouncementAudience(audienceId, options) {
10638
+ return __awaiter(this, void 0, void 0, function* () {
10639
+ var _a, _b, _c;
10640
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementAudience(audienceId, options);
10641
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10642
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudience']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10643
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10644
+ });
10645
+ },
10646
+ /**
10647
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
10648
+ * @summary List the accounts in an announcement audience
10649
+ * @param {string} audienceId The audience identifier
10650
+ * @param {number} [page] Page number
10651
+ * @param {number} [pageSize] Number of items per page
10652
+ * @param {string} [orderBy] Field to order by
10653
+ * @param {string} [search] Search query
10654
+ * @param {*} [options] Override http request option.
10655
+ * @throws {RequiredError}
10656
+ */
10657
+ getAnnouncementAudienceAccounts(audienceId, page, pageSize, orderBy, search, options) {
10658
+ return __awaiter(this, void 0, void 0, function* () {
10659
+ var _a, _b, _c;
10660
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementAudienceAccounts(audienceId, page, pageSize, orderBy, search, options);
10661
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10662
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudienceAccounts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10663
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10664
+ });
10665
+ },
10666
+ /**
10667
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
10668
+ * @summary List announcement audiences
10669
+ * @param {AnnouncementAudienceScope} [scope] Filter by scope
10670
+ * @param {number} [page] Page number
10671
+ * @param {number} [pageSize] Number of items per page
10672
+ * @param {string} [orderBy] Field to order by
10673
+ * @param {string} [search] Search query
10674
+ * @param {*} [options] Override http request option.
10675
+ * @throws {RequiredError}
10676
+ */
10677
+ getAnnouncementAudiences(scope, page, pageSize, orderBy, search, options) {
10678
+ return __awaiter(this, void 0, void 0, function* () {
10679
+ var _a, _b, _c;
10680
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementAudiences(scope, page, pageSize, orderBy, search, options);
10681
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10682
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudiences']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10683
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10684
+ });
10685
+ },
10686
+ /**
10687
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
10688
+ * @summary Update an announcement audience
10689
+ * @param {string} audienceId The audience identifier
10690
+ * @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
10691
+ * @param {*} [options] Override http request option.
10692
+ * @throws {RequiredError}
10693
+ */
10694
+ updateAnnouncementAudience(audienceId, announcementAudienceUpdateInputs, options) {
10695
+ return __awaiter(this, void 0, void 0, function* () {
10696
+ var _a, _b, _c;
10697
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAnnouncementAudience(audienceId, announcementAudienceUpdateInputs, options);
10698
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10699
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.updateAnnouncementAudience']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10700
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10701
+ });
10702
+ },
10703
+ /**
10704
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
10705
+ * @summary Update an audience condition
10706
+ * @param {string} audienceId The audience identifier
10707
+ * @param {string} filterId The filter identifier
10708
+ * @param {string} conditionId The condition identifier
10709
+ * @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
10710
+ * @param {*} [options] Override http request option.
10711
+ * @throws {RequiredError}
10712
+ */
10713
+ updateAnnouncementAudienceCondition(audienceId, filterId, conditionId, announcementAudienceConditionUpdateInputs, options) {
10714
+ return __awaiter(this, void 0, void 0, function* () {
10715
+ var _a, _b, _c;
10716
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAnnouncementAudienceCondition(audienceId, filterId, conditionId, announcementAudienceConditionUpdateInputs, options);
10717
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10718
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.updateAnnouncementAudienceCondition']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10719
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10720
+ });
10721
+ },
10722
+ /**
10723
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
10724
+ * @summary Update an audience filter group
10725
+ * @param {string} audienceId The audience identifier
10726
+ * @param {string} filterId The filter identifier
10727
+ * @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
10728
+ * @param {*} [options] Override http request option.
10729
+ * @throws {RequiredError}
10730
+ */
10731
+ updateAnnouncementAudienceFilter(audienceId, filterId, announcementAudienceFilterUpdateInputs, options) {
10732
+ return __awaiter(this, void 0, void 0, function* () {
10733
+ var _a, _b, _c;
10734
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAnnouncementAudienceFilter(audienceId, filterId, announcementAudienceFilterUpdateInputs, options);
10735
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
10736
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsAudiencesApi.updateAnnouncementAudienceFilter']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
10737
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10738
+ });
10739
+ },
10740
+ };
10741
+ };
10742
+ /**
10743
+ * AnnouncementsAudiencesApi - factory interface
10744
+ */
10745
+ export const AnnouncementsAudiencesApiFactory = function (configuration, basePath, axios) {
10746
+ const localVarFp = AnnouncementsAudiencesApiFp(configuration);
10747
+ return {
10748
+ /**
10749
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
10750
+ * @summary Create an announcement audience
10751
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
10752
+ * @param {*} [options] Override http request option.
10753
+ * @throws {RequiredError}
10754
+ */
10755
+ createAnnouncementAudience(requestParameters, options) {
10756
+ return localVarFp.createAnnouncementAudience(requestParameters.announcementAudienceCreateInputs, options).then((request) => request(axios, basePath));
10757
+ },
10758
+ /**
10759
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
10760
+ * @summary Create an audience condition
10761
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
10762
+ * @param {*} [options] Override http request option.
10763
+ * @throws {RequiredError}
10764
+ */
10765
+ createAnnouncementAudienceCondition(requestParameters, options) {
10766
+ return localVarFp.createAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceConditionCreateInputs, options).then((request) => request(axios, basePath));
10767
+ },
10768
+ /**
10769
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
10770
+ * @summary Create an audience filter group
10771
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
10772
+ * @param {*} [options] Override http request option.
10773
+ * @throws {RequiredError}
10774
+ */
10775
+ createAnnouncementAudienceFilter(requestParameters, options) {
10776
+ return localVarFp.createAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.announcementAudienceFilterCreateInputs, options).then((request) => request(axios, basePath));
10777
+ },
10778
+ /**
10779
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
10780
+ * @summary Delete an announcement audience
10781
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
10782
+ * @param {*} [options] Override http request option.
10783
+ * @throws {RequiredError}
10784
+ */
10785
+ deleteAnnouncementAudience(requestParameters, options) {
10786
+ return localVarFp.deleteAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(axios, basePath));
10787
+ },
10788
+ /**
10789
+ * Removes a condition from its filter group; requires update permission on announcements.
10790
+ * @summary Delete an audience condition
10791
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
10792
+ * @param {*} [options] Override http request option.
10793
+ * @throws {RequiredError}
10794
+ */
10795
+ deleteAnnouncementAudienceCondition(requestParameters, options) {
10796
+ return localVarFp.deleteAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, options).then((request) => request(axios, basePath));
10797
+ },
10798
+ /**
10799
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
10800
+ * @summary Delete an audience filter group
10801
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
10802
+ * @param {*} [options] Override http request option.
10803
+ * @throws {RequiredError}
10804
+ */
10805
+ deleteAnnouncementAudienceFilter(requestParameters, options) {
10806
+ return localVarFp.deleteAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, options).then((request) => request(axios, basePath));
10807
+ },
10808
+ /**
10809
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
10810
+ * @summary Get an announcement audience
10811
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
10812
+ * @param {*} [options] Override http request option.
10813
+ * @throws {RequiredError}
10814
+ */
10815
+ getAnnouncementAudience(requestParameters, options) {
10816
+ return localVarFp.getAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(axios, basePath));
10817
+ },
10818
+ /**
10819
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
10820
+ * @summary List the accounts in an announcement audience
10821
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
10822
+ * @param {*} [options] Override http request option.
10823
+ * @throws {RequiredError}
10824
+ */
10825
+ getAnnouncementAudienceAccounts(requestParameters, options) {
10826
+ return localVarFp.getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
10827
+ },
10828
+ /**
10829
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
10830
+ * @summary List announcement audiences
10831
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
10832
+ * @param {*} [options] Override http request option.
10833
+ * @throws {RequiredError}
10834
+ */
10835
+ getAnnouncementAudiences(requestParameters = {}, options) {
10836
+ return localVarFp.getAnnouncementAudiences(requestParameters.scope, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
10837
+ },
10838
+ /**
10839
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
10840
+ * @summary Update an announcement audience
10841
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
10842
+ * @param {*} [options] Override http request option.
10843
+ * @throws {RequiredError}
10844
+ */
10845
+ updateAnnouncementAudience(requestParameters, options) {
10846
+ return localVarFp.updateAnnouncementAudience(requestParameters.audienceId, requestParameters.announcementAudienceUpdateInputs, options).then((request) => request(axios, basePath));
10847
+ },
10848
+ /**
10849
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
10850
+ * @summary Update an audience condition
10851
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
10852
+ * @param {*} [options] Override http request option.
10853
+ * @throws {RequiredError}
10854
+ */
10855
+ updateAnnouncementAudienceCondition(requestParameters, options) {
10856
+ return localVarFp.updateAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, requestParameters.announcementAudienceConditionUpdateInputs, options).then((request) => request(axios, basePath));
10857
+ },
10858
+ /**
10859
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
10860
+ * @summary Update an audience filter group
10861
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
10862
+ * @param {*} [options] Override http request option.
10863
+ * @throws {RequiredError}
10864
+ */
10865
+ updateAnnouncementAudienceFilter(requestParameters, options) {
10866
+ return localVarFp.updateAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceFilterUpdateInputs, options).then((request) => request(axios, basePath));
10867
+ },
10868
+ };
10869
+ };
10870
+ /**
10871
+ * AnnouncementsAudiencesApi - object-oriented interface
10872
+ */
10873
+ export class AnnouncementsAudiencesApi extends BaseAPI {
10874
+ /**
10875
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
10876
+ * @summary Create an announcement audience
10877
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
10878
+ * @param {*} [options] Override http request option.
10879
+ * @throws {RequiredError}
10880
+ */
10881
+ createAnnouncementAudience(requestParameters, options) {
10882
+ return AnnouncementsAudiencesApiFp(this.configuration).createAnnouncementAudience(requestParameters.announcementAudienceCreateInputs, options).then((request) => request(this.axios, this.basePath));
10883
+ }
10884
+ /**
10885
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
10886
+ * @summary Create an audience condition
10887
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
10888
+ * @param {*} [options] Override http request option.
10889
+ * @throws {RequiredError}
10890
+ */
10891
+ createAnnouncementAudienceCondition(requestParameters, options) {
10892
+ return AnnouncementsAudiencesApiFp(this.configuration).createAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceConditionCreateInputs, options).then((request) => request(this.axios, this.basePath));
10893
+ }
10894
+ /**
10895
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
10896
+ * @summary Create an audience filter group
10897
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
10898
+ * @param {*} [options] Override http request option.
10899
+ * @throws {RequiredError}
10900
+ */
10901
+ createAnnouncementAudienceFilter(requestParameters, options) {
10902
+ return AnnouncementsAudiencesApiFp(this.configuration).createAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.announcementAudienceFilterCreateInputs, options).then((request) => request(this.axios, this.basePath));
10903
+ }
10904
+ /**
10905
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
10906
+ * @summary Delete an announcement audience
10907
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
10908
+ * @param {*} [options] Override http request option.
10909
+ * @throws {RequiredError}
10910
+ */
10911
+ deleteAnnouncementAudience(requestParameters, options) {
10912
+ return AnnouncementsAudiencesApiFp(this.configuration).deleteAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(this.axios, this.basePath));
10913
+ }
10914
+ /**
10915
+ * Removes a condition from its filter group; requires update permission on announcements.
10916
+ * @summary Delete an audience condition
10917
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
10918
+ * @param {*} [options] Override http request option.
10919
+ * @throws {RequiredError}
10920
+ */
10921
+ deleteAnnouncementAudienceCondition(requestParameters, options) {
10922
+ return AnnouncementsAudiencesApiFp(this.configuration).deleteAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, options).then((request) => request(this.axios, this.basePath));
10923
+ }
10924
+ /**
10925
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
10926
+ * @summary Delete an audience filter group
10927
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
10928
+ * @param {*} [options] Override http request option.
10929
+ * @throws {RequiredError}
10930
+ */
10931
+ deleteAnnouncementAudienceFilter(requestParameters, options) {
10932
+ return AnnouncementsAudiencesApiFp(this.configuration).deleteAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, options).then((request) => request(this.axios, this.basePath));
10933
+ }
10934
+ /**
10935
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
10936
+ * @summary Get an announcement audience
10937
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
10938
+ * @param {*} [options] Override http request option.
10939
+ * @throws {RequiredError}
10940
+ */
10941
+ getAnnouncementAudience(requestParameters, options) {
10942
+ return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(this.axios, this.basePath));
10943
+ }
10944
+ /**
10945
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
10946
+ * @summary List the accounts in an announcement audience
10947
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
10948
+ * @param {*} [options] Override http request option.
10949
+ * @throws {RequiredError}
10950
+ */
10951
+ getAnnouncementAudienceAccounts(requestParameters, options) {
10952
+ return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
10953
+ }
10954
+ /**
10955
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
10956
+ * @summary List announcement audiences
10957
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
10958
+ * @param {*} [options] Override http request option.
10959
+ * @throws {RequiredError}
10960
+ */
10961
+ getAnnouncementAudiences(requestParameters = {}, options) {
10962
+ return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudiences(requestParameters.scope, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
10963
+ }
10964
+ /**
10965
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
10966
+ * @summary Update an announcement audience
10967
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
10968
+ * @param {*} [options] Override http request option.
10969
+ * @throws {RequiredError}
10970
+ */
10971
+ updateAnnouncementAudience(requestParameters, options) {
10972
+ return AnnouncementsAudiencesApiFp(this.configuration).updateAnnouncementAudience(requestParameters.audienceId, requestParameters.announcementAudienceUpdateInputs, options).then((request) => request(this.axios, this.basePath));
10973
+ }
10974
+ /**
10975
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
10976
+ * @summary Update an audience condition
10977
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
10978
+ * @param {*} [options] Override http request option.
10979
+ * @throws {RequiredError}
10980
+ */
10981
+ updateAnnouncementAudienceCondition(requestParameters, options) {
10982
+ return AnnouncementsAudiencesApiFp(this.configuration).updateAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, requestParameters.announcementAudienceConditionUpdateInputs, options).then((request) => request(this.axios, this.basePath));
10983
+ }
10984
+ /**
10985
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
10986
+ * @summary Update an audience filter group
10987
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
10988
+ * @param {*} [options] Override http request option.
10989
+ * @throws {RequiredError}
10990
+ */
10991
+ updateAnnouncementAudienceFilter(requestParameters, options) {
10992
+ return AnnouncementsAudiencesApiFp(this.configuration).updateAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceFilterUpdateInputs, options).then((request) => request(this.axios, this.basePath));
10993
+ }
10994
+ }
10995
+ /**
10996
+ * AnnouncementsScheduleApi - axios parameter creator
10997
+ */
10998
+ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration) {
10999
+ return {
11000
+ /**
11001
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
11002
+ * @summary Cancel an announcement\'s scheduled send
11003
+ * @param {string} announcementId The announcement identifier
11004
+ * @param {*} [options] Override http request option.
11005
+ * @throws {RequiredError}
11006
+ */
11007
+ cancelAnnouncementSchedule: (announcementId_1, ...args_1) => __awaiter(this, [announcementId_1, ...args_1], void 0, function* (announcementId, options = {}) {
11008
+ // verify required parameter 'announcementId' is not null or undefined
11009
+ assertParamExists('cancelAnnouncementSchedule', 'announcementId', announcementId);
11010
+ const localVarPath = `/announcements/{announcementId}/schedule`
11011
+ .replace('{announcementId}', encodeURIComponent(String(announcementId)));
11012
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11013
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11014
+ let baseOptions;
11015
+ if (configuration) {
11016
+ baseOptions = configuration.baseOptions;
11017
+ }
11018
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
11019
+ const localVarHeaderParameter = {};
11020
+ const localVarQueryParameter = {};
11021
+ // authentication ApiKeyAuth required
11022
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11023
+ // authentication OrganizationId required
11024
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11025
+ localVarHeaderParameter['Accept'] = 'application/json';
11026
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11027
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11028
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11029
+ return {
11030
+ url: toPathString(localVarUrlObj),
11031
+ options: localVarRequestOptions,
11032
+ };
11033
+ }),
11034
+ /**
11035
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
11036
+ * @summary Schedule or reschedule an announcement send
11037
+ * @param {string} announcementId The announcement identifier
11038
+ * @param {object} body
11039
+ * @param {*} [options] Override http request option.
11040
+ * @throws {RequiredError}
11041
+ */
11042
+ updateAnnouncementSchedule: (announcementId_1, body_1, ...args_1) => __awaiter(this, [announcementId_1, body_1, ...args_1], void 0, function* (announcementId, body, options = {}) {
11043
+ // verify required parameter 'announcementId' is not null or undefined
11044
+ assertParamExists('updateAnnouncementSchedule', 'announcementId', announcementId);
11045
+ // verify required parameter 'body' is not null or undefined
11046
+ assertParamExists('updateAnnouncementSchedule', 'body', body);
11047
+ const localVarPath = `/announcements/{announcementId}/schedule`
11048
+ .replace('{announcementId}', encodeURIComponent(String(announcementId)));
11049
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11050
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11051
+ let baseOptions;
11052
+ if (configuration) {
11053
+ baseOptions = configuration.baseOptions;
11054
+ }
11055
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
11056
+ const localVarHeaderParameter = {};
11057
+ const localVarQueryParameter = {};
11058
+ // authentication ApiKeyAuth required
11059
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11060
+ // authentication OrganizationId required
11061
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11062
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11063
+ localVarHeaderParameter['Accept'] = 'application/json';
11064
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11065
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11066
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11067
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
11068
+ return {
11069
+ url: toPathString(localVarUrlObj),
11070
+ options: localVarRequestOptions,
11071
+ };
11072
+ }),
11073
+ };
11074
+ };
11075
+ /**
11076
+ * AnnouncementsScheduleApi - functional programming interface
11077
+ */
11078
+ export const AnnouncementsScheduleApiFp = function (configuration) {
11079
+ const localVarAxiosParamCreator = AnnouncementsScheduleApiAxiosParamCreator(configuration);
11080
+ return {
11081
+ /**
11082
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
11083
+ * @summary Cancel an announcement\'s scheduled send
11084
+ * @param {string} announcementId The announcement identifier
11085
+ * @param {*} [options] Override http request option.
11086
+ * @throws {RequiredError}
11087
+ */
11088
+ cancelAnnouncementSchedule(announcementId, options) {
11089
+ return __awaiter(this, void 0, void 0, function* () {
11090
+ var _a, _b, _c;
11091
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.cancelAnnouncementSchedule(announcementId, options);
11092
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11093
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsScheduleApi.cancelAnnouncementSchedule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11094
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11095
+ });
11096
+ },
11097
+ /**
11098
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
11099
+ * @summary Schedule or reschedule an announcement send
11100
+ * @param {string} announcementId The announcement identifier
11101
+ * @param {object} body
11102
+ * @param {*} [options] Override http request option.
11103
+ * @throws {RequiredError}
11104
+ */
11105
+ updateAnnouncementSchedule(announcementId, body, options) {
11106
+ return __awaiter(this, void 0, void 0, function* () {
11107
+ var _a, _b, _c;
11108
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAnnouncementSchedule(announcementId, body, options);
11109
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11110
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsScheduleApi.updateAnnouncementSchedule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11111
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11112
+ });
11113
+ },
11114
+ };
11115
+ };
11116
+ /**
11117
+ * AnnouncementsScheduleApi - factory interface
11118
+ */
11119
+ export const AnnouncementsScheduleApiFactory = function (configuration, basePath, axios) {
11120
+ const localVarFp = AnnouncementsScheduleApiFp(configuration);
11121
+ return {
11122
+ /**
11123
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
11124
+ * @summary Cancel an announcement\'s scheduled send
11125
+ * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
11126
+ * @param {*} [options] Override http request option.
11127
+ * @throws {RequiredError}
11128
+ */
11129
+ cancelAnnouncementSchedule(requestParameters, options) {
11130
+ return localVarFp.cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(axios, basePath));
11131
+ },
11132
+ /**
11133
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
11134
+ * @summary Schedule or reschedule an announcement send
11135
+ * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
11136
+ * @param {*} [options] Override http request option.
11137
+ * @throws {RequiredError}
11138
+ */
11139
+ updateAnnouncementSchedule(requestParameters, options) {
11140
+ return localVarFp.updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(axios, basePath));
11141
+ },
11142
+ };
11143
+ };
11144
+ /**
11145
+ * AnnouncementsScheduleApi - object-oriented interface
11146
+ */
11147
+ export class AnnouncementsScheduleApi extends BaseAPI {
11148
+ /**
11149
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
10034
11150
  * @summary Cancel an announcement\'s scheduled send
10035
11151
  * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
10036
11152
  * @param {*} [options] Override http request option.
10037
11153
  * @throws {RequiredError}
10038
11154
  */
10039
- cancelAnnouncementSchedule(requestParameters, options) {
10040
- return AnnouncementsScheduleApiFp(this.configuration).cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(this.axios, this.basePath));
11155
+ cancelAnnouncementSchedule(requestParameters, options) {
11156
+ return AnnouncementsScheduleApiFp(this.configuration).cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(this.axios, this.basePath));
11157
+ }
11158
+ /**
11159
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
11160
+ * @summary Schedule or reschedule an announcement send
11161
+ * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
11162
+ * @param {*} [options] Override http request option.
11163
+ * @throws {RequiredError}
11164
+ */
11165
+ updateAnnouncementSchedule(requestParameters, options) {
11166
+ return AnnouncementsScheduleApiFp(this.configuration).updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
11167
+ }
11168
+ }
11169
+ /**
11170
+ * AnnouncementsTemplatesApi - axios parameter creator
11171
+ */
11172
+ export const AnnouncementsTemplatesApiAxiosParamCreator = function (configuration) {
11173
+ return {
11174
+ /**
11175
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
11176
+ * @summary Create an announcement template
11177
+ * @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
11178
+ * @param {*} [options] Override http request option.
11179
+ * @throws {RequiredError}
11180
+ */
11181
+ createAnnouncementTemplate: (announcementTemplateCreateInputs_1, ...args_1) => __awaiter(this, [announcementTemplateCreateInputs_1, ...args_1], void 0, function* (announcementTemplateCreateInputs, options = {}) {
11182
+ // verify required parameter 'announcementTemplateCreateInputs' is not null or undefined
11183
+ assertParamExists('createAnnouncementTemplate', 'announcementTemplateCreateInputs', announcementTemplateCreateInputs);
11184
+ const localVarPath = `/announcements/templates`;
11185
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11186
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11187
+ let baseOptions;
11188
+ if (configuration) {
11189
+ baseOptions = configuration.baseOptions;
11190
+ }
11191
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
11192
+ const localVarHeaderParameter = {};
11193
+ const localVarQueryParameter = {};
11194
+ // authentication ApiKeyAuth required
11195
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11196
+ // authentication OrganizationId required
11197
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11198
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11199
+ localVarHeaderParameter['Accept'] = 'application/json';
11200
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11201
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11202
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11203
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementTemplateCreateInputs, localVarRequestOptions, configuration);
11204
+ return {
11205
+ url: toPathString(localVarUrlObj),
11206
+ options: localVarRequestOptions,
11207
+ };
11208
+ }),
11209
+ /**
11210
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
11211
+ * @summary Delete an announcement template
11212
+ * @param {string} templateId The template identifier
11213
+ * @param {*} [options] Override http request option.
11214
+ * @throws {RequiredError}
11215
+ */
11216
+ deleteAnnouncementTemplate: (templateId_1, ...args_1) => __awaiter(this, [templateId_1, ...args_1], void 0, function* (templateId, options = {}) {
11217
+ // verify required parameter 'templateId' is not null or undefined
11218
+ assertParamExists('deleteAnnouncementTemplate', 'templateId', templateId);
11219
+ const localVarPath = `/announcements/templates/{templateId}`
11220
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
11221
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11222
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11223
+ let baseOptions;
11224
+ if (configuration) {
11225
+ baseOptions = configuration.baseOptions;
11226
+ }
11227
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
11228
+ const localVarHeaderParameter = {};
11229
+ const localVarQueryParameter = {};
11230
+ // authentication ApiKeyAuth required
11231
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11232
+ // authentication OrganizationId required
11233
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11234
+ localVarHeaderParameter['Accept'] = 'application/json';
11235
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11236
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11237
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11238
+ return {
11239
+ url: toPathString(localVarUrlObj),
11240
+ options: localVarRequestOptions,
11241
+ };
11242
+ }),
11243
+ /**
11244
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
11245
+ * @summary Get an announcement template
11246
+ * @param {string} templateId The template identifier
11247
+ * @param {*} [options] Override http request option.
11248
+ * @throws {RequiredError}
11249
+ */
11250
+ getAnnouncementTemplate: (templateId_1, ...args_1) => __awaiter(this, [templateId_1, ...args_1], void 0, function* (templateId, options = {}) {
11251
+ // verify required parameter 'templateId' is not null or undefined
11252
+ assertParamExists('getAnnouncementTemplate', 'templateId', templateId);
11253
+ const localVarPath = `/announcements/templates/{templateId}`
11254
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
11255
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11256
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11257
+ let baseOptions;
11258
+ if (configuration) {
11259
+ baseOptions = configuration.baseOptions;
11260
+ }
11261
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
11262
+ const localVarHeaderParameter = {};
11263
+ const localVarQueryParameter = {};
11264
+ // authentication ApiKeyAuth required
11265
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11266
+ // authentication OrganizationId required
11267
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11268
+ localVarHeaderParameter['Accept'] = 'application/json';
11269
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11270
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11271
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11272
+ return {
11273
+ url: toPathString(localVarUrlObj),
11274
+ options: localVarRequestOptions,
11275
+ };
11276
+ }),
11277
+ /**
11278
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
11279
+ * @summary List announcement templates
11280
+ * @param {number} [page] Page number
11281
+ * @param {number} [pageSize] Number of items per page
11282
+ * @param {string} [orderBy] Field to order by
11283
+ * @param {string} [search] Search query
11284
+ * @param {*} [options] Override http request option.
11285
+ * @throws {RequiredError}
11286
+ */
11287
+ getAnnouncementTemplates: (page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (page, pageSize, orderBy, search, options = {}) {
11288
+ const localVarPath = `/announcements/templates`;
11289
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11290
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11291
+ let baseOptions;
11292
+ if (configuration) {
11293
+ baseOptions = configuration.baseOptions;
11294
+ }
11295
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
11296
+ const localVarHeaderParameter = {};
11297
+ const localVarQueryParameter = {};
11298
+ // authentication ApiKeyAuth required
11299
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11300
+ // authentication OrganizationId required
11301
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11302
+ if (page !== undefined) {
11303
+ localVarQueryParameter['page'] = page;
11304
+ }
11305
+ if (pageSize !== undefined) {
11306
+ localVarQueryParameter['pageSize'] = pageSize;
11307
+ }
11308
+ if (orderBy !== undefined) {
11309
+ localVarQueryParameter['orderBy'] = orderBy;
11310
+ }
11311
+ if (search !== undefined) {
11312
+ localVarQueryParameter['search'] = search;
11313
+ }
11314
+ localVarHeaderParameter['Accept'] = 'application/json';
11315
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11316
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11317
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11318
+ return {
11319
+ url: toPathString(localVarUrlObj),
11320
+ options: localVarRequestOptions,
11321
+ };
11322
+ }),
11323
+ /**
11324
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
11325
+ * @summary Update an announcement template
11326
+ * @param {string} templateId The template identifier
11327
+ * @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
11328
+ * @param {*} [options] Override http request option.
11329
+ * @throws {RequiredError}
11330
+ */
11331
+ updateAnnouncementTemplate: (templateId_1, announcementTemplateUpdateInputs_1, ...args_1) => __awaiter(this, [templateId_1, announcementTemplateUpdateInputs_1, ...args_1], void 0, function* (templateId, announcementTemplateUpdateInputs, options = {}) {
11332
+ // verify required parameter 'templateId' is not null or undefined
11333
+ assertParamExists('updateAnnouncementTemplate', 'templateId', templateId);
11334
+ // verify required parameter 'announcementTemplateUpdateInputs' is not null or undefined
11335
+ assertParamExists('updateAnnouncementTemplate', 'announcementTemplateUpdateInputs', announcementTemplateUpdateInputs);
11336
+ const localVarPath = `/announcements/templates/{templateId}`
11337
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
11338
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11339
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11340
+ let baseOptions;
11341
+ if (configuration) {
11342
+ baseOptions = configuration.baseOptions;
11343
+ }
11344
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
11345
+ const localVarHeaderParameter = {};
11346
+ const localVarQueryParameter = {};
11347
+ // authentication ApiKeyAuth required
11348
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11349
+ // authentication OrganizationId required
11350
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11351
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11352
+ localVarHeaderParameter['Accept'] = 'application/json';
11353
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11354
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11355
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11356
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementTemplateUpdateInputs, localVarRequestOptions, configuration);
11357
+ return {
11358
+ url: toPathString(localVarUrlObj),
11359
+ options: localVarRequestOptions,
11360
+ };
11361
+ }),
11362
+ };
11363
+ };
11364
+ /**
11365
+ * AnnouncementsTemplatesApi - functional programming interface
11366
+ */
11367
+ export const AnnouncementsTemplatesApiFp = function (configuration) {
11368
+ const localVarAxiosParamCreator = AnnouncementsTemplatesApiAxiosParamCreator(configuration);
11369
+ return {
11370
+ /**
11371
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
11372
+ * @summary Create an announcement template
11373
+ * @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
11374
+ * @param {*} [options] Override http request option.
11375
+ * @throws {RequiredError}
11376
+ */
11377
+ createAnnouncementTemplate(announcementTemplateCreateInputs, options) {
11378
+ return __awaiter(this, void 0, void 0, function* () {
11379
+ var _a, _b, _c;
11380
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createAnnouncementTemplate(announcementTemplateCreateInputs, options);
11381
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11382
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesApi.createAnnouncementTemplate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11383
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11384
+ });
11385
+ },
11386
+ /**
11387
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
11388
+ * @summary Delete an announcement template
11389
+ * @param {string} templateId The template identifier
11390
+ * @param {*} [options] Override http request option.
11391
+ * @throws {RequiredError}
11392
+ */
11393
+ deleteAnnouncementTemplate(templateId, options) {
11394
+ return __awaiter(this, void 0, void 0, function* () {
11395
+ var _a, _b, _c;
11396
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteAnnouncementTemplate(templateId, options);
11397
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11398
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesApi.deleteAnnouncementTemplate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11399
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11400
+ });
11401
+ },
11402
+ /**
11403
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
11404
+ * @summary Get an announcement template
11405
+ * @param {string} templateId The template identifier
11406
+ * @param {*} [options] Override http request option.
11407
+ * @throws {RequiredError}
11408
+ */
11409
+ getAnnouncementTemplate(templateId, options) {
11410
+ return __awaiter(this, void 0, void 0, function* () {
11411
+ var _a, _b, _c;
11412
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementTemplate(templateId, options);
11413
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11414
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesApi.getAnnouncementTemplate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11415
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11416
+ });
11417
+ },
11418
+ /**
11419
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
11420
+ * @summary List announcement templates
11421
+ * @param {number} [page] Page number
11422
+ * @param {number} [pageSize] Number of items per page
11423
+ * @param {string} [orderBy] Field to order by
11424
+ * @param {string} [search] Search query
11425
+ * @param {*} [options] Override http request option.
11426
+ * @throws {RequiredError}
11427
+ */
11428
+ getAnnouncementTemplates(page, pageSize, orderBy, search, options) {
11429
+ return __awaiter(this, void 0, void 0, function* () {
11430
+ var _a, _b, _c;
11431
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementTemplates(page, pageSize, orderBy, search, options);
11432
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11433
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesApi.getAnnouncementTemplates']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11434
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11435
+ });
11436
+ },
11437
+ /**
11438
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
11439
+ * @summary Update an announcement template
11440
+ * @param {string} templateId The template identifier
11441
+ * @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
11442
+ * @param {*} [options] Override http request option.
11443
+ * @throws {RequiredError}
11444
+ */
11445
+ updateAnnouncementTemplate(templateId, announcementTemplateUpdateInputs, options) {
11446
+ return __awaiter(this, void 0, void 0, function* () {
11447
+ var _a, _b, _c;
11448
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAnnouncementTemplate(templateId, announcementTemplateUpdateInputs, options);
11449
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11450
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesApi.updateAnnouncementTemplate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11451
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11452
+ });
11453
+ },
11454
+ };
11455
+ };
11456
+ /**
11457
+ * AnnouncementsTemplatesApi - factory interface
11458
+ */
11459
+ export const AnnouncementsTemplatesApiFactory = function (configuration, basePath, axios) {
11460
+ const localVarFp = AnnouncementsTemplatesApiFp(configuration);
11461
+ return {
11462
+ /**
11463
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
11464
+ * @summary Create an announcement template
11465
+ * @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
11466
+ * @param {*} [options] Override http request option.
11467
+ * @throws {RequiredError}
11468
+ */
11469
+ createAnnouncementTemplate(requestParameters, options) {
11470
+ return localVarFp.createAnnouncementTemplate(requestParameters.announcementTemplateCreateInputs, options).then((request) => request(axios, basePath));
11471
+ },
11472
+ /**
11473
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
11474
+ * @summary Delete an announcement template
11475
+ * @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
11476
+ * @param {*} [options] Override http request option.
11477
+ * @throws {RequiredError}
11478
+ */
11479
+ deleteAnnouncementTemplate(requestParameters, options) {
11480
+ return localVarFp.deleteAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(axios, basePath));
11481
+ },
11482
+ /**
11483
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
11484
+ * @summary Get an announcement template
11485
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
11486
+ * @param {*} [options] Override http request option.
11487
+ * @throws {RequiredError}
11488
+ */
11489
+ getAnnouncementTemplate(requestParameters, options) {
11490
+ return localVarFp.getAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(axios, basePath));
11491
+ },
11492
+ /**
11493
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
11494
+ * @summary List announcement templates
11495
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
11496
+ * @param {*} [options] Override http request option.
11497
+ * @throws {RequiredError}
11498
+ */
11499
+ getAnnouncementTemplates(requestParameters = {}, options) {
11500
+ return localVarFp.getAnnouncementTemplates(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
11501
+ },
11502
+ /**
11503
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
11504
+ * @summary Update an announcement template
11505
+ * @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
11506
+ * @param {*} [options] Override http request option.
11507
+ * @throws {RequiredError}
11508
+ */
11509
+ updateAnnouncementTemplate(requestParameters, options) {
11510
+ return localVarFp.updateAnnouncementTemplate(requestParameters.templateId, requestParameters.announcementTemplateUpdateInputs, options).then((request) => request(axios, basePath));
11511
+ },
11512
+ };
11513
+ };
11514
+ /**
11515
+ * AnnouncementsTemplatesApi - object-oriented interface
11516
+ */
11517
+ export class AnnouncementsTemplatesApi extends BaseAPI {
11518
+ /**
11519
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
11520
+ * @summary Create an announcement template
11521
+ * @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
11522
+ * @param {*} [options] Override http request option.
11523
+ * @throws {RequiredError}
11524
+ */
11525
+ createAnnouncementTemplate(requestParameters, options) {
11526
+ return AnnouncementsTemplatesApiFp(this.configuration).createAnnouncementTemplate(requestParameters.announcementTemplateCreateInputs, options).then((request) => request(this.axios, this.basePath));
11527
+ }
11528
+ /**
11529
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
11530
+ * @summary Delete an announcement template
11531
+ * @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
11532
+ * @param {*} [options] Override http request option.
11533
+ * @throws {RequiredError}
11534
+ */
11535
+ deleteAnnouncementTemplate(requestParameters, options) {
11536
+ return AnnouncementsTemplatesApiFp(this.configuration).deleteAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(this.axios, this.basePath));
10041
11537
  }
10042
11538
  /**
10043
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
10044
- * @summary Schedule or reschedule an announcement send
10045
- * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
11539
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
11540
+ * @summary Get an announcement template
11541
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
10046
11542
  * @param {*} [options] Override http request option.
10047
11543
  * @throws {RequiredError}
10048
11544
  */
10049
- updateAnnouncementSchedule(requestParameters, options) {
10050
- return AnnouncementsScheduleApiFp(this.configuration).updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
11545
+ getAnnouncementTemplate(requestParameters, options) {
11546
+ return AnnouncementsTemplatesApiFp(this.configuration).getAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(this.axios, this.basePath));
11547
+ }
11548
+ /**
11549
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
11550
+ * @summary List announcement templates
11551
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
11552
+ * @param {*} [options] Override http request option.
11553
+ * @throws {RequiredError}
11554
+ */
11555
+ getAnnouncementTemplates(requestParameters = {}, options) {
11556
+ return AnnouncementsTemplatesApiFp(this.configuration).getAnnouncementTemplates(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
11557
+ }
11558
+ /**
11559
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
11560
+ * @summary Update an announcement template
11561
+ * @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
11562
+ * @param {*} [options] Override http request option.
11563
+ * @throws {RequiredError}
11564
+ */
11565
+ updateAnnouncementTemplate(requestParameters, options) {
11566
+ return AnnouncementsTemplatesApiFp(this.configuration).updateAnnouncementTemplate(requestParameters.templateId, requestParameters.announcementTemplateUpdateInputs, options).then((request) => request(this.axios, this.basePath));
11567
+ }
11568
+ }
11569
+ /**
11570
+ * AnnouncementsTemplatesTranslationsApi - axios parameter creator
11571
+ */
11572
+ export const AnnouncementsTemplatesTranslationsApiAxiosParamCreator = function (configuration) {
11573
+ return {
11574
+ /**
11575
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
11576
+ * @summary Delete an announcement template translation
11577
+ * @param {string} templateId The template identifier
11578
+ * @param {string} locale The locale identifier
11579
+ * @param {*} [options] Override http request option.
11580
+ * @throws {RequiredError}
11581
+ */
11582
+ deleteAnnouncementTemplateTranslation: (templateId_1, locale_1, ...args_1) => __awaiter(this, [templateId_1, locale_1, ...args_1], void 0, function* (templateId, locale, options = {}) {
11583
+ // verify required parameter 'templateId' is not null or undefined
11584
+ assertParamExists('deleteAnnouncementTemplateTranslation', 'templateId', templateId);
11585
+ // verify required parameter 'locale' is not null or undefined
11586
+ assertParamExists('deleteAnnouncementTemplateTranslation', 'locale', locale);
11587
+ const localVarPath = `/announcements/templates/{templateId}/translations/{locale}`
11588
+ .replace('{templateId}', encodeURIComponent(String(templateId)))
11589
+ .replace('{locale}', encodeURIComponent(String(locale)));
11590
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11591
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11592
+ let baseOptions;
11593
+ if (configuration) {
11594
+ baseOptions = configuration.baseOptions;
11595
+ }
11596
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
11597
+ const localVarHeaderParameter = {};
11598
+ const localVarQueryParameter = {};
11599
+ // authentication ApiKeyAuth required
11600
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11601
+ // authentication OrganizationId required
11602
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11603
+ localVarHeaderParameter['Accept'] = 'application/json';
11604
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11605
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11606
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11607
+ return {
11608
+ url: toPathString(localVarUrlObj),
11609
+ options: localVarRequestOptions,
11610
+ };
11611
+ }),
11612
+ /**
11613
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
11614
+ * @summary Get an announcement template\'s translation for a locale
11615
+ * @param {string} templateId The template identifier
11616
+ * @param {string} locale The locale identifier
11617
+ * @param {*} [options] Override http request option.
11618
+ * @throws {RequiredError}
11619
+ */
11620
+ getAnnouncementTemplateTranslation: (templateId_1, locale_1, ...args_1) => __awaiter(this, [templateId_1, locale_1, ...args_1], void 0, function* (templateId, locale, options = {}) {
11621
+ // verify required parameter 'templateId' is not null or undefined
11622
+ assertParamExists('getAnnouncementTemplateTranslation', 'templateId', templateId);
11623
+ // verify required parameter 'locale' is not null or undefined
11624
+ assertParamExists('getAnnouncementTemplateTranslation', 'locale', locale);
11625
+ const localVarPath = `/announcements/templates/{templateId}/translations/{locale}`
11626
+ .replace('{templateId}', encodeURIComponent(String(templateId)))
11627
+ .replace('{locale}', encodeURIComponent(String(locale)));
11628
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11629
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11630
+ let baseOptions;
11631
+ if (configuration) {
11632
+ baseOptions = configuration.baseOptions;
11633
+ }
11634
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
11635
+ const localVarHeaderParameter = {};
11636
+ const localVarQueryParameter = {};
11637
+ // authentication ApiKeyAuth required
11638
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11639
+ // authentication OrganizationId required
11640
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11641
+ localVarHeaderParameter['Accept'] = 'application/json';
11642
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11643
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11644
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11645
+ return {
11646
+ url: toPathString(localVarUrlObj),
11647
+ options: localVarRequestOptions,
11648
+ };
11649
+ }),
11650
+ /**
11651
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
11652
+ * @summary List an announcement template\'s translations
11653
+ * @param {string} templateId The template identifier
11654
+ * @param {number} [page] Page number
11655
+ * @param {number} [pageSize] Number of items per page
11656
+ * @param {string} [orderBy] Field to order by
11657
+ * @param {string} [search] Search query
11658
+ * @param {*} [options] Override http request option.
11659
+ * @throws {RequiredError}
11660
+ */
11661
+ getAnnouncementTemplateTranslations: (templateId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [templateId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (templateId, page, pageSize, orderBy, search, options = {}) {
11662
+ // verify required parameter 'templateId' is not null or undefined
11663
+ assertParamExists('getAnnouncementTemplateTranslations', 'templateId', templateId);
11664
+ const localVarPath = `/announcements/templates/{templateId}/translations`
11665
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
11666
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11667
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11668
+ let baseOptions;
11669
+ if (configuration) {
11670
+ baseOptions = configuration.baseOptions;
11671
+ }
11672
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
11673
+ const localVarHeaderParameter = {};
11674
+ const localVarQueryParameter = {};
11675
+ // authentication ApiKeyAuth required
11676
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11677
+ // authentication OrganizationId required
11678
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11679
+ if (page !== undefined) {
11680
+ localVarQueryParameter['page'] = page;
11681
+ }
11682
+ if (pageSize !== undefined) {
11683
+ localVarQueryParameter['pageSize'] = pageSize;
11684
+ }
11685
+ if (orderBy !== undefined) {
11686
+ localVarQueryParameter['orderBy'] = orderBy;
11687
+ }
11688
+ if (search !== undefined) {
11689
+ localVarQueryParameter['search'] = search;
11690
+ }
11691
+ localVarHeaderParameter['Accept'] = 'application/json';
11692
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11693
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11694
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11695
+ return {
11696
+ url: toPathString(localVarUrlObj),
11697
+ options: localVarRequestOptions,
11698
+ };
11699
+ }),
11700
+ /**
11701
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
11702
+ * @summary Update an announcement template translation
11703
+ * @param {string} templateId The template identifier
11704
+ * @param {string} locale The locale identifier
11705
+ * @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
11706
+ * @param {*} [options] Override http request option.
11707
+ * @throws {RequiredError}
11708
+ */
11709
+ updateAnnouncementTemplateTranslation: (templateId_1, locale_1, announcementTemplateTranslationUpdateInputs_1, ...args_1) => __awaiter(this, [templateId_1, locale_1, announcementTemplateTranslationUpdateInputs_1, ...args_1], void 0, function* (templateId, locale, announcementTemplateTranslationUpdateInputs, options = {}) {
11710
+ // verify required parameter 'templateId' is not null or undefined
11711
+ assertParamExists('updateAnnouncementTemplateTranslation', 'templateId', templateId);
11712
+ // verify required parameter 'locale' is not null or undefined
11713
+ assertParamExists('updateAnnouncementTemplateTranslation', 'locale', locale);
11714
+ // verify required parameter 'announcementTemplateTranslationUpdateInputs' is not null or undefined
11715
+ assertParamExists('updateAnnouncementTemplateTranslation', 'announcementTemplateTranslationUpdateInputs', announcementTemplateTranslationUpdateInputs);
11716
+ const localVarPath = `/announcements/templates/{templateId}/translations/{locale}`
11717
+ .replace('{templateId}', encodeURIComponent(String(templateId)))
11718
+ .replace('{locale}', encodeURIComponent(String(locale)));
11719
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11720
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11721
+ let baseOptions;
11722
+ if (configuration) {
11723
+ baseOptions = configuration.baseOptions;
11724
+ }
11725
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
11726
+ const localVarHeaderParameter = {};
11727
+ const localVarQueryParameter = {};
11728
+ // authentication ApiKeyAuth required
11729
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
11730
+ // authentication OrganizationId required
11731
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
11732
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11733
+ localVarHeaderParameter['Accept'] = 'application/json';
11734
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11735
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11736
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
11737
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementTemplateTranslationUpdateInputs, localVarRequestOptions, configuration);
11738
+ return {
11739
+ url: toPathString(localVarUrlObj),
11740
+ options: localVarRequestOptions,
11741
+ };
11742
+ }),
11743
+ };
11744
+ };
11745
+ /**
11746
+ * AnnouncementsTemplatesTranslationsApi - functional programming interface
11747
+ */
11748
+ export const AnnouncementsTemplatesTranslationsApiFp = function (configuration) {
11749
+ const localVarAxiosParamCreator = AnnouncementsTemplatesTranslationsApiAxiosParamCreator(configuration);
11750
+ return {
11751
+ /**
11752
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
11753
+ * @summary Delete an announcement template translation
11754
+ * @param {string} templateId The template identifier
11755
+ * @param {string} locale The locale identifier
11756
+ * @param {*} [options] Override http request option.
11757
+ * @throws {RequiredError}
11758
+ */
11759
+ deleteAnnouncementTemplateTranslation(templateId, locale, options) {
11760
+ return __awaiter(this, void 0, void 0, function* () {
11761
+ var _a, _b, _c;
11762
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteAnnouncementTemplateTranslation(templateId, locale, options);
11763
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11764
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesTranslationsApi.deleteAnnouncementTemplateTranslation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11765
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11766
+ });
11767
+ },
11768
+ /**
11769
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
11770
+ * @summary Get an announcement template\'s translation for a locale
11771
+ * @param {string} templateId The template identifier
11772
+ * @param {string} locale The locale identifier
11773
+ * @param {*} [options] Override http request option.
11774
+ * @throws {RequiredError}
11775
+ */
11776
+ getAnnouncementTemplateTranslation(templateId, locale, options) {
11777
+ return __awaiter(this, void 0, void 0, function* () {
11778
+ var _a, _b, _c;
11779
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementTemplateTranslation(templateId, locale, options);
11780
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11781
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesTranslationsApi.getAnnouncementTemplateTranslation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11782
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11783
+ });
11784
+ },
11785
+ /**
11786
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
11787
+ * @summary List an announcement template\'s translations
11788
+ * @param {string} templateId The template identifier
11789
+ * @param {number} [page] Page number
11790
+ * @param {number} [pageSize] Number of items per page
11791
+ * @param {string} [orderBy] Field to order by
11792
+ * @param {string} [search] Search query
11793
+ * @param {*} [options] Override http request option.
11794
+ * @throws {RequiredError}
11795
+ */
11796
+ getAnnouncementTemplateTranslations(templateId, page, pageSize, orderBy, search, options) {
11797
+ return __awaiter(this, void 0, void 0, function* () {
11798
+ var _a, _b, _c;
11799
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementTemplateTranslations(templateId, page, pageSize, orderBy, search, options);
11800
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11801
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesTranslationsApi.getAnnouncementTemplateTranslations']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11802
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11803
+ });
11804
+ },
11805
+ /**
11806
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
11807
+ * @summary Update an announcement template translation
11808
+ * @param {string} templateId The template identifier
11809
+ * @param {string} locale The locale identifier
11810
+ * @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
11811
+ * @param {*} [options] Override http request option.
11812
+ * @throws {RequiredError}
11813
+ */
11814
+ updateAnnouncementTemplateTranslation(templateId, locale, announcementTemplateTranslationUpdateInputs, options) {
11815
+ return __awaiter(this, void 0, void 0, function* () {
11816
+ var _a, _b, _c;
11817
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAnnouncementTemplateTranslation(templateId, locale, announcementTemplateTranslationUpdateInputs, options);
11818
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
11819
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnnouncementsTemplatesTranslationsApi.updateAnnouncementTemplateTranslation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
11820
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11821
+ });
11822
+ },
11823
+ };
11824
+ };
11825
+ /**
11826
+ * AnnouncementsTemplatesTranslationsApi - factory interface
11827
+ */
11828
+ export const AnnouncementsTemplatesTranslationsApiFactory = function (configuration, basePath, axios) {
11829
+ const localVarFp = AnnouncementsTemplatesTranslationsApiFp(configuration);
11830
+ return {
11831
+ /**
11832
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
11833
+ * @summary Delete an announcement template translation
11834
+ * @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
11835
+ * @param {*} [options] Override http request option.
11836
+ * @throws {RequiredError}
11837
+ */
11838
+ deleteAnnouncementTemplateTranslation(requestParameters, options) {
11839
+ return localVarFp.deleteAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(axios, basePath));
11840
+ },
11841
+ /**
11842
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
11843
+ * @summary Get an announcement template\'s translation for a locale
11844
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
11845
+ * @param {*} [options] Override http request option.
11846
+ * @throws {RequiredError}
11847
+ */
11848
+ getAnnouncementTemplateTranslation(requestParameters, options) {
11849
+ return localVarFp.getAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(axios, basePath));
11850
+ },
11851
+ /**
11852
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
11853
+ * @summary List an announcement template\'s translations
11854
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
11855
+ * @param {*} [options] Override http request option.
11856
+ * @throws {RequiredError}
11857
+ */
11858
+ getAnnouncementTemplateTranslations(requestParameters, options) {
11859
+ return localVarFp.getAnnouncementTemplateTranslations(requestParameters.templateId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
11860
+ },
11861
+ /**
11862
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
11863
+ * @summary Update an announcement template translation
11864
+ * @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
11865
+ * @param {*} [options] Override http request option.
11866
+ * @throws {RequiredError}
11867
+ */
11868
+ updateAnnouncementTemplateTranslation(requestParameters, options) {
11869
+ return localVarFp.updateAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, requestParameters.announcementTemplateTranslationUpdateInputs, options).then((request) => request(axios, basePath));
11870
+ },
11871
+ };
11872
+ };
11873
+ /**
11874
+ * AnnouncementsTemplatesTranslationsApi - object-oriented interface
11875
+ */
11876
+ export class AnnouncementsTemplatesTranslationsApi extends BaseAPI {
11877
+ /**
11878
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
11879
+ * @summary Delete an announcement template translation
11880
+ * @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
11881
+ * @param {*} [options] Override http request option.
11882
+ * @throws {RequiredError}
11883
+ */
11884
+ deleteAnnouncementTemplateTranslation(requestParameters, options) {
11885
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).deleteAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
11886
+ }
11887
+ /**
11888
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
11889
+ * @summary Get an announcement template\'s translation for a locale
11890
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
11891
+ * @param {*} [options] Override http request option.
11892
+ * @throws {RequiredError}
11893
+ */
11894
+ getAnnouncementTemplateTranslation(requestParameters, options) {
11895
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).getAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
11896
+ }
11897
+ /**
11898
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
11899
+ * @summary List an announcement template\'s translations
11900
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
11901
+ * @param {*} [options] Override http request option.
11902
+ * @throws {RequiredError}
11903
+ */
11904
+ getAnnouncementTemplateTranslations(requestParameters, options) {
11905
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).getAnnouncementTemplateTranslations(requestParameters.templateId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
11906
+ }
11907
+ /**
11908
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
11909
+ * @summary Update an announcement template translation
11910
+ * @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
11911
+ * @param {*} [options] Override http request option.
11912
+ * @throws {RequiredError}
11913
+ */
11914
+ updateAnnouncementTemplateTranslation(requestParameters, options) {
11915
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).updateAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, requestParameters.announcementTemplateTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
10051
11916
  }
10052
11917
  }
10053
11918
  /**