@connectedxm/admin-sdk 7.9.4 → 7.9.5
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 +1 -0
- package/README.md +3 -0
- package/api.ts +220 -0
- package/dist/api.d.ts +116 -0
- package/dist/api.js +190 -26
- package/dist/esm/api.d.ts +116 -0
- package/dist/esm/api.js +164 -0
- package/docs/BasePassAddOn.md +2 -0
- package/docs/EventsPassesAddonsApi.md +116 -0
- package/docs/FulfillEventPassAddOn200Response.md +24 -0
- package/docs/PassAddOn.md +2 -0
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -1849,6 +1849,7 @@ export interface BaseOrganizationModuleSettingsTranslation {
|
|
|
1849
1849
|
export interface BasePassAddOn {
|
|
1850
1850
|
'addOnId': string;
|
|
1851
1851
|
'addOn': BaseEventAddOn;
|
|
1852
|
+
'fulfilledAt': string | null;
|
|
1852
1853
|
'pass': BasePassAddOnPass;
|
|
1853
1854
|
'createdAt': string;
|
|
1854
1855
|
}
|
|
@@ -6174,6 +6175,14 @@ export interface FileUpdateInputs {
|
|
|
6174
6175
|
'source'?: FileSource;
|
|
6175
6176
|
'public'?: boolean;
|
|
6176
6177
|
}
|
|
6178
|
+
export interface FulfillEventPassAddOn200Response {
|
|
6179
|
+
'status': FulfillEventPassAddOn200ResponseStatusEnum;
|
|
6180
|
+
'message': string;
|
|
6181
|
+
'data': PassAddOn;
|
|
6182
|
+
}
|
|
6183
|
+
export declare enum FulfillEventPassAddOn200ResponseStatusEnum {
|
|
6184
|
+
Ok = "ok"
|
|
6185
|
+
}
|
|
6177
6186
|
export interface GetAPILog200Response {
|
|
6178
6187
|
'status': GetAPILog200ResponseStatusEnum;
|
|
6179
6188
|
'message': string;
|
|
@@ -10265,6 +10274,7 @@ export declare enum PageType {
|
|
|
10265
10274
|
export interface PassAddOn {
|
|
10266
10275
|
'addOnId': string;
|
|
10267
10276
|
'addOn': BaseEventAddOn;
|
|
10277
|
+
'fulfilledAt': string | null;
|
|
10268
10278
|
'createdAt': string;
|
|
10269
10279
|
'pass': BaseEventPass;
|
|
10270
10280
|
'updatedAt': string;
|
|
@@ -39228,6 +39238,16 @@ export declare const EventsPassesAddonsApiAxiosParamCreator: (configuration?: Co
|
|
|
39228
39238
|
* @throws {RequiredError}
|
|
39229
39239
|
*/
|
|
39230
39240
|
addEventPassAddOn: (eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39241
|
+
/**
|
|
39242
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
39243
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
39244
|
+
* @param {string} eventId The event identifier
|
|
39245
|
+
* @param {string} passId The pass identifier
|
|
39246
|
+
* @param {string} addOnId The addOn identifier
|
|
39247
|
+
* @param {*} [options] Override http request option.
|
|
39248
|
+
* @throws {RequiredError}
|
|
39249
|
+
*/
|
|
39250
|
+
fulfillEventPassAddOn: (eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39231
39251
|
/**
|
|
39232
39252
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
39233
39253
|
* @summary List an event pass\'s add-ons
|
|
@@ -39251,6 +39271,16 @@ export declare const EventsPassesAddonsApiAxiosParamCreator: (configuration?: Co
|
|
|
39251
39271
|
* @throws {RequiredError}
|
|
39252
39272
|
*/
|
|
39253
39273
|
removeEventPassAddOn: (eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39274
|
+
/**
|
|
39275
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
39276
|
+
* @summary Undo an add-on fulfillment
|
|
39277
|
+
* @param {string} eventId The event identifier
|
|
39278
|
+
* @param {string} passId The pass identifier
|
|
39279
|
+
* @param {string} addOnId The addOn identifier
|
|
39280
|
+
* @param {*} [options] Override http request option.
|
|
39281
|
+
* @throws {RequiredError}
|
|
39282
|
+
*/
|
|
39283
|
+
unfulfillEventPassAddOn: (eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39254
39284
|
};
|
|
39255
39285
|
/**
|
|
39256
39286
|
* EventsPassesAddonsApi - functional programming interface
|
|
@@ -39266,6 +39296,16 @@ export declare const EventsPassesAddonsApiFp: (configuration?: Configuration) =>
|
|
|
39266
39296
|
* @throws {RequiredError}
|
|
39267
39297
|
*/
|
|
39268
39298
|
addEventPassAddOn(eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventPass200Response>>;
|
|
39299
|
+
/**
|
|
39300
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
39301
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
39302
|
+
* @param {string} eventId The event identifier
|
|
39303
|
+
* @param {string} passId The pass identifier
|
|
39304
|
+
* @param {string} addOnId The addOn identifier
|
|
39305
|
+
* @param {*} [options] Override http request option.
|
|
39306
|
+
* @throws {RequiredError}
|
|
39307
|
+
*/
|
|
39308
|
+
fulfillEventPassAddOn(eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillEventPassAddOn200Response>>;
|
|
39269
39309
|
/**
|
|
39270
39310
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
39271
39311
|
* @summary List an event pass\'s add-ons
|
|
@@ -39289,6 +39329,16 @@ export declare const EventsPassesAddonsApiFp: (configuration?: Configuration) =>
|
|
|
39289
39329
|
* @throws {RequiredError}
|
|
39290
39330
|
*/
|
|
39291
39331
|
removeEventPassAddOn(eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventPass200Response>>;
|
|
39332
|
+
/**
|
|
39333
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
39334
|
+
* @summary Undo an add-on fulfillment
|
|
39335
|
+
* @param {string} eventId The event identifier
|
|
39336
|
+
* @param {string} passId The pass identifier
|
|
39337
|
+
* @param {string} addOnId The addOn identifier
|
|
39338
|
+
* @param {*} [options] Override http request option.
|
|
39339
|
+
* @throws {RequiredError}
|
|
39340
|
+
*/
|
|
39341
|
+
unfulfillEventPassAddOn(eventId: string, passId: string, addOnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillEventPassAddOn200Response>>;
|
|
39292
39342
|
};
|
|
39293
39343
|
/**
|
|
39294
39344
|
* EventsPassesAddonsApi - factory interface
|
|
@@ -39302,6 +39352,14 @@ export declare const EventsPassesAddonsApiFactory: (configuration?: Configuratio
|
|
|
39302
39352
|
* @throws {RequiredError}
|
|
39303
39353
|
*/
|
|
39304
39354
|
addEventPassAddOn(requestParameters: EventsPassesAddonsApiAddEventPassAddOnRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventPass200Response>;
|
|
39355
|
+
/**
|
|
39356
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
39357
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
39358
|
+
* @param {EventsPassesAddonsApiFulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
39359
|
+
* @param {*} [options] Override http request option.
|
|
39360
|
+
* @throws {RequiredError}
|
|
39361
|
+
*/
|
|
39362
|
+
fulfillEventPassAddOn(requestParameters: EventsPassesAddonsApiFulfillEventPassAddOnRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillEventPassAddOn200Response>;
|
|
39305
39363
|
/**
|
|
39306
39364
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
39307
39365
|
* @summary List an event pass\'s add-ons
|
|
@@ -39318,6 +39376,14 @@ export declare const EventsPassesAddonsApiFactory: (configuration?: Configuratio
|
|
|
39318
39376
|
* @throws {RequiredError}
|
|
39319
39377
|
*/
|
|
39320
39378
|
removeEventPassAddOn(requestParameters: EventsPassesAddonsApiRemoveEventPassAddOnRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventPass200Response>;
|
|
39379
|
+
/**
|
|
39380
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
39381
|
+
* @summary Undo an add-on fulfillment
|
|
39382
|
+
* @param {EventsPassesAddonsApiUnfulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
39383
|
+
* @param {*} [options] Override http request option.
|
|
39384
|
+
* @throws {RequiredError}
|
|
39385
|
+
*/
|
|
39386
|
+
unfulfillEventPassAddOn(requestParameters: EventsPassesAddonsApiUnfulfillEventPassAddOnRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillEventPassAddOn200Response>;
|
|
39321
39387
|
};
|
|
39322
39388
|
/**
|
|
39323
39389
|
* Request parameters for addEventPassAddOn operation in EventsPassesAddonsApi.
|
|
@@ -39336,6 +39402,23 @@ export interface EventsPassesAddonsApiAddEventPassAddOnRequest {
|
|
|
39336
39402
|
*/
|
|
39337
39403
|
readonly addOnId: string;
|
|
39338
39404
|
}
|
|
39405
|
+
/**
|
|
39406
|
+
* Request parameters for fulfillEventPassAddOn operation in EventsPassesAddonsApi.
|
|
39407
|
+
*/
|
|
39408
|
+
export interface EventsPassesAddonsApiFulfillEventPassAddOnRequest {
|
|
39409
|
+
/**
|
|
39410
|
+
* The event identifier
|
|
39411
|
+
*/
|
|
39412
|
+
readonly eventId: string;
|
|
39413
|
+
/**
|
|
39414
|
+
* The pass identifier
|
|
39415
|
+
*/
|
|
39416
|
+
readonly passId: string;
|
|
39417
|
+
/**
|
|
39418
|
+
* The addOn identifier
|
|
39419
|
+
*/
|
|
39420
|
+
readonly addOnId: string;
|
|
39421
|
+
}
|
|
39339
39422
|
/**
|
|
39340
39423
|
* Request parameters for getEventPassAddOns operation in EventsPassesAddonsApi.
|
|
39341
39424
|
*/
|
|
@@ -39382,6 +39465,23 @@ export interface EventsPassesAddonsApiRemoveEventPassAddOnRequest {
|
|
|
39382
39465
|
*/
|
|
39383
39466
|
readonly addOnId: string;
|
|
39384
39467
|
}
|
|
39468
|
+
/**
|
|
39469
|
+
* Request parameters for unfulfillEventPassAddOn operation in EventsPassesAddonsApi.
|
|
39470
|
+
*/
|
|
39471
|
+
export interface EventsPassesAddonsApiUnfulfillEventPassAddOnRequest {
|
|
39472
|
+
/**
|
|
39473
|
+
* The event identifier
|
|
39474
|
+
*/
|
|
39475
|
+
readonly eventId: string;
|
|
39476
|
+
/**
|
|
39477
|
+
* The pass identifier
|
|
39478
|
+
*/
|
|
39479
|
+
readonly passId: string;
|
|
39480
|
+
/**
|
|
39481
|
+
* The addOn identifier
|
|
39482
|
+
*/
|
|
39483
|
+
readonly addOnId: string;
|
|
39484
|
+
}
|
|
39385
39485
|
/**
|
|
39386
39486
|
* EventsPassesAddonsApi - object-oriented interface
|
|
39387
39487
|
*/
|
|
@@ -39394,6 +39494,14 @@ export declare class EventsPassesAddonsApi extends BaseAPI {
|
|
|
39394
39494
|
* @throws {RequiredError}
|
|
39395
39495
|
*/
|
|
39396
39496
|
addEventPassAddOn(requestParameters: EventsPassesAddonsApiAddEventPassAddOnRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventPass200Response, any, {}>>;
|
|
39497
|
+
/**
|
|
39498
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
39499
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
39500
|
+
* @param {EventsPassesAddonsApiFulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
39501
|
+
* @param {*} [options] Override http request option.
|
|
39502
|
+
* @throws {RequiredError}
|
|
39503
|
+
*/
|
|
39504
|
+
fulfillEventPassAddOn(requestParameters: EventsPassesAddonsApiFulfillEventPassAddOnRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillEventPassAddOn200Response, any, {}>>;
|
|
39397
39505
|
/**
|
|
39398
39506
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
39399
39507
|
* @summary List an event pass\'s add-ons
|
|
@@ -39410,6 +39518,14 @@ export declare class EventsPassesAddonsApi extends BaseAPI {
|
|
|
39410
39518
|
* @throws {RequiredError}
|
|
39411
39519
|
*/
|
|
39412
39520
|
removeEventPassAddOn(requestParameters: EventsPassesAddonsApiRemoveEventPassAddOnRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventPass200Response, any, {}>>;
|
|
39521
|
+
/**
|
|
39522
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
39523
|
+
* @summary Undo an add-on fulfillment
|
|
39524
|
+
* @param {EventsPassesAddonsApiUnfulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
39525
|
+
* @param {*} [options] Override http request option.
|
|
39526
|
+
* @throws {RequiredError}
|
|
39527
|
+
*/
|
|
39528
|
+
unfulfillEventPassAddOn(requestParameters: EventsPassesAddonsApiUnfulfillEventPassAddOnRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillEventPassAddOn200Response, any, {}>>;
|
|
39413
39529
|
}
|
|
39414
39530
|
/**
|
|
39415
39531
|
* EventsPassesAttributesApi - axios parameter creator
|
package/dist/esm/api.js
CHANGED
|
@@ -674,6 +674,10 @@ export var FileSource;
|
|
|
674
674
|
FileSource["Content"] = "content";
|
|
675
675
|
FileSource["Thread"] = "thread";
|
|
676
676
|
})(FileSource || (FileSource = {}));
|
|
677
|
+
export var FulfillEventPassAddOn200ResponseStatusEnum;
|
|
678
|
+
(function (FulfillEventPassAddOn200ResponseStatusEnum) {
|
|
679
|
+
FulfillEventPassAddOn200ResponseStatusEnum["Ok"] = "ok";
|
|
680
|
+
})(FulfillEventPassAddOn200ResponseStatusEnum || (FulfillEventPassAddOn200ResponseStatusEnum = {}));
|
|
677
681
|
export var GetAPILog200ResponseStatusEnum;
|
|
678
682
|
(function (GetAPILog200ResponseStatusEnum) {
|
|
679
683
|
GetAPILog200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -42326,6 +42330,48 @@ export const EventsPassesAddonsApiAxiosParamCreator = function (configuration) {
|
|
|
42326
42330
|
options: localVarRequestOptions,
|
|
42327
42331
|
};
|
|
42328
42332
|
}),
|
|
42333
|
+
/**
|
|
42334
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42335
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42336
|
+
* @param {string} eventId The event identifier
|
|
42337
|
+
* @param {string} passId The pass identifier
|
|
42338
|
+
* @param {string} addOnId The addOn identifier
|
|
42339
|
+
* @param {*} [options] Override http request option.
|
|
42340
|
+
* @throws {RequiredError}
|
|
42341
|
+
*/
|
|
42342
|
+
fulfillEventPassAddOn: (eventId_1, passId_1, addOnId_1, ...args_1) => __awaiter(this, [eventId_1, passId_1, addOnId_1, ...args_1], void 0, function* (eventId, passId, addOnId, options = {}) {
|
|
42343
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
42344
|
+
assertParamExists('fulfillEventPassAddOn', 'eventId', eventId);
|
|
42345
|
+
// verify required parameter 'passId' is not null or undefined
|
|
42346
|
+
assertParamExists('fulfillEventPassAddOn', 'passId', passId);
|
|
42347
|
+
// verify required parameter 'addOnId' is not null or undefined
|
|
42348
|
+
assertParamExists('fulfillEventPassAddOn', 'addOnId', addOnId);
|
|
42349
|
+
const localVarPath = `/events/{eventId}/passes/{passId}/addOns/{addOnId}/fulfill`
|
|
42350
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
42351
|
+
.replace(`{${"passId"}}`, encodeURIComponent(String(passId)))
|
|
42352
|
+
.replace(`{${"addOnId"}}`, encodeURIComponent(String(addOnId)));
|
|
42353
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42354
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42355
|
+
let baseOptions;
|
|
42356
|
+
if (configuration) {
|
|
42357
|
+
baseOptions = configuration.baseOptions;
|
|
42358
|
+
}
|
|
42359
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
42360
|
+
const localVarHeaderParameter = {};
|
|
42361
|
+
const localVarQueryParameter = {};
|
|
42362
|
+
// authentication ApiKeyAuth required
|
|
42363
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
42364
|
+
// authentication OrganizationId required
|
|
42365
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
42366
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
42367
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42368
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42369
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42370
|
+
return {
|
|
42371
|
+
url: toPathString(localVarUrlObj),
|
|
42372
|
+
options: localVarRequestOptions,
|
|
42373
|
+
};
|
|
42374
|
+
}),
|
|
42329
42375
|
/**
|
|
42330
42376
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42331
42377
|
* @summary List an event pass\'s add-ons
|
|
@@ -42422,6 +42468,48 @@ export const EventsPassesAddonsApiAxiosParamCreator = function (configuration) {
|
|
|
42422
42468
|
options: localVarRequestOptions,
|
|
42423
42469
|
};
|
|
42424
42470
|
}),
|
|
42471
|
+
/**
|
|
42472
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42473
|
+
* @summary Undo an add-on fulfillment
|
|
42474
|
+
* @param {string} eventId The event identifier
|
|
42475
|
+
* @param {string} passId The pass identifier
|
|
42476
|
+
* @param {string} addOnId The addOn identifier
|
|
42477
|
+
* @param {*} [options] Override http request option.
|
|
42478
|
+
* @throws {RequiredError}
|
|
42479
|
+
*/
|
|
42480
|
+
unfulfillEventPassAddOn: (eventId_1, passId_1, addOnId_1, ...args_1) => __awaiter(this, [eventId_1, passId_1, addOnId_1, ...args_1], void 0, function* (eventId, passId, addOnId, options = {}) {
|
|
42481
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
42482
|
+
assertParamExists('unfulfillEventPassAddOn', 'eventId', eventId);
|
|
42483
|
+
// verify required parameter 'passId' is not null or undefined
|
|
42484
|
+
assertParamExists('unfulfillEventPassAddOn', 'passId', passId);
|
|
42485
|
+
// verify required parameter 'addOnId' is not null or undefined
|
|
42486
|
+
assertParamExists('unfulfillEventPassAddOn', 'addOnId', addOnId);
|
|
42487
|
+
const localVarPath = `/events/{eventId}/passes/{passId}/addOns/{addOnId}/undo`
|
|
42488
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
42489
|
+
.replace(`{${"passId"}}`, encodeURIComponent(String(passId)))
|
|
42490
|
+
.replace(`{${"addOnId"}}`, encodeURIComponent(String(addOnId)));
|
|
42491
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42492
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42493
|
+
let baseOptions;
|
|
42494
|
+
if (configuration) {
|
|
42495
|
+
baseOptions = configuration.baseOptions;
|
|
42496
|
+
}
|
|
42497
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
42498
|
+
const localVarHeaderParameter = {};
|
|
42499
|
+
const localVarQueryParameter = {};
|
|
42500
|
+
// authentication ApiKeyAuth required
|
|
42501
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
42502
|
+
// authentication OrganizationId required
|
|
42503
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
42504
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
42505
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42506
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42507
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42508
|
+
return {
|
|
42509
|
+
url: toPathString(localVarUrlObj),
|
|
42510
|
+
options: localVarRequestOptions,
|
|
42511
|
+
};
|
|
42512
|
+
}),
|
|
42425
42513
|
};
|
|
42426
42514
|
};
|
|
42427
42515
|
/**
|
|
@@ -42448,6 +42536,24 @@ export const EventsPassesAddonsApiFp = function (configuration) {
|
|
|
42448
42536
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42449
42537
|
});
|
|
42450
42538
|
},
|
|
42539
|
+
/**
|
|
42540
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42541
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42542
|
+
* @param {string} eventId The event identifier
|
|
42543
|
+
* @param {string} passId The pass identifier
|
|
42544
|
+
* @param {string} addOnId The addOn identifier
|
|
42545
|
+
* @param {*} [options] Override http request option.
|
|
42546
|
+
* @throws {RequiredError}
|
|
42547
|
+
*/
|
|
42548
|
+
fulfillEventPassAddOn(eventId, passId, addOnId, options) {
|
|
42549
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42550
|
+
var _a, _b, _c;
|
|
42551
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.fulfillEventPassAddOn(eventId, passId, addOnId, options);
|
|
42552
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42553
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPassesAddonsApi.fulfillEventPassAddOn']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42554
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42555
|
+
});
|
|
42556
|
+
},
|
|
42451
42557
|
/**
|
|
42452
42558
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42453
42559
|
* @summary List an event pass\'s add-ons
|
|
@@ -42487,6 +42593,24 @@ export const EventsPassesAddonsApiFp = function (configuration) {
|
|
|
42487
42593
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42488
42594
|
});
|
|
42489
42595
|
},
|
|
42596
|
+
/**
|
|
42597
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42598
|
+
* @summary Undo an add-on fulfillment
|
|
42599
|
+
* @param {string} eventId The event identifier
|
|
42600
|
+
* @param {string} passId The pass identifier
|
|
42601
|
+
* @param {string} addOnId The addOn identifier
|
|
42602
|
+
* @param {*} [options] Override http request option.
|
|
42603
|
+
* @throws {RequiredError}
|
|
42604
|
+
*/
|
|
42605
|
+
unfulfillEventPassAddOn(eventId, passId, addOnId, options) {
|
|
42606
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42607
|
+
var _a, _b, _c;
|
|
42608
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.unfulfillEventPassAddOn(eventId, passId, addOnId, options);
|
|
42609
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42610
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPassesAddonsApi.unfulfillEventPassAddOn']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42611
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42612
|
+
});
|
|
42613
|
+
},
|
|
42490
42614
|
};
|
|
42491
42615
|
};
|
|
42492
42616
|
/**
|
|
@@ -42505,6 +42629,16 @@ export const EventsPassesAddonsApiFactory = function (configuration, basePath, a
|
|
|
42505
42629
|
addEventPassAddOn(requestParameters, options) {
|
|
42506
42630
|
return localVarFp.addEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42507
42631
|
},
|
|
42632
|
+
/**
|
|
42633
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42634
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42635
|
+
* @param {EventsPassesAddonsApiFulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42636
|
+
* @param {*} [options] Override http request option.
|
|
42637
|
+
* @throws {RequiredError}
|
|
42638
|
+
*/
|
|
42639
|
+
fulfillEventPassAddOn(requestParameters, options) {
|
|
42640
|
+
return localVarFp.fulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42641
|
+
},
|
|
42508
42642
|
/**
|
|
42509
42643
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42510
42644
|
* @summary List an event pass\'s add-ons
|
|
@@ -42525,6 +42659,16 @@ export const EventsPassesAddonsApiFactory = function (configuration, basePath, a
|
|
|
42525
42659
|
removeEventPassAddOn(requestParameters, options) {
|
|
42526
42660
|
return localVarFp.removeEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42527
42661
|
},
|
|
42662
|
+
/**
|
|
42663
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42664
|
+
* @summary Undo an add-on fulfillment
|
|
42665
|
+
* @param {EventsPassesAddonsApiUnfulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42666
|
+
* @param {*} [options] Override http request option.
|
|
42667
|
+
* @throws {RequiredError}
|
|
42668
|
+
*/
|
|
42669
|
+
unfulfillEventPassAddOn(requestParameters, options) {
|
|
42670
|
+
return localVarFp.unfulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42671
|
+
},
|
|
42528
42672
|
};
|
|
42529
42673
|
};
|
|
42530
42674
|
/**
|
|
@@ -42541,6 +42685,16 @@ export class EventsPassesAddonsApi extends BaseAPI {
|
|
|
42541
42685
|
addEventPassAddOn(requestParameters, options) {
|
|
42542
42686
|
return EventsPassesAddonsApiFp(this.configuration).addEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42543
42687
|
}
|
|
42688
|
+
/**
|
|
42689
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42690
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42691
|
+
* @param {EventsPassesAddonsApiFulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42692
|
+
* @param {*} [options] Override http request option.
|
|
42693
|
+
* @throws {RequiredError}
|
|
42694
|
+
*/
|
|
42695
|
+
fulfillEventPassAddOn(requestParameters, options) {
|
|
42696
|
+
return EventsPassesAddonsApiFp(this.configuration).fulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42697
|
+
}
|
|
42544
42698
|
/**
|
|
42545
42699
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42546
42700
|
* @summary List an event pass\'s add-ons
|
|
@@ -42561,6 +42715,16 @@ export class EventsPassesAddonsApi extends BaseAPI {
|
|
|
42561
42715
|
removeEventPassAddOn(requestParameters, options) {
|
|
42562
42716
|
return EventsPassesAddonsApiFp(this.configuration).removeEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42563
42717
|
}
|
|
42718
|
+
/**
|
|
42719
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42720
|
+
* @summary Undo an add-on fulfillment
|
|
42721
|
+
* @param {EventsPassesAddonsApiUnfulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42722
|
+
* @param {*} [options] Override http request option.
|
|
42723
|
+
* @throws {RequiredError}
|
|
42724
|
+
*/
|
|
42725
|
+
unfulfillEventPassAddOn(requestParameters, options) {
|
|
42726
|
+
return EventsPassesAddonsApiFp(this.configuration).unfulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42727
|
+
}
|
|
42564
42728
|
}
|
|
42565
42729
|
/**
|
|
42566
42730
|
* EventsPassesAttributesApi - axios parameter creator
|
package/docs/BasePassAddOn.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**addOnId** | **string** | | [default to undefined]
|
|
9
9
|
**addOn** | [**BaseEventAddOn**](BaseEventAddOn.md) | | [default to undefined]
|
|
10
|
+
**fulfilledAt** | **string** | | [default to undefined]
|
|
10
11
|
**pass** | [**BasePassAddOnPass**](BasePassAddOnPass.md) | | [default to undefined]
|
|
11
12
|
**createdAt** | **string** | | [default to undefined]
|
|
12
13
|
|
|
@@ -18,6 +19,7 @@ import { BasePassAddOn } from '@connectedxm/admin-sdk';
|
|
|
18
19
|
const instance: BasePassAddOn = {
|
|
19
20
|
addOnId,
|
|
20
21
|
addOn,
|
|
22
|
+
fulfilledAt,
|
|
21
23
|
pass,
|
|
22
24
|
createdAt,
|
|
23
25
|
};
|
|
@@ -5,8 +5,10 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add an add-on to an attendee\'s pass|
|
|
8
|
+
|[**fulfillEventPassAddOn**](#fulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/fulfill | Fulfill an add-on on an attendee\'s pass|
|
|
8
9
|
|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | List an event pass\'s add-ons|
|
|
9
10
|
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove an add-on from an attendee\'s pass|
|
|
11
|
+
|[**unfulfillEventPassAddOn**](#unfulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/undo | Undo an add-on fulfillment|
|
|
10
12
|
|
|
11
13
|
# **addEventPassAddOn**
|
|
12
14
|
> CreateEventPass200Response addEventPassAddOn()
|
|
@@ -58,6 +60,63 @@ const { status, data } = await apiInstance.addEventPassAddOn(
|
|
|
58
60
|
- **Accept**: application/json
|
|
59
61
|
|
|
60
62
|
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**200** | Successful response | - |
|
|
67
|
+
|
|
68
|
+
[[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)
|
|
69
|
+
|
|
70
|
+
# **fulfillEventPassAddOn**
|
|
71
|
+
> FulfillEventPassAddOn200Response fulfillEventPassAddOn()
|
|
72
|
+
|
|
73
|
+
Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
EventsPassesAddonsApi,
|
|
80
|
+
Configuration
|
|
81
|
+
} from '@connectedxm/admin-sdk';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new EventsPassesAddonsApi(configuration);
|
|
85
|
+
|
|
86
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
87
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
88
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.fulfillEventPassAddOn(
|
|
91
|
+
eventId,
|
|
92
|
+
passId,
|
|
93
|
+
addOnId
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
102
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
103
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
**FulfillEventPassAddOn200Response**
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: Not defined
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
61
120
|
### HTTP response details
|
|
62
121
|
| Status code | Description | Response headers |
|
|
63
122
|
|-------------|-------------|------------------|
|
|
@@ -188,3 +247,60 @@ const { status, data } = await apiInstance.removeEventPassAddOn(
|
|
|
188
247
|
|
|
189
248
|
[[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)
|
|
190
249
|
|
|
250
|
+
# **unfulfillEventPassAddOn**
|
|
251
|
+
> FulfillEventPassAddOn200Response unfulfillEventPassAddOn()
|
|
252
|
+
|
|
253
|
+
Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
254
|
+
|
|
255
|
+
### Example
|
|
256
|
+
|
|
257
|
+
```typescript
|
|
258
|
+
import {
|
|
259
|
+
EventsPassesAddonsApi,
|
|
260
|
+
Configuration
|
|
261
|
+
} from '@connectedxm/admin-sdk';
|
|
262
|
+
|
|
263
|
+
const configuration = new Configuration();
|
|
264
|
+
const apiInstance = new EventsPassesAddonsApi(configuration);
|
|
265
|
+
|
|
266
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
267
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
268
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
269
|
+
|
|
270
|
+
const { status, data } = await apiInstance.unfulfillEventPassAddOn(
|
|
271
|
+
eventId,
|
|
272
|
+
passId,
|
|
273
|
+
addOnId
|
|
274
|
+
);
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Parameters
|
|
278
|
+
|
|
279
|
+
|Name | Type | Description | Notes|
|
|
280
|
+
|------------- | ------------- | ------------- | -------------|
|
|
281
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
282
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
283
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
### Return type
|
|
287
|
+
|
|
288
|
+
**FulfillEventPassAddOn200Response**
|
|
289
|
+
|
|
290
|
+
### Authorization
|
|
291
|
+
|
|
292
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
293
|
+
|
|
294
|
+
### HTTP request headers
|
|
295
|
+
|
|
296
|
+
- **Content-Type**: Not defined
|
|
297
|
+
- **Accept**: application/json
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
### HTTP response details
|
|
301
|
+
| Status code | Description | Response headers |
|
|
302
|
+
|-------------|-------------|------------------|
|
|
303
|
+
|**200** | Successful response | - |
|
|
304
|
+
|
|
305
|
+
[[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)
|
|
306
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FulfillEventPassAddOn200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**PassAddOn**](PassAddOn.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FulfillEventPassAddOn200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: FulfillEventPassAddOn200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
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)
|
package/docs/PassAddOn.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**addOnId** | **string** | | [default to undefined]
|
|
9
9
|
**addOn** | [**BaseEventAddOn**](BaseEventAddOn.md) | | [default to undefined]
|
|
10
|
+
**fulfilledAt** | **string** | | [default to undefined]
|
|
10
11
|
**createdAt** | **string** | | [default to undefined]
|
|
11
12
|
**pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
|
|
12
13
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -19,6 +20,7 @@ import { PassAddOn } from '@connectedxm/admin-sdk';
|
|
|
19
20
|
const instance: PassAddOn = {
|
|
20
21
|
addOnId,
|
|
21
22
|
addOn,
|
|
23
|
+
fulfilledAt,
|
|
22
24
|
createdAt,
|
|
23
25
|
pass,
|
|
24
26
|
updatedAt,
|