@connectedxm/admin-sdk 7.12.9 → 7.13.1
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/README.md +3 -0
- package/api.ts +351 -0
- package/dist/api.d.ts +182 -0
- package/dist/api.js +256 -0
- package/dist/esm/api.d.ts +182 -0
- package/dist/esm/api.js +256 -0
- package/docs/BaseSideEffect.md +2 -0
- package/docs/EventMediaItem.md +2 -0
- package/docs/EventsMediaApi.md +183 -0
- package/docs/SideEffect.md +4 -0
- package/docs/SideEffectTriggerType.md +2 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -2432,6 +2432,7 @@ export var SideEffectActionType;
|
|
|
2432
2432
|
export var SideEffectTriggerType;
|
|
2433
2433
|
(function (SideEffectTriggerType) {
|
|
2434
2434
|
SideEffectTriggerType["CheckedInEventPass"] = "CHECKED_IN_EVENT_PASS";
|
|
2435
|
+
SideEffectTriggerType["CheckedInEventSession"] = "CHECKED_IN_EVENT_SESSION";
|
|
2435
2436
|
SideEffectTriggerType["NewAccountTier"] = "NEW_ACCOUNT_TIER";
|
|
2436
2437
|
SideEffectTriggerType["RemovedAccountTier"] = "REMOVED_ACCOUNT_TIER";
|
|
2437
2438
|
SideEffectTriggerType["NewPassOfPassType"] = "NEW_PASS_OF_PASS_TYPE";
|
|
@@ -36850,6 +36851,48 @@ export const EventsMediaApiAxiosParamCreator = function (configuration) {
|
|
|
36850
36851
|
options: localVarRequestOptions,
|
|
36851
36852
|
};
|
|
36852
36853
|
}),
|
|
36854
|
+
/**
|
|
36855
|
+
* Grants a specific account tier (tier/segment) access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.
|
|
36856
|
+
* @summary Restrict an event media item to a tier
|
|
36857
|
+
* @param {string} eventId The event identifier
|
|
36858
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
36859
|
+
* @param {string} tierId The tier identifier
|
|
36860
|
+
* @param {*} [options] Override http request option.
|
|
36861
|
+
* @throws {RequiredError}
|
|
36862
|
+
*/
|
|
36863
|
+
addEventMediaItemTier: (eventId_1, mediaItemId_1, tierId_1, ...args_1) => __awaiter(this, [eventId_1, mediaItemId_1, tierId_1, ...args_1], void 0, function* (eventId, mediaItemId, tierId, options = {}) {
|
|
36864
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
36865
|
+
assertParamExists('addEventMediaItemTier', 'eventId', eventId);
|
|
36866
|
+
// verify required parameter 'mediaItemId' is not null or undefined
|
|
36867
|
+
assertParamExists('addEventMediaItemTier', 'mediaItemId', mediaItemId);
|
|
36868
|
+
// verify required parameter 'tierId' is not null or undefined
|
|
36869
|
+
assertParamExists('addEventMediaItemTier', 'tierId', tierId);
|
|
36870
|
+
const localVarPath = `/events/{eventId}/media/{mediaItemId}/tiers/{tierId}`
|
|
36871
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
36872
|
+
.replace(`{${"mediaItemId"}}`, encodeURIComponent(String(mediaItemId)))
|
|
36873
|
+
.replace(`{${"tierId"}}`, encodeURIComponent(String(tierId)));
|
|
36874
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
36875
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
36876
|
+
let baseOptions;
|
|
36877
|
+
if (configuration) {
|
|
36878
|
+
baseOptions = configuration.baseOptions;
|
|
36879
|
+
}
|
|
36880
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
36881
|
+
const localVarHeaderParameter = {};
|
|
36882
|
+
const localVarQueryParameter = {};
|
|
36883
|
+
// authentication ApiKeyAuth required
|
|
36884
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
36885
|
+
// authentication OrganizationId required
|
|
36886
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
36887
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
36888
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
36889
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
36890
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
36891
|
+
return {
|
|
36892
|
+
url: toPathString(localVarUrlObj),
|
|
36893
|
+
options: localVarRequestOptions,
|
|
36894
|
+
};
|
|
36895
|
+
}),
|
|
36853
36896
|
/**
|
|
36854
36897
|
* Creates a new media item (image, video, or file) in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
36855
36898
|
* @summary Create an event media item
|
|
@@ -37019,6 +37062,60 @@ export const EventsMediaApiAxiosParamCreator = function (configuration) {
|
|
|
37019
37062
|
options: localVarRequestOptions,
|
|
37020
37063
|
};
|
|
37021
37064
|
}),
|
|
37065
|
+
/**
|
|
37066
|
+
* Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
37067
|
+
* @summary List tiers linked to a media item
|
|
37068
|
+
* @param {string} eventId The event identifier
|
|
37069
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
37070
|
+
* @param {number} [page] Page number
|
|
37071
|
+
* @param {number} [pageSize] Number of items per page
|
|
37072
|
+
* @param {string} [orderBy] Field to order by
|
|
37073
|
+
* @param {string} [search] Search query
|
|
37074
|
+
* @param {*} [options] Override http request option.
|
|
37075
|
+
* @throws {RequiredError}
|
|
37076
|
+
*/
|
|
37077
|
+
getEventMediaItemTiers: (eventId_1, mediaItemId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, mediaItemId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, mediaItemId, page, pageSize, orderBy, search, options = {}) {
|
|
37078
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
37079
|
+
assertParamExists('getEventMediaItemTiers', 'eventId', eventId);
|
|
37080
|
+
// verify required parameter 'mediaItemId' is not null or undefined
|
|
37081
|
+
assertParamExists('getEventMediaItemTiers', 'mediaItemId', mediaItemId);
|
|
37082
|
+
const localVarPath = `/events/{eventId}/media/{mediaItemId}/tiers`
|
|
37083
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
37084
|
+
.replace(`{${"mediaItemId"}}`, encodeURIComponent(String(mediaItemId)));
|
|
37085
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37086
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37087
|
+
let baseOptions;
|
|
37088
|
+
if (configuration) {
|
|
37089
|
+
baseOptions = configuration.baseOptions;
|
|
37090
|
+
}
|
|
37091
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
37092
|
+
const localVarHeaderParameter = {};
|
|
37093
|
+
const localVarQueryParameter = {};
|
|
37094
|
+
// authentication ApiKeyAuth required
|
|
37095
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
37096
|
+
// authentication OrganizationId required
|
|
37097
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
37098
|
+
if (page !== undefined) {
|
|
37099
|
+
localVarQueryParameter['page'] = page;
|
|
37100
|
+
}
|
|
37101
|
+
if (pageSize !== undefined) {
|
|
37102
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
37103
|
+
}
|
|
37104
|
+
if (orderBy !== undefined) {
|
|
37105
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
37106
|
+
}
|
|
37107
|
+
if (search !== undefined) {
|
|
37108
|
+
localVarQueryParameter['search'] = search;
|
|
37109
|
+
}
|
|
37110
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
37111
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37112
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37113
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
37114
|
+
return {
|
|
37115
|
+
url: toPathString(localVarUrlObj),
|
|
37116
|
+
options: localVarRequestOptions,
|
|
37117
|
+
};
|
|
37118
|
+
}),
|
|
37022
37119
|
/**
|
|
37023
37120
|
* Returns a paginated list of media items (images, videos, or files) belonging to the given event, optionally filtered by media type, with search and ordering support; requires read access to events and storage.
|
|
37024
37121
|
* @summary List an event\'s media items
|
|
@@ -37115,6 +37212,48 @@ export const EventsMediaApiAxiosParamCreator = function (configuration) {
|
|
|
37115
37212
|
options: localVarRequestOptions,
|
|
37116
37213
|
};
|
|
37117
37214
|
}),
|
|
37215
|
+
/**
|
|
37216
|
+
* Revokes an account tier\'s (tier/segment) access to an event media item, and requires read and update permission on both events and storage.
|
|
37217
|
+
* @summary Remove a tier restriction from an event media item
|
|
37218
|
+
* @param {string} eventId The event identifier
|
|
37219
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
37220
|
+
* @param {string} tierId The tier identifier
|
|
37221
|
+
* @param {*} [options] Override http request option.
|
|
37222
|
+
* @throws {RequiredError}
|
|
37223
|
+
*/
|
|
37224
|
+
removeEventMediaItemTier: (eventId_1, mediaItemId_1, tierId_1, ...args_1) => __awaiter(this, [eventId_1, mediaItemId_1, tierId_1, ...args_1], void 0, function* (eventId, mediaItemId, tierId, options = {}) {
|
|
37225
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
37226
|
+
assertParamExists('removeEventMediaItemTier', 'eventId', eventId);
|
|
37227
|
+
// verify required parameter 'mediaItemId' is not null or undefined
|
|
37228
|
+
assertParamExists('removeEventMediaItemTier', 'mediaItemId', mediaItemId);
|
|
37229
|
+
// verify required parameter 'tierId' is not null or undefined
|
|
37230
|
+
assertParamExists('removeEventMediaItemTier', 'tierId', tierId);
|
|
37231
|
+
const localVarPath = `/events/{eventId}/media/{mediaItemId}/tiers/{tierId}`
|
|
37232
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
37233
|
+
.replace(`{${"mediaItemId"}}`, encodeURIComponent(String(mediaItemId)))
|
|
37234
|
+
.replace(`{${"tierId"}}`, encodeURIComponent(String(tierId)));
|
|
37235
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37236
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37237
|
+
let baseOptions;
|
|
37238
|
+
if (configuration) {
|
|
37239
|
+
baseOptions = configuration.baseOptions;
|
|
37240
|
+
}
|
|
37241
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
37242
|
+
const localVarHeaderParameter = {};
|
|
37243
|
+
const localVarQueryParameter = {};
|
|
37244
|
+
// authentication ApiKeyAuth required
|
|
37245
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
37246
|
+
// authentication OrganizationId required
|
|
37247
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
37248
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
37249
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37250
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37251
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
37252
|
+
return {
|
|
37253
|
+
url: toPathString(localVarUrlObj),
|
|
37254
|
+
options: localVarRequestOptions,
|
|
37255
|
+
};
|
|
37256
|
+
}),
|
|
37118
37257
|
/**
|
|
37119
37258
|
* Updates the fields (such as name, type, or file references) of an existing media item in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
37120
37259
|
* @summary Update an event media item
|
|
@@ -37184,6 +37323,24 @@ export const EventsMediaApiFp = function (configuration) {
|
|
|
37184
37323
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
37185
37324
|
});
|
|
37186
37325
|
},
|
|
37326
|
+
/**
|
|
37327
|
+
* Grants a specific account tier (tier/segment) access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.
|
|
37328
|
+
* @summary Restrict an event media item to a tier
|
|
37329
|
+
* @param {string} eventId The event identifier
|
|
37330
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
37331
|
+
* @param {string} tierId The tier identifier
|
|
37332
|
+
* @param {*} [options] Override http request option.
|
|
37333
|
+
* @throws {RequiredError}
|
|
37334
|
+
*/
|
|
37335
|
+
addEventMediaItemTier(eventId, mediaItemId, tierId, options) {
|
|
37336
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37337
|
+
var _a, _b, _c;
|
|
37338
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addEventMediaItemTier(eventId, mediaItemId, tierId, options);
|
|
37339
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
37340
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsMediaApi.addEventMediaItemTier']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
37341
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
37342
|
+
});
|
|
37343
|
+
},
|
|
37187
37344
|
/**
|
|
37188
37345
|
* Creates a new media item (image, video, or file) in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
37189
37346
|
* @summary Create an event media item
|
|
@@ -37256,6 +37413,27 @@ export const EventsMediaApiFp = function (configuration) {
|
|
|
37256
37413
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
37257
37414
|
});
|
|
37258
37415
|
},
|
|
37416
|
+
/**
|
|
37417
|
+
* Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
37418
|
+
* @summary List tiers linked to a media item
|
|
37419
|
+
* @param {string} eventId The event identifier
|
|
37420
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
37421
|
+
* @param {number} [page] Page number
|
|
37422
|
+
* @param {number} [pageSize] Number of items per page
|
|
37423
|
+
* @param {string} [orderBy] Field to order by
|
|
37424
|
+
* @param {string} [search] Search query
|
|
37425
|
+
* @param {*} [options] Override http request option.
|
|
37426
|
+
* @throws {RequiredError}
|
|
37427
|
+
*/
|
|
37428
|
+
getEventMediaItemTiers(eventId, mediaItemId, page, pageSize, orderBy, search, options) {
|
|
37429
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37430
|
+
var _a, _b, _c;
|
|
37431
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventMediaItemTiers(eventId, mediaItemId, page, pageSize, orderBy, search, options);
|
|
37432
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
37433
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsMediaApi.getEventMediaItemTiers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
37434
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
37435
|
+
});
|
|
37436
|
+
},
|
|
37259
37437
|
/**
|
|
37260
37438
|
* Returns a paginated list of media items (images, videos, or files) belonging to the given event, optionally filtered by media type, with search and ordering support; requires read access to events and storage.
|
|
37261
37439
|
* @summary List an event\'s media items
|
|
@@ -37295,6 +37473,24 @@ export const EventsMediaApiFp = function (configuration) {
|
|
|
37295
37473
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
37296
37474
|
});
|
|
37297
37475
|
},
|
|
37476
|
+
/**
|
|
37477
|
+
* Revokes an account tier\'s (tier/segment) access to an event media item, and requires read and update permission on both events and storage.
|
|
37478
|
+
* @summary Remove a tier restriction from an event media item
|
|
37479
|
+
* @param {string} eventId The event identifier
|
|
37480
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
37481
|
+
* @param {string} tierId The tier identifier
|
|
37482
|
+
* @param {*} [options] Override http request option.
|
|
37483
|
+
* @throws {RequiredError}
|
|
37484
|
+
*/
|
|
37485
|
+
removeEventMediaItemTier(eventId, mediaItemId, tierId, options) {
|
|
37486
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37487
|
+
var _a, _b, _c;
|
|
37488
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.removeEventMediaItemTier(eventId, mediaItemId, tierId, options);
|
|
37489
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
37490
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsMediaApi.removeEventMediaItemTier']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
37491
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
37492
|
+
});
|
|
37493
|
+
},
|
|
37298
37494
|
/**
|
|
37299
37495
|
* Updates the fields (such as name, type, or file references) of an existing media item in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
37300
37496
|
* @summary Update an event media item
|
|
@@ -37331,6 +37527,16 @@ export const EventsMediaApiFactory = function (configuration, basePath, axios) {
|
|
|
37331
37527
|
addEventMediaItemPassType(requestParameters, options) {
|
|
37332
37528
|
return localVarFp.addEventMediaItemPassType(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.passTypeId, options).then((request) => request(axios, basePath));
|
|
37333
37529
|
},
|
|
37530
|
+
/**
|
|
37531
|
+
* Grants a specific account tier (tier/segment) access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.
|
|
37532
|
+
* @summary Restrict an event media item to a tier
|
|
37533
|
+
* @param {EventsMediaApiAddEventMediaItemTierRequest} requestParameters Request parameters.
|
|
37534
|
+
* @param {*} [options] Override http request option.
|
|
37535
|
+
* @throws {RequiredError}
|
|
37536
|
+
*/
|
|
37537
|
+
addEventMediaItemTier(requestParameters, options) {
|
|
37538
|
+
return localVarFp.addEventMediaItemTier(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.tierId, options).then((request) => request(axios, basePath));
|
|
37539
|
+
},
|
|
37334
37540
|
/**
|
|
37335
37541
|
* Creates a new media item (image, video, or file) in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
37336
37542
|
* @summary Create an event media item
|
|
@@ -37371,6 +37577,16 @@ export const EventsMediaApiFactory = function (configuration, basePath, axios) {
|
|
|
37371
37577
|
getEventMediaItemPassTypes(requestParameters, options) {
|
|
37372
37578
|
return localVarFp.getEventMediaItemPassTypes(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
37373
37579
|
},
|
|
37580
|
+
/**
|
|
37581
|
+
* Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
37582
|
+
* @summary List tiers linked to a media item
|
|
37583
|
+
* @param {EventsMediaApiGetEventMediaItemTiersRequest} requestParameters Request parameters.
|
|
37584
|
+
* @param {*} [options] Override http request option.
|
|
37585
|
+
* @throws {RequiredError}
|
|
37586
|
+
*/
|
|
37587
|
+
getEventMediaItemTiers(requestParameters, options) {
|
|
37588
|
+
return localVarFp.getEventMediaItemTiers(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
37589
|
+
},
|
|
37374
37590
|
/**
|
|
37375
37591
|
* Returns a paginated list of media items (images, videos, or files) belonging to the given event, optionally filtered by media type, with search and ordering support; requires read access to events and storage.
|
|
37376
37592
|
* @summary List an event\'s media items
|
|
@@ -37391,6 +37607,16 @@ export const EventsMediaApiFactory = function (configuration, basePath, axios) {
|
|
|
37391
37607
|
removeEventMediaItemPassType(requestParameters, options) {
|
|
37392
37608
|
return localVarFp.removeEventMediaItemPassType(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.passTypeId, options).then((request) => request(axios, basePath));
|
|
37393
37609
|
},
|
|
37610
|
+
/**
|
|
37611
|
+
* Revokes an account tier\'s (tier/segment) access to an event media item, and requires read and update permission on both events and storage.
|
|
37612
|
+
* @summary Remove a tier restriction from an event media item
|
|
37613
|
+
* @param {EventsMediaApiRemoveEventMediaItemTierRequest} requestParameters Request parameters.
|
|
37614
|
+
* @param {*} [options] Override http request option.
|
|
37615
|
+
* @throws {RequiredError}
|
|
37616
|
+
*/
|
|
37617
|
+
removeEventMediaItemTier(requestParameters, options) {
|
|
37618
|
+
return localVarFp.removeEventMediaItemTier(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.tierId, options).then((request) => request(axios, basePath));
|
|
37619
|
+
},
|
|
37394
37620
|
/**
|
|
37395
37621
|
* Updates the fields (such as name, type, or file references) of an existing media item in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
37396
37622
|
* @summary Update an event media item
|
|
@@ -37417,6 +37643,16 @@ export class EventsMediaApi extends BaseAPI {
|
|
|
37417
37643
|
addEventMediaItemPassType(requestParameters, options) {
|
|
37418
37644
|
return EventsMediaApiFp(this.configuration).addEventMediaItemPassType(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.passTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
37419
37645
|
}
|
|
37646
|
+
/**
|
|
37647
|
+
* Grants a specific account tier (tier/segment) access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.
|
|
37648
|
+
* @summary Restrict an event media item to a tier
|
|
37649
|
+
* @param {EventsMediaApiAddEventMediaItemTierRequest} requestParameters Request parameters.
|
|
37650
|
+
* @param {*} [options] Override http request option.
|
|
37651
|
+
* @throws {RequiredError}
|
|
37652
|
+
*/
|
|
37653
|
+
addEventMediaItemTier(requestParameters, options) {
|
|
37654
|
+
return EventsMediaApiFp(this.configuration).addEventMediaItemTier(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.tierId, options).then((request) => request(this.axios, this.basePath));
|
|
37655
|
+
}
|
|
37420
37656
|
/**
|
|
37421
37657
|
* Creates a new media item (image, video, or file) in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
37422
37658
|
* @summary Create an event media item
|
|
@@ -37457,6 +37693,16 @@ export class EventsMediaApi extends BaseAPI {
|
|
|
37457
37693
|
getEventMediaItemPassTypes(requestParameters, options) {
|
|
37458
37694
|
return EventsMediaApiFp(this.configuration).getEventMediaItemPassTypes(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
37459
37695
|
}
|
|
37696
|
+
/**
|
|
37697
|
+
* Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
37698
|
+
* @summary List tiers linked to a media item
|
|
37699
|
+
* @param {EventsMediaApiGetEventMediaItemTiersRequest} requestParameters Request parameters.
|
|
37700
|
+
* @param {*} [options] Override http request option.
|
|
37701
|
+
* @throws {RequiredError}
|
|
37702
|
+
*/
|
|
37703
|
+
getEventMediaItemTiers(requestParameters, options) {
|
|
37704
|
+
return EventsMediaApiFp(this.configuration).getEventMediaItemTiers(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
37705
|
+
}
|
|
37460
37706
|
/**
|
|
37461
37707
|
* Returns a paginated list of media items (images, videos, or files) belonging to the given event, optionally filtered by media type, with search and ordering support; requires read access to events and storage.
|
|
37462
37708
|
* @summary List an event\'s media items
|
|
@@ -37477,6 +37723,16 @@ export class EventsMediaApi extends BaseAPI {
|
|
|
37477
37723
|
removeEventMediaItemPassType(requestParameters, options) {
|
|
37478
37724
|
return EventsMediaApiFp(this.configuration).removeEventMediaItemPassType(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.passTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
37479
37725
|
}
|
|
37726
|
+
/**
|
|
37727
|
+
* Revokes an account tier\'s (tier/segment) access to an event media item, and requires read and update permission on both events and storage.
|
|
37728
|
+
* @summary Remove a tier restriction from an event media item
|
|
37729
|
+
* @param {EventsMediaApiRemoveEventMediaItemTierRequest} requestParameters Request parameters.
|
|
37730
|
+
* @param {*} [options] Override http request option.
|
|
37731
|
+
* @throws {RequiredError}
|
|
37732
|
+
*/
|
|
37733
|
+
removeEventMediaItemTier(requestParameters, options) {
|
|
37734
|
+
return EventsMediaApiFp(this.configuration).removeEventMediaItemTier(requestParameters.eventId, requestParameters.mediaItemId, requestParameters.tierId, options).then((request) => request(this.axios, this.basePath));
|
|
37735
|
+
}
|
|
37480
37736
|
/**
|
|
37481
37737
|
* Updates the fields (such as name, type, or file references) of an existing media item in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
37482
37738
|
* @summary Update an event media item
|
package/docs/BaseSideEffect.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**newPassOfPassTypeId** | **string** | | [default to undefined]
|
|
10
10
|
**checkedInPassEventId** | **string** | | [default to undefined]
|
|
11
|
+
**checkedInSessionId** | **string** | | [default to undefined]
|
|
11
12
|
**newAccountTierId** | **string** | | [default to undefined]
|
|
12
13
|
**removedAccountTierId** | **string** | | [default to undefined]
|
|
13
14
|
**passWithQuestionChoiceId** | **string** | | [default to undefined]
|
|
@@ -29,6 +30,7 @@ const instance: BaseSideEffect = {
|
|
|
29
30
|
id,
|
|
30
31
|
newPassOfPassTypeId,
|
|
31
32
|
checkedInPassEventId,
|
|
33
|
+
checkedInSessionId,
|
|
32
34
|
newAccountTierId,
|
|
33
35
|
removedAccountTierId,
|
|
34
36
|
passWithQuestionChoiceId,
|
package/docs/EventMediaItem.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**file** | [**BaseFile**](BaseFile.md) | | [default to undefined]
|
|
17
17
|
**sortOrder** | **number** | | [default to undefined]
|
|
18
18
|
**allowedPassTypes** | [**Array<BaseEventPassType>**](BaseEventPassType.md) | | [default to undefined]
|
|
19
|
+
**allowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
19
20
|
**createdAt** | **string** | | [default to undefined]
|
|
20
21
|
**updatedAt** | **string** | | [default to undefined]
|
|
21
22
|
|
|
@@ -36,6 +37,7 @@ const instance: EventMediaItem = {
|
|
|
36
37
|
file,
|
|
37
38
|
sortOrder,
|
|
38
39
|
allowedPassTypes,
|
|
40
|
+
allowedTiers,
|
|
39
41
|
createdAt,
|
|
40
42
|
updatedAt,
|
|
41
43
|
};
|
package/docs/EventsMediaApi.md
CHANGED
|
@@ -5,12 +5,15 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventMediaItemPassType**](#addeventmediaitempasstype) | **POST** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Restrict an event media item to a pass type|
|
|
8
|
+
|[**addEventMediaItemTier**](#addeventmediaitemtier) | **POST** /events/{eventId}/media/{mediaItemId}/tiers/{tierId} | Restrict an event media item to a tier|
|
|
8
9
|
|[**createEventMediaItem**](#createeventmediaitem) | **POST** /events/{eventId}/media | Create an event media item|
|
|
9
10
|
|[**deleteEventMediaItem**](#deleteeventmediaitem) | **DELETE** /events/{eventId}/media/{mediaItemId} | Delete an event media item|
|
|
10
11
|
|[**getEventMediaItem**](#geteventmediaitem) | **GET** /events/{eventId}/media/{itemId} | Get a single event media item|
|
|
11
12
|
|[**getEventMediaItemPassTypes**](#geteventmediaitempasstypes) | **GET** /events/{eventId}/media/{mediaItemId}/passTypes | List pass types linked to a media item|
|
|
13
|
+
|[**getEventMediaItemTiers**](#geteventmediaitemtiers) | **GET** /events/{eventId}/media/{mediaItemId}/tiers | List tiers linked to a media item|
|
|
12
14
|
|[**getEventMediaItems**](#geteventmediaitems) | **GET** /events/{eventId}/media | List an event\'s media items|
|
|
13
15
|
|[**removeEventMediaItemPassType**](#removeeventmediaitempasstype) | **DELETE** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Remove a pass type restriction from an event media item|
|
|
16
|
+
|[**removeEventMediaItemTier**](#removeeventmediaitemtier) | **DELETE** /events/{eventId}/media/{mediaItemId}/tiers/{tierId} | Remove a tier restriction from an event media item|
|
|
14
17
|
|[**updateEventMediaItem**](#updateeventmediaitem) | **PUT** /events/{eventId}/media/{mediaItemId} | Update an event media item|
|
|
15
18
|
|
|
16
19
|
# **addEventMediaItemPassType**
|
|
@@ -49,6 +52,63 @@ const { status, data } = await apiInstance.addEventMediaItemPassType(
|
|
|
49
52
|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
50
53
|
|
|
51
54
|
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
**CreateEventMediaItem200Response**
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: application/json
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### HTTP response details
|
|
70
|
+
| Status code | Description | Response headers |
|
|
71
|
+
|-------------|-------------|------------------|
|
|
72
|
+
|**200** | Successful response | - |
|
|
73
|
+
|
|
74
|
+
[[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)
|
|
75
|
+
|
|
76
|
+
# **addEventMediaItemTier**
|
|
77
|
+
> CreateEventMediaItem200Response addEventMediaItemTier()
|
|
78
|
+
|
|
79
|
+
Grants a specific account tier (tier/segment) access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
import {
|
|
85
|
+
EventsMediaApi,
|
|
86
|
+
Configuration
|
|
87
|
+
} from '@connectedxm/admin-sdk';
|
|
88
|
+
|
|
89
|
+
const configuration = new Configuration();
|
|
90
|
+
const apiInstance = new EventsMediaApi(configuration);
|
|
91
|
+
|
|
92
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
93
|
+
let mediaItemId: string; //The mediaItem identifier (default to undefined)
|
|
94
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
95
|
+
|
|
96
|
+
const { status, data } = await apiInstance.addEventMediaItemTier(
|
|
97
|
+
eventId,
|
|
98
|
+
mediaItemId,
|
|
99
|
+
tierId
|
|
100
|
+
);
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parameters
|
|
104
|
+
|
|
105
|
+
|Name | Type | Description | Notes|
|
|
106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
107
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
108
|
+
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
|
|
109
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
110
|
+
|
|
111
|
+
|
|
52
112
|
### Return type
|
|
53
113
|
|
|
54
114
|
**CreateEventMediaItem200Response**
|
|
@@ -292,6 +352,72 @@ const { status, data } = await apiInstance.getEventMediaItemPassTypes(
|
|
|
292
352
|
- **Accept**: application/json
|
|
293
353
|
|
|
294
354
|
|
|
355
|
+
### HTTP response details
|
|
356
|
+
| Status code | Description | Response headers |
|
|
357
|
+
|-------------|-------------|------------------|
|
|
358
|
+
|**200** | Successful response | - |
|
|
359
|
+
|
|
360
|
+
[[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)
|
|
361
|
+
|
|
362
|
+
# **getEventMediaItemTiers**
|
|
363
|
+
> GetAccountTiers200Response getEventMediaItemTiers()
|
|
364
|
+
|
|
365
|
+
Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
366
|
+
|
|
367
|
+
### Example
|
|
368
|
+
|
|
369
|
+
```typescript
|
|
370
|
+
import {
|
|
371
|
+
EventsMediaApi,
|
|
372
|
+
Configuration
|
|
373
|
+
} from '@connectedxm/admin-sdk';
|
|
374
|
+
|
|
375
|
+
const configuration = new Configuration();
|
|
376
|
+
const apiInstance = new EventsMediaApi(configuration);
|
|
377
|
+
|
|
378
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
379
|
+
let mediaItemId: string; //The mediaItem identifier (default to undefined)
|
|
380
|
+
let page: number; //Page number (optional) (default to 1)
|
|
381
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
382
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
383
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
384
|
+
|
|
385
|
+
const { status, data } = await apiInstance.getEventMediaItemTiers(
|
|
386
|
+
eventId,
|
|
387
|
+
mediaItemId,
|
|
388
|
+
page,
|
|
389
|
+
pageSize,
|
|
390
|
+
orderBy,
|
|
391
|
+
search
|
|
392
|
+
);
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### Parameters
|
|
396
|
+
|
|
397
|
+
|Name | Type | Description | Notes|
|
|
398
|
+
|------------- | ------------- | ------------- | -------------|
|
|
399
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
400
|
+
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
|
|
401
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
402
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
403
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
404
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
**GetAccountTiers200Response**
|
|
410
|
+
|
|
411
|
+
### Authorization
|
|
412
|
+
|
|
413
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
414
|
+
|
|
415
|
+
### HTTP request headers
|
|
416
|
+
|
|
417
|
+
- **Content-Type**: Not defined
|
|
418
|
+
- **Accept**: application/json
|
|
419
|
+
|
|
420
|
+
|
|
295
421
|
### HTTP response details
|
|
296
422
|
| Status code | Description | Response headers |
|
|
297
423
|
|-------------|-------------|------------------|
|
|
@@ -401,6 +527,63 @@ const { status, data } = await apiInstance.removeEventMediaItemPassType(
|
|
|
401
527
|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
402
528
|
|
|
403
529
|
|
|
530
|
+
### Return type
|
|
531
|
+
|
|
532
|
+
**CreateEventMediaItem200Response**
|
|
533
|
+
|
|
534
|
+
### Authorization
|
|
535
|
+
|
|
536
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
537
|
+
|
|
538
|
+
### HTTP request headers
|
|
539
|
+
|
|
540
|
+
- **Content-Type**: Not defined
|
|
541
|
+
- **Accept**: application/json
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
### HTTP response details
|
|
545
|
+
| Status code | Description | Response headers |
|
|
546
|
+
|-------------|-------------|------------------|
|
|
547
|
+
|**200** | Successful response | - |
|
|
548
|
+
|
|
549
|
+
[[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)
|
|
550
|
+
|
|
551
|
+
# **removeEventMediaItemTier**
|
|
552
|
+
> CreateEventMediaItem200Response removeEventMediaItemTier()
|
|
553
|
+
|
|
554
|
+
Revokes an account tier\'s (tier/segment) access to an event media item, and requires read and update permission on both events and storage.
|
|
555
|
+
|
|
556
|
+
### Example
|
|
557
|
+
|
|
558
|
+
```typescript
|
|
559
|
+
import {
|
|
560
|
+
EventsMediaApi,
|
|
561
|
+
Configuration
|
|
562
|
+
} from '@connectedxm/admin-sdk';
|
|
563
|
+
|
|
564
|
+
const configuration = new Configuration();
|
|
565
|
+
const apiInstance = new EventsMediaApi(configuration);
|
|
566
|
+
|
|
567
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
568
|
+
let mediaItemId: string; //The mediaItem identifier (default to undefined)
|
|
569
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
570
|
+
|
|
571
|
+
const { status, data } = await apiInstance.removeEventMediaItemTier(
|
|
572
|
+
eventId,
|
|
573
|
+
mediaItemId,
|
|
574
|
+
tierId
|
|
575
|
+
);
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
### Parameters
|
|
579
|
+
|
|
580
|
+
|Name | Type | Description | Notes|
|
|
581
|
+
|------------- | ------------- | ------------- | -------------|
|
|
582
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
583
|
+
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
|
|
584
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
585
|
+
|
|
586
|
+
|
|
404
587
|
### Return type
|
|
405
588
|
|
|
406
589
|
**CreateEventMediaItem200Response**
|
package/docs/SideEffect.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**newPassOfPassTypeId** | **string** | | [default to undefined]
|
|
10
10
|
**checkedInPassEventId** | **string** | | [default to undefined]
|
|
11
|
+
**checkedInSessionId** | **string** | | [default to undefined]
|
|
11
12
|
**newAccountTierId** | **string** | | [default to undefined]
|
|
12
13
|
**removedAccountTierId** | **string** | | [default to undefined]
|
|
13
14
|
**passWithQuestionChoiceId** | **string** | | [default to undefined]
|
|
@@ -22,6 +23,7 @@ Name | Type | Description | Notes
|
|
|
22
23
|
**organizationId** | **string** | | [default to undefined]
|
|
23
24
|
**newPassOfPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
24
25
|
**checkedInPassEvent** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
26
|
+
**checkedInSession** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
25
27
|
**newAccountTier** | [**BaseTier**](BaseTier.md) | | [default to undefined]
|
|
26
28
|
**removedAccountTier** | [**BaseTier**](BaseTier.md) | | [default to undefined]
|
|
27
29
|
**passWithQuestionChoice** | [**BaseRegistrationQuestionChoice**](BaseRegistrationQuestionChoice.md) | | [default to undefined]
|
|
@@ -45,6 +47,7 @@ const instance: SideEffect = {
|
|
|
45
47
|
id,
|
|
46
48
|
newPassOfPassTypeId,
|
|
47
49
|
checkedInPassEventId,
|
|
50
|
+
checkedInSessionId,
|
|
48
51
|
newAccountTierId,
|
|
49
52
|
removedAccountTierId,
|
|
50
53
|
passWithQuestionChoiceId,
|
|
@@ -59,6 +62,7 @@ const instance: SideEffect = {
|
|
|
59
62
|
organizationId,
|
|
60
63
|
newPassOfPassType,
|
|
61
64
|
checkedInPassEvent,
|
|
65
|
+
checkedInSession,
|
|
62
66
|
newAccountTier,
|
|
63
67
|
removedAccountTier,
|
|
64
68
|
passWithQuestionChoice,
|