@connectedxm/admin-sdk 11.1.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 +257 -2
- 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 +144 -2
- package/dist/api.js +215 -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 +144 -2
- package/dist/esm/api.js +186 -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/BadgeColorRuleType.md +2 -0
- package/docs/BaseEventOnSiteBadgeColorRule.md +4 -0
- package/docs/EventBadgeColorRuleCreateInputs.md +4 -0
- package/docs/EventBadgeColorRuleUpdateInputs.md +4 -0
- package/docs/EventGroupCouponReminder.md +30 -0
- package/docs/EventGroupCouponReminderUpdateInputs.md +24 -0
- package/docs/EventOnSiteBadgeColorRule.md +6 -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/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).
|
|
@@ -690,7 +690,8 @@ export interface AuthorizeNetActivationFormParams {
|
|
|
690
690
|
export declare enum BadgeColorRuleType {
|
|
691
691
|
Attribute = "attribute",
|
|
692
692
|
Tier = "tier",
|
|
693
|
-
PassType = "passType"
|
|
693
|
+
PassType = "passType",
|
|
694
|
+
PassAttribute = "passAttribute"
|
|
694
695
|
}
|
|
695
696
|
export interface BarChartSummaryData {
|
|
696
697
|
'type': BarChartSummaryDataTypeEnum;
|
|
@@ -1294,6 +1295,8 @@ export interface BaseEventOnSiteBadgeColorRule {
|
|
|
1294
1295
|
'attributeValue': string | null;
|
|
1295
1296
|
'tierId': string | null;
|
|
1296
1297
|
'passTypeId': string | null;
|
|
1298
|
+
'passAttributeId': string | null;
|
|
1299
|
+
'passAttributeValue': string | null;
|
|
1297
1300
|
}
|
|
1298
1301
|
export interface BaseEventOnSiteLabel {
|
|
1299
1302
|
'id': string;
|
|
@@ -4791,6 +4794,8 @@ export interface EventBadgeColorRuleCreateInputs {
|
|
|
4791
4794
|
'attributeValue'?: string | null;
|
|
4792
4795
|
'tierId'?: string | null;
|
|
4793
4796
|
'passTypeId'?: string | null;
|
|
4797
|
+
'passAttributeId'?: string | null;
|
|
4798
|
+
'passAttributeValue'?: string | null;
|
|
4794
4799
|
}
|
|
4795
4800
|
export interface EventBadgeColorRuleUpdateInputs {
|
|
4796
4801
|
'name'?: string;
|
|
@@ -4801,6 +4806,8 @@ export interface EventBadgeColorRuleUpdateInputs {
|
|
|
4801
4806
|
'attributeValue'?: string | null;
|
|
4802
4807
|
'tierId'?: string | null;
|
|
4803
4808
|
'passTypeId'?: string | null;
|
|
4809
|
+
'passAttributeId'?: string | null;
|
|
4810
|
+
'passAttributeValue'?: string | null;
|
|
4804
4811
|
}
|
|
4805
4812
|
export interface EventBlock {
|
|
4806
4813
|
'id': string;
|
|
@@ -5015,6 +5022,19 @@ export interface EventFollowupUpdateInputs {
|
|
|
5015
5022
|
'guestDescription'?: string | null;
|
|
5016
5023
|
'sortOrder'?: number | null;
|
|
5017
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
|
+
}
|
|
5018
5038
|
export interface EventLocationInputs {
|
|
5019
5039
|
'venue'?: string | null;
|
|
5020
5040
|
'location'?: string | null;
|
|
@@ -5096,9 +5116,12 @@ export interface EventOnSiteBadgeColorRule {
|
|
|
5096
5116
|
'attributeValue': string | null;
|
|
5097
5117
|
'tierId': string | null;
|
|
5098
5118
|
'passTypeId': string | null;
|
|
5119
|
+
'passAttributeId': string | null;
|
|
5120
|
+
'passAttributeValue': string | null;
|
|
5099
5121
|
'attribute': BaseAccountAttribute | null;
|
|
5100
5122
|
'tier': BaseTier | null;
|
|
5101
5123
|
'passType': BaseEventPassType | null;
|
|
5124
|
+
'passAttribute': BaseEventAttribute | null;
|
|
5102
5125
|
'createdAt': string;
|
|
5103
5126
|
'updatedAt': string;
|
|
5104
5127
|
}
|
|
@@ -7408,6 +7431,14 @@ export interface GetEventFollowups200Response {
|
|
|
7408
7431
|
export declare enum GetEventFollowups200ResponseStatusEnum {
|
|
7409
7432
|
Ok = "ok"
|
|
7410
7433
|
}
|
|
7434
|
+
export interface GetEventGroupCouponReminder200Response {
|
|
7435
|
+
'status': GetEventGroupCouponReminder200ResponseStatusEnum;
|
|
7436
|
+
'message': string;
|
|
7437
|
+
'data': EventGroupCouponReminder;
|
|
7438
|
+
}
|
|
7439
|
+
export declare enum GetEventGroupCouponReminder200ResponseStatusEnum {
|
|
7440
|
+
Ok = "ok"
|
|
7441
|
+
}
|
|
7411
7442
|
export interface GetEventMediaItemLikes200Response {
|
|
7412
7443
|
'status': GetEventMediaItemLikes200ResponseStatusEnum;
|
|
7413
7444
|
'message': string;
|
|
@@ -9302,6 +9333,11 @@ export interface GroupAllOfCount {
|
|
|
9302
9333
|
'interests': number;
|
|
9303
9334
|
'events': number;
|
|
9304
9335
|
}
|
|
9336
|
+
export declare enum GroupCouponReminderFrequency {
|
|
9337
|
+
Weekly = "weekly",
|
|
9338
|
+
Monthly = "monthly",
|
|
9339
|
+
Quarterly = "quarterly"
|
|
9340
|
+
}
|
|
9305
9341
|
export interface GroupCreateInputs {
|
|
9306
9342
|
'name': string;
|
|
9307
9343
|
'description': string;
|
|
@@ -10273,6 +10309,7 @@ export interface NotificationPreferences {
|
|
|
10273
10309
|
'transferEmail': boolean;
|
|
10274
10310
|
'eventReminderEmail': boolean;
|
|
10275
10311
|
'abandonedRegistrationEmail': boolean;
|
|
10312
|
+
'groupCouponReminderEmail': boolean;
|
|
10276
10313
|
'bookingReminderEmail': boolean;
|
|
10277
10314
|
'chatPush': boolean;
|
|
10278
10315
|
'chatUnreadEmail': boolean;
|
|
@@ -33365,6 +33402,111 @@ export declare class EventsFollowupsTranslationsApi extends BaseAPI {
|
|
|
33365
33402
|
*/
|
|
33366
33403
|
updateEventFollowupTranslation(requestParameters: EventsFollowupsTranslationsApiUpdateEventFollowupTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}>>;
|
|
33367
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
|
+
}
|
|
33368
33510
|
/**
|
|
33369
33511
|
* EventsMatchesApi - axios parameter creator
|
|
33370
33512
|
*/
|