@connectedxm/admin-sdk 11.2.0 → 11.3.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.
- package/.openapi-generator/FILES +5 -0
- package/AdminApi.ts +3 -0
- package/README.md +2 -2
- package/api.ts +246 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +133 -1
- package/dist/api.js +214 -25
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +133 -1
- package/dist/esm/api.js +185 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/EventGroupCouponReminder.md +30 -0
- package/docs/EventGroupCouponReminderUpdateInputs.md +24 -0
- package/docs/EventsGroupcouponreminderApi.md +115 -0
- package/docs/GetEventGroupCouponReminder200Response.md +24 -0
- package/docs/GroupCouponReminderFrequency.md +12 -0
- package/docs/NotificationPreferences.md +2 -0
- package/package.json +1 -1
package/dist/esm/AdminApi.js
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
* const eventsPasses = await adminApi.eventsPasses.getEventPasses();
|
|
13
13
|
*/
|
|
14
14
|
import { Configuration } from "./configuration";
|
|
15
|
-
import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsScheduleApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangewebhooksApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi, } from "./api";
|
|
15
|
+
import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsScheduleApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsGroupcouponreminderApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangewebhooksApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi, } from "./api";
|
|
16
16
|
export class AdminApi {
|
|
17
17
|
constructor(config) {
|
|
18
18
|
var _a;
|
|
@@ -80,6 +80,7 @@ export class AdminApi {
|
|
|
80
80
|
this.eventsFaqsTranslations = new EventsFaqsTranslationsApi(this.config);
|
|
81
81
|
this.eventsFollowups = new EventsFollowupsApi(this.config);
|
|
82
82
|
this.eventsFollowupsTranslations = new EventsFollowupsTranslationsApi(this.config);
|
|
83
|
+
this.eventsGroupcouponreminder = new EventsGroupcouponreminderApi(this.config);
|
|
83
84
|
this.eventsMatches = new EventsMatchesApi(this.config);
|
|
84
85
|
this.eventsMedia = new EventsMediaApi(this.config);
|
|
85
86
|
this.eventsMediaTranslations = new EventsMediaTranslationsApi(this.config);
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5022,6 +5022,19 @@ export interface EventFollowupUpdateInputs {
|
|
|
5022
5022
|
'guestDescription'?: string | null;
|
|
5023
5023
|
'sortOrder'?: number | null;
|
|
5024
5024
|
}
|
|
5025
|
+
export interface EventGroupCouponReminder {
|
|
5026
|
+
'eventId': string;
|
|
5027
|
+
'enabled': boolean;
|
|
5028
|
+
'startDate': string | null;
|
|
5029
|
+
'frequency': GroupCouponReminderFrequency | null;
|
|
5030
|
+
'createdAt': string;
|
|
5031
|
+
'updatedAt': string;
|
|
5032
|
+
}
|
|
5033
|
+
export interface EventGroupCouponReminderUpdateInputs {
|
|
5034
|
+
'enabled'?: boolean;
|
|
5035
|
+
'startDate'?: string | null;
|
|
5036
|
+
'frequency'?: GroupCouponReminderFrequency | null;
|
|
5037
|
+
}
|
|
5025
5038
|
export interface EventLocationInputs {
|
|
5026
5039
|
'venue'?: string | null;
|
|
5027
5040
|
'location'?: string | null;
|
|
@@ -7418,6 +7431,14 @@ export interface GetEventFollowups200Response {
|
|
|
7418
7431
|
export declare enum GetEventFollowups200ResponseStatusEnum {
|
|
7419
7432
|
Ok = "ok"
|
|
7420
7433
|
}
|
|
7434
|
+
export interface GetEventGroupCouponReminder200Response {
|
|
7435
|
+
'status': GetEventGroupCouponReminder200ResponseStatusEnum;
|
|
7436
|
+
'message': string;
|
|
7437
|
+
'data': EventGroupCouponReminder;
|
|
7438
|
+
}
|
|
7439
|
+
export declare enum GetEventGroupCouponReminder200ResponseStatusEnum {
|
|
7440
|
+
Ok = "ok"
|
|
7441
|
+
}
|
|
7421
7442
|
export interface GetEventMediaItemLikes200Response {
|
|
7422
7443
|
'status': GetEventMediaItemLikes200ResponseStatusEnum;
|
|
7423
7444
|
'message': string;
|
|
@@ -9312,6 +9333,11 @@ export interface GroupAllOfCount {
|
|
|
9312
9333
|
'interests': number;
|
|
9313
9334
|
'events': number;
|
|
9314
9335
|
}
|
|
9336
|
+
export declare enum GroupCouponReminderFrequency {
|
|
9337
|
+
Weekly = "weekly",
|
|
9338
|
+
Monthly = "monthly",
|
|
9339
|
+
Quarterly = "quarterly"
|
|
9340
|
+
}
|
|
9315
9341
|
export interface GroupCreateInputs {
|
|
9316
9342
|
'name': string;
|
|
9317
9343
|
'description': string;
|
|
@@ -10283,6 +10309,7 @@ export interface NotificationPreferences {
|
|
|
10283
10309
|
'transferEmail': boolean;
|
|
10284
10310
|
'eventReminderEmail': boolean;
|
|
10285
10311
|
'abandonedRegistrationEmail': boolean;
|
|
10312
|
+
'groupCouponReminderEmail': boolean;
|
|
10286
10313
|
'bookingReminderEmail': boolean;
|
|
10287
10314
|
'chatPush': boolean;
|
|
10288
10315
|
'chatUnreadEmail': boolean;
|
|
@@ -33375,6 +33402,111 @@ export declare class EventsFollowupsTranslationsApi extends BaseAPI {
|
|
|
33375
33402
|
*/
|
|
33376
33403
|
updateEventFollowupTranslation(requestParameters: EventsFollowupsTranslationsApiUpdateEventFollowupTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}>>;
|
|
33377
33404
|
}
|
|
33405
|
+
/**
|
|
33406
|
+
* EventsGroupcouponreminderApi - axios parameter creator
|
|
33407
|
+
*/
|
|
33408
|
+
export declare const EventsGroupcouponreminderApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
33409
|
+
/**
|
|
33410
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
33411
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
33412
|
+
* @param {string} eventId The event identifier
|
|
33413
|
+
* @param {*} [options] Override http request option.
|
|
33414
|
+
* @throws {RequiredError}
|
|
33415
|
+
*/
|
|
33416
|
+
getEventGroupCouponReminder: (eventId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33417
|
+
/**
|
|
33418
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
33419
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
33420
|
+
* @param {string} eventId The event identifier
|
|
33421
|
+
* @param {EventGroupCouponReminderUpdateInputs} eventGroupCouponReminderUpdateInputs
|
|
33422
|
+
* @param {*} [options] Override http request option.
|
|
33423
|
+
* @throws {RequiredError}
|
|
33424
|
+
*/
|
|
33425
|
+
updateEventGroupCouponReminder: (eventId: string, eventGroupCouponReminderUpdateInputs: EventGroupCouponReminderUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33426
|
+
};
|
|
33427
|
+
/**
|
|
33428
|
+
* EventsGroupcouponreminderApi - functional programming interface
|
|
33429
|
+
*/
|
|
33430
|
+
export declare const EventsGroupcouponreminderApiFp: (configuration?: Configuration) => {
|
|
33431
|
+
/**
|
|
33432
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
33433
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
33434
|
+
* @param {string} eventId The event identifier
|
|
33435
|
+
* @param {*} [options] Override http request option.
|
|
33436
|
+
* @throws {RequiredError}
|
|
33437
|
+
*/
|
|
33438
|
+
getEventGroupCouponReminder(eventId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventGroupCouponReminder200Response>>;
|
|
33439
|
+
/**
|
|
33440
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
33441
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
33442
|
+
* @param {string} eventId The event identifier
|
|
33443
|
+
* @param {EventGroupCouponReminderUpdateInputs} eventGroupCouponReminderUpdateInputs
|
|
33444
|
+
* @param {*} [options] Override http request option.
|
|
33445
|
+
* @throws {RequiredError}
|
|
33446
|
+
*/
|
|
33447
|
+
updateEventGroupCouponReminder(eventId: string, eventGroupCouponReminderUpdateInputs: EventGroupCouponReminderUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventGroupCouponReminder200Response>>;
|
|
33448
|
+
};
|
|
33449
|
+
/**
|
|
33450
|
+
* EventsGroupcouponreminderApi - factory interface
|
|
33451
|
+
*/
|
|
33452
|
+
export declare const EventsGroupcouponreminderApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
33453
|
+
/**
|
|
33454
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
33455
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
33456
|
+
* @param {EventsGroupcouponreminderApiGetEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33457
|
+
* @param {*} [options] Override http request option.
|
|
33458
|
+
* @throws {RequiredError}
|
|
33459
|
+
*/
|
|
33460
|
+
getEventGroupCouponReminder(requestParameters: EventsGroupcouponreminderApiGetEventGroupCouponReminderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventGroupCouponReminder200Response>;
|
|
33461
|
+
/**
|
|
33462
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
33463
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
33464
|
+
* @param {EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33465
|
+
* @param {*} [options] Override http request option.
|
|
33466
|
+
* @throws {RequiredError}
|
|
33467
|
+
*/
|
|
33468
|
+
updateEventGroupCouponReminder(requestParameters: EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventGroupCouponReminder200Response>;
|
|
33469
|
+
};
|
|
33470
|
+
/**
|
|
33471
|
+
* Request parameters for getEventGroupCouponReminder operation in EventsGroupcouponreminderApi.
|
|
33472
|
+
*/
|
|
33473
|
+
export interface EventsGroupcouponreminderApiGetEventGroupCouponReminderRequest {
|
|
33474
|
+
/**
|
|
33475
|
+
* The event identifier
|
|
33476
|
+
*/
|
|
33477
|
+
readonly eventId: string;
|
|
33478
|
+
}
|
|
33479
|
+
/**
|
|
33480
|
+
* Request parameters for updateEventGroupCouponReminder operation in EventsGroupcouponreminderApi.
|
|
33481
|
+
*/
|
|
33482
|
+
export interface EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest {
|
|
33483
|
+
/**
|
|
33484
|
+
* The event identifier
|
|
33485
|
+
*/
|
|
33486
|
+
readonly eventId: string;
|
|
33487
|
+
readonly eventGroupCouponReminderUpdateInputs: EventGroupCouponReminderUpdateInputs;
|
|
33488
|
+
}
|
|
33489
|
+
/**
|
|
33490
|
+
* EventsGroupcouponreminderApi - object-oriented interface
|
|
33491
|
+
*/
|
|
33492
|
+
export declare class EventsGroupcouponreminderApi extends BaseAPI {
|
|
33493
|
+
/**
|
|
33494
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
33495
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
33496
|
+
* @param {EventsGroupcouponreminderApiGetEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33497
|
+
* @param {*} [options] Override http request option.
|
|
33498
|
+
* @throws {RequiredError}
|
|
33499
|
+
*/
|
|
33500
|
+
getEventGroupCouponReminder(requestParameters: EventsGroupcouponreminderApiGetEventGroupCouponReminderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventGroupCouponReminder200Response, any, {}>>;
|
|
33501
|
+
/**
|
|
33502
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
33503
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
33504
|
+
* @param {EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33505
|
+
* @param {*} [options] Override http request option.
|
|
33506
|
+
* @throws {RequiredError}
|
|
33507
|
+
*/
|
|
33508
|
+
updateEventGroupCouponReminder(requestParameters: EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventGroupCouponReminder200Response, any, {}>>;
|
|
33509
|
+
}
|
|
33378
33510
|
/**
|
|
33379
33511
|
* EventsMatchesApi - axios parameter creator
|
|
33380
33512
|
*/
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 11.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1115,6 +1115,10 @@ export var GetEventFollowups200ResponseStatusEnum;
|
|
|
1115
1115
|
(function (GetEventFollowups200ResponseStatusEnum) {
|
|
1116
1116
|
GetEventFollowups200ResponseStatusEnum["Ok"] = "ok";
|
|
1117
1117
|
})(GetEventFollowups200ResponseStatusEnum || (GetEventFollowups200ResponseStatusEnum = {}));
|
|
1118
|
+
export var GetEventGroupCouponReminder200ResponseStatusEnum;
|
|
1119
|
+
(function (GetEventGroupCouponReminder200ResponseStatusEnum) {
|
|
1120
|
+
GetEventGroupCouponReminder200ResponseStatusEnum["Ok"] = "ok";
|
|
1121
|
+
})(GetEventGroupCouponReminder200ResponseStatusEnum || (GetEventGroupCouponReminder200ResponseStatusEnum = {}));
|
|
1118
1122
|
export var GetEventMediaItemLikes200ResponseStatusEnum;
|
|
1119
1123
|
(function (GetEventMediaItemLikes200ResponseStatusEnum) {
|
|
1120
1124
|
GetEventMediaItemLikes200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1984,6 +1988,12 @@ export var GroupAccess;
|
|
|
1984
1988
|
GroupAccess["Public"] = "public";
|
|
1985
1989
|
GroupAccess["Private"] = "private";
|
|
1986
1990
|
})(GroupAccess || (GroupAccess = {}));
|
|
1991
|
+
export var GroupCouponReminderFrequency;
|
|
1992
|
+
(function (GroupCouponReminderFrequency) {
|
|
1993
|
+
GroupCouponReminderFrequency["Weekly"] = "weekly";
|
|
1994
|
+
GroupCouponReminderFrequency["Monthly"] = "monthly";
|
|
1995
|
+
GroupCouponReminderFrequency["Quarterly"] = "quarterly";
|
|
1996
|
+
})(GroupCouponReminderFrequency || (GroupCouponReminderFrequency = {}));
|
|
1987
1997
|
export var GroupInvitationStatus;
|
|
1988
1998
|
(function (GroupInvitationStatus) {
|
|
1989
1999
|
GroupInvitationStatus["Invited"] = "invited";
|
|
@@ -32901,6 +32911,180 @@ export class EventsFollowupsTranslationsApi extends BaseAPI {
|
|
|
32901
32911
|
return EventsFollowupsTranslationsApiFp(this.configuration).updateEventFollowupTranslation(requestParameters.eventId, requestParameters.followupId, requestParameters.locale, requestParameters.eventFollowupTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
32902
32912
|
}
|
|
32903
32913
|
}
|
|
32914
|
+
/**
|
|
32915
|
+
* EventsGroupcouponreminderApi - axios parameter creator
|
|
32916
|
+
*/
|
|
32917
|
+
export const EventsGroupcouponreminderApiAxiosParamCreator = function (configuration) {
|
|
32918
|
+
return {
|
|
32919
|
+
/**
|
|
32920
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
32921
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
32922
|
+
* @param {string} eventId The event identifier
|
|
32923
|
+
* @param {*} [options] Override http request option.
|
|
32924
|
+
* @throws {RequiredError}
|
|
32925
|
+
*/
|
|
32926
|
+
getEventGroupCouponReminder: (eventId_1, ...args_1) => __awaiter(this, [eventId_1, ...args_1], void 0, function* (eventId, options = {}) {
|
|
32927
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
32928
|
+
assertParamExists('getEventGroupCouponReminder', 'eventId', eventId);
|
|
32929
|
+
const localVarPath = `/events/{eventId}/groupCouponReminder`
|
|
32930
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)));
|
|
32931
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32932
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32933
|
+
let baseOptions;
|
|
32934
|
+
if (configuration) {
|
|
32935
|
+
baseOptions = configuration.baseOptions;
|
|
32936
|
+
}
|
|
32937
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
32938
|
+
const localVarHeaderParameter = {};
|
|
32939
|
+
const localVarQueryParameter = {};
|
|
32940
|
+
// authentication ApiKeyAuth required
|
|
32941
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
32942
|
+
// authentication OrganizationId required
|
|
32943
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
32944
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
32945
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
32946
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
32947
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
32948
|
+
return {
|
|
32949
|
+
url: toPathString(localVarUrlObj),
|
|
32950
|
+
options: localVarRequestOptions,
|
|
32951
|
+
};
|
|
32952
|
+
}),
|
|
32953
|
+
/**
|
|
32954
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
32955
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
32956
|
+
* @param {string} eventId The event identifier
|
|
32957
|
+
* @param {EventGroupCouponReminderUpdateInputs} eventGroupCouponReminderUpdateInputs
|
|
32958
|
+
* @param {*} [options] Override http request option.
|
|
32959
|
+
* @throws {RequiredError}
|
|
32960
|
+
*/
|
|
32961
|
+
updateEventGroupCouponReminder: (eventId_1, eventGroupCouponReminderUpdateInputs_1, ...args_1) => __awaiter(this, [eventId_1, eventGroupCouponReminderUpdateInputs_1, ...args_1], void 0, function* (eventId, eventGroupCouponReminderUpdateInputs, options = {}) {
|
|
32962
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
32963
|
+
assertParamExists('updateEventGroupCouponReminder', 'eventId', eventId);
|
|
32964
|
+
// verify required parameter 'eventGroupCouponReminderUpdateInputs' is not null or undefined
|
|
32965
|
+
assertParamExists('updateEventGroupCouponReminder', 'eventGroupCouponReminderUpdateInputs', eventGroupCouponReminderUpdateInputs);
|
|
32966
|
+
const localVarPath = `/events/{eventId}/groupCouponReminder`
|
|
32967
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)));
|
|
32968
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32969
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32970
|
+
let baseOptions;
|
|
32971
|
+
if (configuration) {
|
|
32972
|
+
baseOptions = configuration.baseOptions;
|
|
32973
|
+
}
|
|
32974
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
32975
|
+
const localVarHeaderParameter = {};
|
|
32976
|
+
const localVarQueryParameter = {};
|
|
32977
|
+
// authentication ApiKeyAuth required
|
|
32978
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
32979
|
+
// authentication OrganizationId required
|
|
32980
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
32981
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
32982
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
32983
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
32984
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
32985
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
32986
|
+
localVarRequestOptions.data = serializeDataIfNeeded(eventGroupCouponReminderUpdateInputs, localVarRequestOptions, configuration);
|
|
32987
|
+
return {
|
|
32988
|
+
url: toPathString(localVarUrlObj),
|
|
32989
|
+
options: localVarRequestOptions,
|
|
32990
|
+
};
|
|
32991
|
+
}),
|
|
32992
|
+
};
|
|
32993
|
+
};
|
|
32994
|
+
/**
|
|
32995
|
+
* EventsGroupcouponreminderApi - functional programming interface
|
|
32996
|
+
*/
|
|
32997
|
+
export const EventsGroupcouponreminderApiFp = function (configuration) {
|
|
32998
|
+
const localVarAxiosParamCreator = EventsGroupcouponreminderApiAxiosParamCreator(configuration);
|
|
32999
|
+
return {
|
|
33000
|
+
/**
|
|
33001
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
33002
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
33003
|
+
* @param {string} eventId The event identifier
|
|
33004
|
+
* @param {*} [options] Override http request option.
|
|
33005
|
+
* @throws {RequiredError}
|
|
33006
|
+
*/
|
|
33007
|
+
getEventGroupCouponReminder(eventId, options) {
|
|
33008
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
33009
|
+
var _a, _b, _c;
|
|
33010
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventGroupCouponReminder(eventId, options);
|
|
33011
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
33012
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsGroupcouponreminderApi.getEventGroupCouponReminder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
33013
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33014
|
+
});
|
|
33015
|
+
},
|
|
33016
|
+
/**
|
|
33017
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
33018
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
33019
|
+
* @param {string} eventId The event identifier
|
|
33020
|
+
* @param {EventGroupCouponReminderUpdateInputs} eventGroupCouponReminderUpdateInputs
|
|
33021
|
+
* @param {*} [options] Override http request option.
|
|
33022
|
+
* @throws {RequiredError}
|
|
33023
|
+
*/
|
|
33024
|
+
updateEventGroupCouponReminder(eventId, eventGroupCouponReminderUpdateInputs, options) {
|
|
33025
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
33026
|
+
var _a, _b, _c;
|
|
33027
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateEventGroupCouponReminder(eventId, eventGroupCouponReminderUpdateInputs, options);
|
|
33028
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
33029
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsGroupcouponreminderApi.updateEventGroupCouponReminder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
33030
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33031
|
+
});
|
|
33032
|
+
},
|
|
33033
|
+
};
|
|
33034
|
+
};
|
|
33035
|
+
/**
|
|
33036
|
+
* EventsGroupcouponreminderApi - factory interface
|
|
33037
|
+
*/
|
|
33038
|
+
export const EventsGroupcouponreminderApiFactory = function (configuration, basePath, axios) {
|
|
33039
|
+
const localVarFp = EventsGroupcouponreminderApiFp(configuration);
|
|
33040
|
+
return {
|
|
33041
|
+
/**
|
|
33042
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
33043
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
33044
|
+
* @param {EventsGroupcouponreminderApiGetEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33045
|
+
* @param {*} [options] Override http request option.
|
|
33046
|
+
* @throws {RequiredError}
|
|
33047
|
+
*/
|
|
33048
|
+
getEventGroupCouponReminder(requestParameters, options) {
|
|
33049
|
+
return localVarFp.getEventGroupCouponReminder(requestParameters.eventId, options).then((request) => request(axios, basePath));
|
|
33050
|
+
},
|
|
33051
|
+
/**
|
|
33052
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
33053
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
33054
|
+
* @param {EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33055
|
+
* @param {*} [options] Override http request option.
|
|
33056
|
+
* @throws {RequiredError}
|
|
33057
|
+
*/
|
|
33058
|
+
updateEventGroupCouponReminder(requestParameters, options) {
|
|
33059
|
+
return localVarFp.updateEventGroupCouponReminder(requestParameters.eventId, requestParameters.eventGroupCouponReminderUpdateInputs, options).then((request) => request(axios, basePath));
|
|
33060
|
+
},
|
|
33061
|
+
};
|
|
33062
|
+
};
|
|
33063
|
+
/**
|
|
33064
|
+
* EventsGroupcouponreminderApi - object-oriented interface
|
|
33065
|
+
*/
|
|
33066
|
+
export class EventsGroupcouponreminderApi extends BaseAPI {
|
|
33067
|
+
/**
|
|
33068
|
+
* Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
33069
|
+
* @summary Get an event\'s group coupon reminder schedule
|
|
33070
|
+
* @param {EventsGroupcouponreminderApiGetEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33071
|
+
* @param {*} [options] Override http request option.
|
|
33072
|
+
* @throws {RequiredError}
|
|
33073
|
+
*/
|
|
33074
|
+
getEventGroupCouponReminder(requestParameters, options) {
|
|
33075
|
+
return EventsGroupcouponreminderApiFp(this.configuration).getEventGroupCouponReminder(requestParameters.eventId, options).then((request) => request(this.axios, this.basePath));
|
|
33076
|
+
}
|
|
33077
|
+
/**
|
|
33078
|
+
* Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
33079
|
+
* @summary Update an event\'s group coupon reminder schedule
|
|
33080
|
+
* @param {EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest} requestParameters Request parameters.
|
|
33081
|
+
* @param {*} [options] Override http request option.
|
|
33082
|
+
* @throws {RequiredError}
|
|
33083
|
+
*/
|
|
33084
|
+
updateEventGroupCouponReminder(requestParameters, options) {
|
|
33085
|
+
return EventsGroupcouponreminderApiFp(this.configuration).updateEventGroupCouponReminder(requestParameters.eventId, requestParameters.eventGroupCouponReminderUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
33086
|
+
}
|
|
33087
|
+
}
|
|
32904
33088
|
/**
|
|
32905
33089
|
* EventsMatchesApi - axios parameter creator
|
|
32906
33090
|
*/
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.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.
|
|
7
|
+
* The version of the OpenAPI document: 11.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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.
|
|
7
|
+
* The version of the OpenAPI document: 11.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 11.
|
|
6
|
+
* The version of the OpenAPI document: 11.3.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# EventGroupCouponReminder
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**eventId** | **string** | | [default to undefined]
|
|
9
|
+
**enabled** | **boolean** | | [default to undefined]
|
|
10
|
+
**startDate** | **string** | | [default to undefined]
|
|
11
|
+
**frequency** | [**GroupCouponReminderFrequency**](GroupCouponReminderFrequency.md) | | [default to undefined]
|
|
12
|
+
**createdAt** | **string** | | [default to undefined]
|
|
13
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { EventGroupCouponReminder } from '@connectedxm/admin-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: EventGroupCouponReminder = {
|
|
21
|
+
eventId,
|
|
22
|
+
enabled,
|
|
23
|
+
startDate,
|
|
24
|
+
frequency,
|
|
25
|
+
createdAt,
|
|
26
|
+
updatedAt,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# EventGroupCouponReminderUpdateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**enabled** | **boolean** | | [optional] [default to undefined]
|
|
9
|
+
**startDate** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**frequency** | [**GroupCouponReminderFrequency**](GroupCouponReminderFrequency.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EventGroupCouponReminderUpdateInputs } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: EventGroupCouponReminderUpdateInputs = {
|
|
18
|
+
enabled,
|
|
19
|
+
startDate,
|
|
20
|
+
frequency,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# EventsGroupcouponreminderApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getEventGroupCouponReminder**](#geteventgroupcouponreminder) | **GET** /events/{eventId}/groupCouponReminder | Get an event\'s group coupon reminder schedule|
|
|
8
|
+
|[**updateEventGroupCouponReminder**](#updateeventgroupcouponreminder) | **PUT** /events/{eventId}/groupCouponReminder | Update an event\'s group coupon reminder schedule|
|
|
9
|
+
|
|
10
|
+
# **getEventGroupCouponReminder**
|
|
11
|
+
> GetEventGroupCouponReminder200Response getEventGroupCouponReminder()
|
|
12
|
+
|
|
13
|
+
Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
EventsGroupcouponreminderApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@connectedxm/admin-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new EventsGroupcouponreminderApi(configuration);
|
|
25
|
+
|
|
26
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.getEventGroupCouponReminder(
|
|
29
|
+
eventId
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**GetEventGroupCouponReminder200Response**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: Not defined
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**200** | Successful response | - |
|
|
58
|
+
|
|
59
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
60
|
+
|
|
61
|
+
# **updateEventGroupCouponReminder**
|
|
62
|
+
> GetEventGroupCouponReminder200Response updateEventGroupCouponReminder(eventGroupCouponReminderUpdateInputs)
|
|
63
|
+
|
|
64
|
+
Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
|
|
65
|
+
|
|
66
|
+
### Example
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import {
|
|
70
|
+
EventsGroupcouponreminderApi,
|
|
71
|
+
Configuration,
|
|
72
|
+
EventGroupCouponReminderUpdateInputs
|
|
73
|
+
} from '@connectedxm/admin-sdk';
|
|
74
|
+
|
|
75
|
+
const configuration = new Configuration();
|
|
76
|
+
const apiInstance = new EventsGroupcouponreminderApi(configuration);
|
|
77
|
+
|
|
78
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
79
|
+
let eventGroupCouponReminderUpdateInputs: EventGroupCouponReminderUpdateInputs; //
|
|
80
|
+
|
|
81
|
+
const { status, data } = await apiInstance.updateEventGroupCouponReminder(
|
|
82
|
+
eventId,
|
|
83
|
+
eventGroupCouponReminderUpdateInputs
|
|
84
|
+
);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
|Name | Type | Description | Notes|
|
|
90
|
+
|------------- | ------------- | ------------- | -------------|
|
|
91
|
+
| **eventGroupCouponReminderUpdateInputs** | **EventGroupCouponReminderUpdateInputs**| | |
|
|
92
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
**GetEventGroupCouponReminder200Response**
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: application/json
|
|
106
|
+
- **Accept**: application/json
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
### HTTP response details
|
|
110
|
+
| Status code | Description | Response headers |
|
|
111
|
+
|-------------|-------------|------------------|
|
|
112
|
+
|**200** | Successful response | - |
|
|
113
|
+
|
|
114
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
115
|
+
|