@connectedxm/admin-sdk 7.4.0 → 7.5.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 +0 -1
- package/README.md +3 -1
- package/api.ts +389 -5
- package/dist/api.d.ts +199 -5
- package/dist/api.js +276 -0
- package/dist/esm/api.d.ts +199 -5
- package/dist/esm/api.js +276 -0
- package/docs/BaseEventPass.md +2 -2
- package/docs/Coupon.md +4 -0
- package/docs/EventPass.md +2 -2
- package/docs/EventsCouponsApi.md +192 -0
- package/package.json +1 -1
- package/docs/BaseEventPassTransfer.md +0 -20
package/dist/esm/api.js
CHANGED
|
@@ -29592,6 +29592,54 @@ export class EventsCohostsApi extends BaseAPI {
|
|
|
29592
29592
|
*/
|
|
29593
29593
|
export const EventsCouponsApiAxiosParamCreator = function (configuration) {
|
|
29594
29594
|
return {
|
|
29595
|
+
/**
|
|
29596
|
+
* Add Event Coupon Tier endpoint
|
|
29597
|
+
* @summary Add Event Coupon Tier
|
|
29598
|
+
* @param {string} eventId The event identifier
|
|
29599
|
+
* @param {string} couponId The coupon identifier
|
|
29600
|
+
* @param {string} tierId The tier identifier
|
|
29601
|
+
* @param {boolean} allowed Filter by allowed
|
|
29602
|
+
* @param {*} [options] Override http request option.
|
|
29603
|
+
* @throws {RequiredError}
|
|
29604
|
+
*/
|
|
29605
|
+
addEventCouponTier: (eventId_1, couponId_1, tierId_1, allowed_1, ...args_1) => __awaiter(this, [eventId_1, couponId_1, tierId_1, allowed_1, ...args_1], void 0, function* (eventId, couponId, tierId, allowed, options = {}) {
|
|
29606
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
29607
|
+
assertParamExists('addEventCouponTier', 'eventId', eventId);
|
|
29608
|
+
// verify required parameter 'couponId' is not null or undefined
|
|
29609
|
+
assertParamExists('addEventCouponTier', 'couponId', couponId);
|
|
29610
|
+
// verify required parameter 'tierId' is not null or undefined
|
|
29611
|
+
assertParamExists('addEventCouponTier', 'tierId', tierId);
|
|
29612
|
+
// verify required parameter 'allowed' is not null or undefined
|
|
29613
|
+
assertParamExists('addEventCouponTier', 'allowed', allowed);
|
|
29614
|
+
const localVarPath = `/events/{eventId}/coupons/{couponId}/tiers/{tierId}`
|
|
29615
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
29616
|
+
.replace(`{${"couponId"}}`, encodeURIComponent(String(couponId)))
|
|
29617
|
+
.replace(`{${"tierId"}}`, encodeURIComponent(String(tierId)));
|
|
29618
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29619
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29620
|
+
let baseOptions;
|
|
29621
|
+
if (configuration) {
|
|
29622
|
+
baseOptions = configuration.baseOptions;
|
|
29623
|
+
}
|
|
29624
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
29625
|
+
const localVarHeaderParameter = {};
|
|
29626
|
+
const localVarQueryParameter = {};
|
|
29627
|
+
// authentication ApiKeyAuth required
|
|
29628
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
29629
|
+
// authentication OrganizationId required
|
|
29630
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
29631
|
+
if (allowed !== undefined) {
|
|
29632
|
+
localVarQueryParameter['allowed'] = allowed;
|
|
29633
|
+
}
|
|
29634
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
29635
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
29636
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
29637
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
29638
|
+
return {
|
|
29639
|
+
url: toPathString(localVarUrlObj),
|
|
29640
|
+
options: localVarRequestOptions,
|
|
29641
|
+
};
|
|
29642
|
+
}),
|
|
29595
29643
|
/**
|
|
29596
29644
|
* Create Event Coupon endpoint
|
|
29597
29645
|
* @summary Create Event Coupon
|
|
@@ -29896,6 +29944,66 @@ export const EventsCouponsApiAxiosParamCreator = function (configuration) {
|
|
|
29896
29944
|
options: localVarRequestOptions,
|
|
29897
29945
|
};
|
|
29898
29946
|
}),
|
|
29947
|
+
/**
|
|
29948
|
+
* Get Event Coupon Tiers endpoint
|
|
29949
|
+
* @summary Get Event Coupon Tiers
|
|
29950
|
+
* @param {string} eventId The event identifier
|
|
29951
|
+
* @param {string} couponId The coupon identifier
|
|
29952
|
+
* @param {boolean} allowed Filter by allowed
|
|
29953
|
+
* @param {number} [page] Page number
|
|
29954
|
+
* @param {number} [pageSize] Number of items per page
|
|
29955
|
+
* @param {string} [orderBy] Field to order by
|
|
29956
|
+
* @param {string} [search] Search query
|
|
29957
|
+
* @param {*} [options] Override http request option.
|
|
29958
|
+
* @throws {RequiredError}
|
|
29959
|
+
*/
|
|
29960
|
+
getEventCouponTiers: (eventId_1, couponId_1, allowed_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, couponId_1, allowed_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, couponId, allowed, page, pageSize, orderBy, search, options = {}) {
|
|
29961
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
29962
|
+
assertParamExists('getEventCouponTiers', 'eventId', eventId);
|
|
29963
|
+
// verify required parameter 'couponId' is not null or undefined
|
|
29964
|
+
assertParamExists('getEventCouponTiers', 'couponId', couponId);
|
|
29965
|
+
// verify required parameter 'allowed' is not null or undefined
|
|
29966
|
+
assertParamExists('getEventCouponTiers', 'allowed', allowed);
|
|
29967
|
+
const localVarPath = `/events/{eventId}/coupons/{couponId}/tiers`
|
|
29968
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
29969
|
+
.replace(`{${"couponId"}}`, encodeURIComponent(String(couponId)));
|
|
29970
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29971
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29972
|
+
let baseOptions;
|
|
29973
|
+
if (configuration) {
|
|
29974
|
+
baseOptions = configuration.baseOptions;
|
|
29975
|
+
}
|
|
29976
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
29977
|
+
const localVarHeaderParameter = {};
|
|
29978
|
+
const localVarQueryParameter = {};
|
|
29979
|
+
// authentication ApiKeyAuth required
|
|
29980
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
29981
|
+
// authentication OrganizationId required
|
|
29982
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
29983
|
+
if (allowed !== undefined) {
|
|
29984
|
+
localVarQueryParameter['allowed'] = allowed;
|
|
29985
|
+
}
|
|
29986
|
+
if (page !== undefined) {
|
|
29987
|
+
localVarQueryParameter['page'] = page;
|
|
29988
|
+
}
|
|
29989
|
+
if (pageSize !== undefined) {
|
|
29990
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
29991
|
+
}
|
|
29992
|
+
if (orderBy !== undefined) {
|
|
29993
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
29994
|
+
}
|
|
29995
|
+
if (search !== undefined) {
|
|
29996
|
+
localVarQueryParameter['search'] = search;
|
|
29997
|
+
}
|
|
29998
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
29999
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30000
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30001
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
30002
|
+
return {
|
|
30003
|
+
url: toPathString(localVarUrlObj),
|
|
30004
|
+
options: localVarRequestOptions,
|
|
30005
|
+
};
|
|
30006
|
+
}),
|
|
29899
30007
|
/**
|
|
29900
30008
|
* Get Event Coupon Variants endpoint
|
|
29901
30009
|
* @summary Get Event Coupon Variants
|
|
@@ -30010,6 +30118,54 @@ export const EventsCouponsApiAxiosParamCreator = function (configuration) {
|
|
|
30010
30118
|
options: localVarRequestOptions,
|
|
30011
30119
|
};
|
|
30012
30120
|
}),
|
|
30121
|
+
/**
|
|
30122
|
+
* Remove Event Coupon Tier endpoint
|
|
30123
|
+
* @summary Remove Event Coupon Tier
|
|
30124
|
+
* @param {string} eventId The event identifier
|
|
30125
|
+
* @param {string} couponId The coupon identifier
|
|
30126
|
+
* @param {string} tierId The tier identifier
|
|
30127
|
+
* @param {boolean} allowed Filter by allowed
|
|
30128
|
+
* @param {*} [options] Override http request option.
|
|
30129
|
+
* @throws {RequiredError}
|
|
30130
|
+
*/
|
|
30131
|
+
removeEventCouponTier: (eventId_1, couponId_1, tierId_1, allowed_1, ...args_1) => __awaiter(this, [eventId_1, couponId_1, tierId_1, allowed_1, ...args_1], void 0, function* (eventId, couponId, tierId, allowed, options = {}) {
|
|
30132
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
30133
|
+
assertParamExists('removeEventCouponTier', 'eventId', eventId);
|
|
30134
|
+
// verify required parameter 'couponId' is not null or undefined
|
|
30135
|
+
assertParamExists('removeEventCouponTier', 'couponId', couponId);
|
|
30136
|
+
// verify required parameter 'tierId' is not null or undefined
|
|
30137
|
+
assertParamExists('removeEventCouponTier', 'tierId', tierId);
|
|
30138
|
+
// verify required parameter 'allowed' is not null or undefined
|
|
30139
|
+
assertParamExists('removeEventCouponTier', 'allowed', allowed);
|
|
30140
|
+
const localVarPath = `/events/{eventId}/coupons/{couponId}/tiers/{tierId}`
|
|
30141
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
30142
|
+
.replace(`{${"couponId"}}`, encodeURIComponent(String(couponId)))
|
|
30143
|
+
.replace(`{${"tierId"}}`, encodeURIComponent(String(tierId)));
|
|
30144
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30145
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30146
|
+
let baseOptions;
|
|
30147
|
+
if (configuration) {
|
|
30148
|
+
baseOptions = configuration.baseOptions;
|
|
30149
|
+
}
|
|
30150
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
30151
|
+
const localVarHeaderParameter = {};
|
|
30152
|
+
const localVarQueryParameter = {};
|
|
30153
|
+
// authentication ApiKeyAuth required
|
|
30154
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
30155
|
+
// authentication OrganizationId required
|
|
30156
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
30157
|
+
if (allowed !== undefined) {
|
|
30158
|
+
localVarQueryParameter['allowed'] = allowed;
|
|
30159
|
+
}
|
|
30160
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
30161
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30162
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30163
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
30164
|
+
return {
|
|
30165
|
+
url: toPathString(localVarUrlObj),
|
|
30166
|
+
options: localVarRequestOptions,
|
|
30167
|
+
};
|
|
30168
|
+
}),
|
|
30013
30169
|
/**
|
|
30014
30170
|
* Sync Event Coupon To Variants endpoint
|
|
30015
30171
|
* @summary Sync Event Coupon To Variants
|
|
@@ -30104,6 +30260,25 @@ export const EventsCouponsApiAxiosParamCreator = function (configuration) {
|
|
|
30104
30260
|
export const EventsCouponsApiFp = function (configuration) {
|
|
30105
30261
|
const localVarAxiosParamCreator = EventsCouponsApiAxiosParamCreator(configuration);
|
|
30106
30262
|
return {
|
|
30263
|
+
/**
|
|
30264
|
+
* Add Event Coupon Tier endpoint
|
|
30265
|
+
* @summary Add Event Coupon Tier
|
|
30266
|
+
* @param {string} eventId The event identifier
|
|
30267
|
+
* @param {string} couponId The coupon identifier
|
|
30268
|
+
* @param {string} tierId The tier identifier
|
|
30269
|
+
* @param {boolean} allowed Filter by allowed
|
|
30270
|
+
* @param {*} [options] Override http request option.
|
|
30271
|
+
* @throws {RequiredError}
|
|
30272
|
+
*/
|
|
30273
|
+
addEventCouponTier(eventId, couponId, tierId, allowed, options) {
|
|
30274
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
30275
|
+
var _a, _b, _c;
|
|
30276
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addEventCouponTier(eventId, couponId, tierId, allowed, options);
|
|
30277
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
30278
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsCouponsApi.addEventCouponTier']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
30279
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
30280
|
+
});
|
|
30281
|
+
},
|
|
30107
30282
|
/**
|
|
30108
30283
|
* Create Event Coupon endpoint
|
|
30109
30284
|
* @summary Create Event Coupon
|
|
@@ -30232,6 +30407,28 @@ export const EventsCouponsApiFp = function (configuration) {
|
|
|
30232
30407
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
30233
30408
|
});
|
|
30234
30409
|
},
|
|
30410
|
+
/**
|
|
30411
|
+
* Get Event Coupon Tiers endpoint
|
|
30412
|
+
* @summary Get Event Coupon Tiers
|
|
30413
|
+
* @param {string} eventId The event identifier
|
|
30414
|
+
* @param {string} couponId The coupon identifier
|
|
30415
|
+
* @param {boolean} allowed Filter by allowed
|
|
30416
|
+
* @param {number} [page] Page number
|
|
30417
|
+
* @param {number} [pageSize] Number of items per page
|
|
30418
|
+
* @param {string} [orderBy] Field to order by
|
|
30419
|
+
* @param {string} [search] Search query
|
|
30420
|
+
* @param {*} [options] Override http request option.
|
|
30421
|
+
* @throws {RequiredError}
|
|
30422
|
+
*/
|
|
30423
|
+
getEventCouponTiers(eventId, couponId, allowed, page, pageSize, orderBy, search, options) {
|
|
30424
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
30425
|
+
var _a, _b, _c;
|
|
30426
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventCouponTiers(eventId, couponId, allowed, page, pageSize, orderBy, search, options);
|
|
30427
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
30428
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsCouponsApi.getEventCouponTiers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
30429
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
30430
|
+
});
|
|
30431
|
+
},
|
|
30235
30432
|
/**
|
|
30236
30433
|
* Get Event Coupon Variants endpoint
|
|
30237
30434
|
* @summary Get Event Coupon Variants
|
|
@@ -30275,6 +30472,25 @@ export const EventsCouponsApiFp = function (configuration) {
|
|
|
30275
30472
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
30276
30473
|
});
|
|
30277
30474
|
},
|
|
30475
|
+
/**
|
|
30476
|
+
* Remove Event Coupon Tier endpoint
|
|
30477
|
+
* @summary Remove Event Coupon Tier
|
|
30478
|
+
* @param {string} eventId The event identifier
|
|
30479
|
+
* @param {string} couponId The coupon identifier
|
|
30480
|
+
* @param {string} tierId The tier identifier
|
|
30481
|
+
* @param {boolean} allowed Filter by allowed
|
|
30482
|
+
* @param {*} [options] Override http request option.
|
|
30483
|
+
* @throws {RequiredError}
|
|
30484
|
+
*/
|
|
30485
|
+
removeEventCouponTier(eventId, couponId, tierId, allowed, options) {
|
|
30486
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
30487
|
+
var _a, _b, _c;
|
|
30488
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.removeEventCouponTier(eventId, couponId, tierId, allowed, options);
|
|
30489
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
30490
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsCouponsApi.removeEventCouponTier']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
30491
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
30492
|
+
});
|
|
30493
|
+
},
|
|
30278
30494
|
/**
|
|
30279
30495
|
* Sync Event Coupon To Variants endpoint
|
|
30280
30496
|
* @summary Sync Event Coupon To Variants
|
|
@@ -30319,6 +30535,16 @@ export const EventsCouponsApiFp = function (configuration) {
|
|
|
30319
30535
|
export const EventsCouponsApiFactory = function (configuration, basePath, axios) {
|
|
30320
30536
|
const localVarFp = EventsCouponsApiFp(configuration);
|
|
30321
30537
|
return {
|
|
30538
|
+
/**
|
|
30539
|
+
* Add Event Coupon Tier endpoint
|
|
30540
|
+
* @summary Add Event Coupon Tier
|
|
30541
|
+
* @param {EventsCouponsApiAddEventCouponTierRequest} requestParameters Request parameters.
|
|
30542
|
+
* @param {*} [options] Override http request option.
|
|
30543
|
+
* @throws {RequiredError}
|
|
30544
|
+
*/
|
|
30545
|
+
addEventCouponTier(requestParameters, options) {
|
|
30546
|
+
return localVarFp.addEventCouponTier(requestParameters.eventId, requestParameters.couponId, requestParameters.tierId, requestParameters.allowed, options).then((request) => request(axios, basePath));
|
|
30547
|
+
},
|
|
30322
30548
|
/**
|
|
30323
30549
|
* Create Event Coupon endpoint
|
|
30324
30550
|
* @summary Create Event Coupon
|
|
@@ -30389,6 +30615,16 @@ export const EventsCouponsApiFactory = function (configuration, basePath, axios)
|
|
|
30389
30615
|
getEventCouponPayments(requestParameters, options) {
|
|
30390
30616
|
return localVarFp.getEventCouponPayments(requestParameters.eventId, requestParameters.couponId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
30391
30617
|
},
|
|
30618
|
+
/**
|
|
30619
|
+
* Get Event Coupon Tiers endpoint
|
|
30620
|
+
* @summary Get Event Coupon Tiers
|
|
30621
|
+
* @param {EventsCouponsApiGetEventCouponTiersRequest} requestParameters Request parameters.
|
|
30622
|
+
* @param {*} [options] Override http request option.
|
|
30623
|
+
* @throws {RequiredError}
|
|
30624
|
+
*/
|
|
30625
|
+
getEventCouponTiers(requestParameters, options) {
|
|
30626
|
+
return localVarFp.getEventCouponTiers(requestParameters.eventId, requestParameters.couponId, requestParameters.allowed, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
30627
|
+
},
|
|
30392
30628
|
/**
|
|
30393
30629
|
* Get Event Coupon Variants endpoint
|
|
30394
30630
|
* @summary Get Event Coupon Variants
|
|
@@ -30409,6 +30645,16 @@ export const EventsCouponsApiFactory = function (configuration, basePath, axios)
|
|
|
30409
30645
|
getEventCoupons(requestParameters, options) {
|
|
30410
30646
|
return localVarFp.getEventCoupons(requestParameters.eventId, requestParameters.prePaid, requestParameters.includeVariants, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
30411
30647
|
},
|
|
30648
|
+
/**
|
|
30649
|
+
* Remove Event Coupon Tier endpoint
|
|
30650
|
+
* @summary Remove Event Coupon Tier
|
|
30651
|
+
* @param {EventsCouponsApiRemoveEventCouponTierRequest} requestParameters Request parameters.
|
|
30652
|
+
* @param {*} [options] Override http request option.
|
|
30653
|
+
* @throws {RequiredError}
|
|
30654
|
+
*/
|
|
30655
|
+
removeEventCouponTier(requestParameters, options) {
|
|
30656
|
+
return localVarFp.removeEventCouponTier(requestParameters.eventId, requestParameters.couponId, requestParameters.tierId, requestParameters.allowed, options).then((request) => request(axios, basePath));
|
|
30657
|
+
},
|
|
30412
30658
|
/**
|
|
30413
30659
|
* Sync Event Coupon To Variants endpoint
|
|
30414
30660
|
* @summary Sync Event Coupon To Variants
|
|
@@ -30435,6 +30681,16 @@ export const EventsCouponsApiFactory = function (configuration, basePath, axios)
|
|
|
30435
30681
|
* EventsCouponsApi - object-oriented interface
|
|
30436
30682
|
*/
|
|
30437
30683
|
export class EventsCouponsApi extends BaseAPI {
|
|
30684
|
+
/**
|
|
30685
|
+
* Add Event Coupon Tier endpoint
|
|
30686
|
+
* @summary Add Event Coupon Tier
|
|
30687
|
+
* @param {EventsCouponsApiAddEventCouponTierRequest} requestParameters Request parameters.
|
|
30688
|
+
* @param {*} [options] Override http request option.
|
|
30689
|
+
* @throws {RequiredError}
|
|
30690
|
+
*/
|
|
30691
|
+
addEventCouponTier(requestParameters, options) {
|
|
30692
|
+
return EventsCouponsApiFp(this.configuration).addEventCouponTier(requestParameters.eventId, requestParameters.couponId, requestParameters.tierId, requestParameters.allowed, options).then((request) => request(this.axios, this.basePath));
|
|
30693
|
+
}
|
|
30438
30694
|
/**
|
|
30439
30695
|
* Create Event Coupon endpoint
|
|
30440
30696
|
* @summary Create Event Coupon
|
|
@@ -30505,6 +30761,16 @@ export class EventsCouponsApi extends BaseAPI {
|
|
|
30505
30761
|
getEventCouponPayments(requestParameters, options) {
|
|
30506
30762
|
return EventsCouponsApiFp(this.configuration).getEventCouponPayments(requestParameters.eventId, requestParameters.couponId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
30507
30763
|
}
|
|
30764
|
+
/**
|
|
30765
|
+
* Get Event Coupon Tiers endpoint
|
|
30766
|
+
* @summary Get Event Coupon Tiers
|
|
30767
|
+
* @param {EventsCouponsApiGetEventCouponTiersRequest} requestParameters Request parameters.
|
|
30768
|
+
* @param {*} [options] Override http request option.
|
|
30769
|
+
* @throws {RequiredError}
|
|
30770
|
+
*/
|
|
30771
|
+
getEventCouponTiers(requestParameters, options) {
|
|
30772
|
+
return EventsCouponsApiFp(this.configuration).getEventCouponTiers(requestParameters.eventId, requestParameters.couponId, requestParameters.allowed, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
30773
|
+
}
|
|
30508
30774
|
/**
|
|
30509
30775
|
* Get Event Coupon Variants endpoint
|
|
30510
30776
|
* @summary Get Event Coupon Variants
|
|
@@ -30525,6 +30791,16 @@ export class EventsCouponsApi extends BaseAPI {
|
|
|
30525
30791
|
getEventCoupons(requestParameters, options) {
|
|
30526
30792
|
return EventsCouponsApiFp(this.configuration).getEventCoupons(requestParameters.eventId, requestParameters.prePaid, requestParameters.includeVariants, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
30527
30793
|
}
|
|
30794
|
+
/**
|
|
30795
|
+
* Remove Event Coupon Tier endpoint
|
|
30796
|
+
* @summary Remove Event Coupon Tier
|
|
30797
|
+
* @param {EventsCouponsApiRemoveEventCouponTierRequest} requestParameters Request parameters.
|
|
30798
|
+
* @param {*} [options] Override http request option.
|
|
30799
|
+
* @throws {RequiredError}
|
|
30800
|
+
*/
|
|
30801
|
+
removeEventCouponTier(requestParameters, options) {
|
|
30802
|
+
return EventsCouponsApiFp(this.configuration).removeEventCouponTier(requestParameters.eventId, requestParameters.couponId, requestParameters.tierId, requestParameters.allowed, options).then((request) => request(this.axios, this.basePath));
|
|
30803
|
+
}
|
|
30528
30804
|
/**
|
|
30529
30805
|
* Sync Event Coupon To Variants endpoint
|
|
30530
30806
|
* @summary Sync Event Coupon To Variants
|
package/docs/BaseEventPass.md
CHANGED
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**ticket** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
15
15
|
**location** | **string** | | [default to undefined]
|
|
16
16
|
**usedAt** | **string** | | [default to undefined]
|
|
17
|
-
**
|
|
17
|
+
**transferId** | **string** | | [default to undefined]
|
|
18
18
|
**responses** | [**Array<BaseRegistrationQuestionResponse>**](BaseRegistrationQuestionResponse.md) | | [default to undefined]
|
|
19
19
|
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
|
|
20
20
|
**reservationId** | **string** | | [default to undefined]
|
|
@@ -43,7 +43,7 @@ const instance: BaseEventPass = {
|
|
|
43
43
|
ticket,
|
|
44
44
|
location,
|
|
45
45
|
usedAt,
|
|
46
|
-
|
|
46
|
+
transferId,
|
|
47
47
|
responses,
|
|
48
48
|
status,
|
|
49
49
|
reservationId,
|
package/docs/Coupon.md
CHANGED
|
@@ -29,6 +29,8 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**applyToSessions** | **boolean** | | [default to undefined]
|
|
30
30
|
**registrationId** | **string** | | [default to undefined]
|
|
31
31
|
**registration** | [**BaseEventAttendee**](BaseEventAttendee.md) | | [default to undefined]
|
|
32
|
+
**allowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
33
|
+
**disallowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
32
34
|
**lineItem** | [**PaymentLineItem**](PaymentLineItem.md) | | [default to undefined]
|
|
33
35
|
**parentCouponId** | **string** | | [default to undefined]
|
|
34
36
|
**parentCoupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
@@ -66,6 +68,8 @@ const instance: Coupon = {
|
|
|
66
68
|
applyToSessions,
|
|
67
69
|
registrationId,
|
|
68
70
|
registration,
|
|
71
|
+
allowedTiers,
|
|
72
|
+
disallowedTiers,
|
|
69
73
|
lineItem,
|
|
70
74
|
parentCouponId,
|
|
71
75
|
parentCoupon,
|
package/docs/EventPass.md
CHANGED
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**ticket** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
15
15
|
**location** | **string** | | [default to undefined]
|
|
16
16
|
**usedAt** | **string** | | [default to undefined]
|
|
17
|
-
**
|
|
17
|
+
**transferId** | **string** | | [default to undefined]
|
|
18
18
|
**responses** | [**Array<BaseRegistrationQuestionResponse>**](BaseRegistrationQuestionResponse.md) | | [default to undefined]
|
|
19
19
|
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
|
|
20
20
|
**reservationId** | **string** | | [default to undefined]
|
|
@@ -50,7 +50,7 @@ const instance: EventPass = {
|
|
|
50
50
|
ticket,
|
|
51
51
|
location,
|
|
52
52
|
usedAt,
|
|
53
|
-
|
|
53
|
+
transferId,
|
|
54
54
|
responses,
|
|
55
55
|
status,
|
|
56
56
|
reservationId,
|
package/docs/EventsCouponsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addEventCouponTier**](#addeventcoupontier) | **POST** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Add Event Coupon Tier|
|
|
7
8
|
|[**createEventCoupon**](#createeventcoupon) | **POST** /events/{eventId}/coupons | Create Event Coupon|
|
|
8
9
|
|[**createEventCouponVariants**](#createeventcouponvariants) | **POST** /events/{eventId}/coupons/{couponId}/variants | Create Event Coupon Variants|
|
|
9
10
|
|[**deleteEventCoupon**](#deleteeventcoupon) | **DELETE** /events/{eventId}/coupons/{couponId} | Delete Event Coupon|
|
|
@@ -11,11 +12,73 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
12
|
|[**getEventCoupon**](#geteventcoupon) | **GET** /events/{eventId}/coupons/{couponId} | Get Event Coupon|
|
|
12
13
|
|[**getEventCouponPasses**](#geteventcouponpasses) | **GET** /events/{eventId}/coupons/{couponId}/passes | Get Event Coupon Passes|
|
|
13
14
|
|[**getEventCouponPayments**](#geteventcouponpayments) | **GET** /events/{eventId}/coupons/{couponId}/payments | Get Event Coupon Payments|
|
|
15
|
+
|[**getEventCouponTiers**](#geteventcoupontiers) | **GET** /events/{eventId}/coupons/{couponId}/tiers | Get Event Coupon Tiers|
|
|
14
16
|
|[**getEventCouponVariants**](#geteventcouponvariants) | **GET** /events/{eventId}/coupons/{parentCouponId}/variants | Get Event Coupon Variants|
|
|
15
17
|
|[**getEventCoupons**](#geteventcoupons) | **GET** /events/{eventId}/coupons | Get Event Coupons|
|
|
18
|
+
|[**removeEventCouponTier**](#removeeventcoupontier) | **DELETE** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Remove Event Coupon Tier|
|
|
16
19
|
|[**syncEventCouponToVariants**](#synceventcoupontovariants) | **PUT** /events/{eventId}/coupons/{couponId}/variants | Sync Event Coupon To Variants|
|
|
17
20
|
|[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update Event Coupon|
|
|
18
21
|
|
|
22
|
+
# **addEventCouponTier**
|
|
23
|
+
> CreateEventCoupon200Response addEventCouponTier()
|
|
24
|
+
|
|
25
|
+
Add Event Coupon Tier endpoint
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import {
|
|
31
|
+
EventsCouponsApi,
|
|
32
|
+
Configuration
|
|
33
|
+
} from '@connectedxm/admin-sdk';
|
|
34
|
+
|
|
35
|
+
const configuration = new Configuration();
|
|
36
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
37
|
+
|
|
38
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
39
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
40
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
41
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
42
|
+
|
|
43
|
+
const { status, data } = await apiInstance.addEventCouponTier(
|
|
44
|
+
eventId,
|
|
45
|
+
couponId,
|
|
46
|
+
tierId,
|
|
47
|
+
allowed
|
|
48
|
+
);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
|Name | Type | Description | Notes|
|
|
54
|
+
|------------- | ------------- | ------------- | -------------|
|
|
55
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
56
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
57
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
58
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
**CreateEventCoupon200Response**
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: Not defined
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### HTTP response details
|
|
76
|
+
| Status code | Description | Response headers |
|
|
77
|
+
|-------------|-------------|------------------|
|
|
78
|
+
|**200** | Successful response | - |
|
|
79
|
+
|
|
80
|
+
[[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)
|
|
81
|
+
|
|
19
82
|
# **createEventCoupon**
|
|
20
83
|
> CreateEventCoupon200Response createEventCoupon(eventCouponCreateInputs)
|
|
21
84
|
|
|
@@ -416,6 +479,75 @@ const { status, data } = await apiInstance.getEventCouponPayments(
|
|
|
416
479
|
- **Accept**: application/json
|
|
417
480
|
|
|
418
481
|
|
|
482
|
+
### HTTP response details
|
|
483
|
+
| Status code | Description | Response headers |
|
|
484
|
+
|-------------|-------------|------------------|
|
|
485
|
+
|**200** | Successful response | - |
|
|
486
|
+
|
|
487
|
+
[[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)
|
|
488
|
+
|
|
489
|
+
# **getEventCouponTiers**
|
|
490
|
+
> GetAccountTiers200Response getEventCouponTiers()
|
|
491
|
+
|
|
492
|
+
Get Event Coupon Tiers endpoint
|
|
493
|
+
|
|
494
|
+
### Example
|
|
495
|
+
|
|
496
|
+
```typescript
|
|
497
|
+
import {
|
|
498
|
+
EventsCouponsApi,
|
|
499
|
+
Configuration
|
|
500
|
+
} from '@connectedxm/admin-sdk';
|
|
501
|
+
|
|
502
|
+
const configuration = new Configuration();
|
|
503
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
504
|
+
|
|
505
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
506
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
507
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
508
|
+
let page: number; //Page number (optional) (default to 1)
|
|
509
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
510
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
511
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
512
|
+
|
|
513
|
+
const { status, data } = await apiInstance.getEventCouponTiers(
|
|
514
|
+
eventId,
|
|
515
|
+
couponId,
|
|
516
|
+
allowed,
|
|
517
|
+
page,
|
|
518
|
+
pageSize,
|
|
519
|
+
orderBy,
|
|
520
|
+
search
|
|
521
|
+
);
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### Parameters
|
|
525
|
+
|
|
526
|
+
|Name | Type | Description | Notes|
|
|
527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
528
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
529
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
530
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
531
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
532
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
533
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
534
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
### Return type
|
|
538
|
+
|
|
539
|
+
**GetAccountTiers200Response**
|
|
540
|
+
|
|
541
|
+
### Authorization
|
|
542
|
+
|
|
543
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
544
|
+
|
|
545
|
+
### HTTP request headers
|
|
546
|
+
|
|
547
|
+
- **Content-Type**: Not defined
|
|
548
|
+
- **Accept**: application/json
|
|
549
|
+
|
|
550
|
+
|
|
419
551
|
### HTTP response details
|
|
420
552
|
| Status code | Description | Response headers |
|
|
421
553
|
|-------------|-------------|------------------|
|
|
@@ -551,6 +683,66 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
551
683
|
- **Accept**: application/json
|
|
552
684
|
|
|
553
685
|
|
|
686
|
+
### HTTP response details
|
|
687
|
+
| Status code | Description | Response headers |
|
|
688
|
+
|-------------|-------------|------------------|
|
|
689
|
+
|**200** | Successful response | - |
|
|
690
|
+
|
|
691
|
+
[[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)
|
|
692
|
+
|
|
693
|
+
# **removeEventCouponTier**
|
|
694
|
+
> CreateEventCoupon200Response removeEventCouponTier()
|
|
695
|
+
|
|
696
|
+
Remove Event Coupon Tier endpoint
|
|
697
|
+
|
|
698
|
+
### Example
|
|
699
|
+
|
|
700
|
+
```typescript
|
|
701
|
+
import {
|
|
702
|
+
EventsCouponsApi,
|
|
703
|
+
Configuration
|
|
704
|
+
} from '@connectedxm/admin-sdk';
|
|
705
|
+
|
|
706
|
+
const configuration = new Configuration();
|
|
707
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
708
|
+
|
|
709
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
710
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
711
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
712
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
713
|
+
|
|
714
|
+
const { status, data } = await apiInstance.removeEventCouponTier(
|
|
715
|
+
eventId,
|
|
716
|
+
couponId,
|
|
717
|
+
tierId,
|
|
718
|
+
allowed
|
|
719
|
+
);
|
|
720
|
+
```
|
|
721
|
+
|
|
722
|
+
### Parameters
|
|
723
|
+
|
|
724
|
+
|Name | Type | Description | Notes|
|
|
725
|
+
|------------- | ------------- | ------------- | -------------|
|
|
726
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
727
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
728
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
729
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
### Return type
|
|
733
|
+
|
|
734
|
+
**CreateEventCoupon200Response**
|
|
735
|
+
|
|
736
|
+
### Authorization
|
|
737
|
+
|
|
738
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
739
|
+
|
|
740
|
+
### HTTP request headers
|
|
741
|
+
|
|
742
|
+
- **Content-Type**: Not defined
|
|
743
|
+
- **Accept**: application/json
|
|
744
|
+
|
|
745
|
+
|
|
554
746
|
### HTTP response details
|
|
555
747
|
| Status code | Description | Response headers |
|
|
556
748
|
|-------------|-------------|------------------|
|
package/package.json
CHANGED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# BaseEventPassTransfer
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { BaseEventPassTransfer } from '@connectedxm/admin-sdk';
|
|
14
|
-
|
|
15
|
-
const instance: BaseEventPassTransfer = {
|
|
16
|
-
id,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|