@connectedxm/admin-sdk 15.3.3 → 15.4.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 +3 -2
- package/README.md +2 -2
- package/api.ts +383 -26
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +208 -22
- package/dist/api.js +270 -15
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +208 -22
- package/dist/esm/api.js +264 -9
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/EventSponsorshipLevelSurvey.md +36 -0
- package/docs/EventsSponsorshiplevelsApi.md +183 -0
- package/docs/GetEventSponsorshipLevelSurveys200Response.md +26 -0
- package/docs/SponsorshipAdvertisementProgress.md +0 -2
- package/docs/SponsorshipBenefitProgress.md +0 -2
- package/docs/SponsorshipProgressCheck.md +4 -2
- package/docs/{UnavailableSponsorshipBenefitProgress.md → SponsorshipSurveyProgress.md} +7 -7
- package/package.json +1 -1
- package/docs/UnavailableSponsorshipAdvertisementProgress.md +0 -26
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 15.
|
|
7
|
+
* The version of the OpenAPI document: 15.4.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1570,6 +1570,10 @@ export var GetEventSpeakerTranslations200ResponseStatusEnum;
|
|
|
1570
1570
|
(function (GetEventSpeakerTranslations200ResponseStatusEnum) {
|
|
1571
1571
|
GetEventSpeakerTranslations200ResponseStatusEnum["Ok"] = "ok";
|
|
1572
1572
|
})(GetEventSpeakerTranslations200ResponseStatusEnum || (GetEventSpeakerTranslations200ResponseStatusEnum = {}));
|
|
1573
|
+
export var GetEventSponsorshipLevelSurveys200ResponseStatusEnum;
|
|
1574
|
+
(function (GetEventSponsorshipLevelSurveys200ResponseStatusEnum) {
|
|
1575
|
+
GetEventSponsorshipLevelSurveys200ResponseStatusEnum["Ok"] = "ok";
|
|
1576
|
+
})(GetEventSponsorshipLevelSurveys200ResponseStatusEnum || (GetEventSponsorshipLevelSurveys200ResponseStatusEnum = {}));
|
|
1573
1577
|
export var GetEventSponsorshipLevelTranslation200ResponseStatusEnum;
|
|
1574
1578
|
(function (GetEventSponsorshipLevelTranslation200ResponseStatusEnum) {
|
|
1575
1579
|
GetEventSponsorshipLevelTranslation200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -2823,6 +2827,10 @@ export var SponsorshipBrandingProgressTypeEnum;
|
|
|
2823
2827
|
(function (SponsorshipBrandingProgressTypeEnum) {
|
|
2824
2828
|
SponsorshipBrandingProgressTypeEnum["Branding"] = "branding";
|
|
2825
2829
|
})(SponsorshipBrandingProgressTypeEnum || (SponsorshipBrandingProgressTypeEnum = {}));
|
|
2830
|
+
export var SponsorshipSurveyProgressTypeEnum;
|
|
2831
|
+
(function (SponsorshipSurveyProgressTypeEnum) {
|
|
2832
|
+
SponsorshipSurveyProgressTypeEnum["Surveys"] = "surveys";
|
|
2833
|
+
})(SponsorshipSurveyProgressTypeEnum || (SponsorshipSurveyProgressTypeEnum = {}));
|
|
2826
2834
|
export var StorageConfigTypeEnum;
|
|
2827
2835
|
(function (StorageConfigTypeEnum) {
|
|
2828
2836
|
StorageConfigTypeEnum["Aws"] = "aws";
|
|
@@ -3020,14 +3028,6 @@ export var ThreadType;
|
|
|
3020
3028
|
ThreadType["Direct"] = "direct";
|
|
3021
3029
|
ThreadType["Default"] = "default";
|
|
3022
3030
|
})(ThreadType || (ThreadType = {}));
|
|
3023
|
-
export var UnavailableSponsorshipAdvertisementProgressTypeEnum;
|
|
3024
|
-
(function (UnavailableSponsorshipAdvertisementProgressTypeEnum) {
|
|
3025
|
-
UnavailableSponsorshipAdvertisementProgressTypeEnum["Advertisements"] = "advertisements";
|
|
3026
|
-
})(UnavailableSponsorshipAdvertisementProgressTypeEnum || (UnavailableSponsorshipAdvertisementProgressTypeEnum = {}));
|
|
3027
|
-
export var UnavailableSponsorshipBenefitProgressTypeEnum;
|
|
3028
|
-
(function (UnavailableSponsorshipBenefitProgressTypeEnum) {
|
|
3029
|
-
UnavailableSponsorshipBenefitProgressTypeEnum["Benefits"] = "benefits";
|
|
3030
|
-
})(UnavailableSponsorshipBenefitProgressTypeEnum || (UnavailableSponsorshipBenefitProgressTypeEnum = {}));
|
|
3031
3031
|
export var UpdateAnnouncementTemplateTranslation200ResponseStatusEnum;
|
|
3032
3032
|
(function (UpdateAnnouncementTemplateTranslation200ResponseStatusEnum) {
|
|
3033
3033
|
UpdateAnnouncementTemplateTranslation200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -73333,6 +73333,48 @@ export class EventsSponsorsApi extends BaseAPI {
|
|
|
73333
73333
|
*/
|
|
73334
73334
|
export const EventsSponsorshiplevelsApiAxiosParamCreator = function (configuration) {
|
|
73335
73335
|
return {
|
|
73336
|
+
/**
|
|
73337
|
+
* Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
73338
|
+
* @summary Add a survey to a sponsorship level
|
|
73339
|
+
* @param {string} eventId The event identifier
|
|
73340
|
+
* @param {string} levelId The level identifier
|
|
73341
|
+
* @param {string} surveyId The survey identifier
|
|
73342
|
+
* @param {*} [options] Override http request option.
|
|
73343
|
+
* @throws {RequiredError}
|
|
73344
|
+
*/
|
|
73345
|
+
addEventSponsorshipLevelSurvey: (eventId_1, levelId_1, surveyId_1, ...args_1) => __awaiter(this, [eventId_1, levelId_1, surveyId_1, ...args_1], void 0, function* (eventId, levelId, surveyId, options = {}) {
|
|
73346
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
73347
|
+
assertParamExists('addEventSponsorshipLevelSurvey', 'eventId', eventId);
|
|
73348
|
+
// verify required parameter 'levelId' is not null or undefined
|
|
73349
|
+
assertParamExists('addEventSponsorshipLevelSurvey', 'levelId', levelId);
|
|
73350
|
+
// verify required parameter 'surveyId' is not null or undefined
|
|
73351
|
+
assertParamExists('addEventSponsorshipLevelSurvey', 'surveyId', surveyId);
|
|
73352
|
+
const localVarPath = `/events/{eventId}/sponsorshipLevels/{levelId}/surveys/{surveyId}`
|
|
73353
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)))
|
|
73354
|
+
.replace('{levelId}', encodeURIComponent(String(levelId)))
|
|
73355
|
+
.replace('{surveyId}', encodeURIComponent(String(surveyId)));
|
|
73356
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
73357
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
73358
|
+
let baseOptions;
|
|
73359
|
+
if (configuration) {
|
|
73360
|
+
baseOptions = configuration.baseOptions;
|
|
73361
|
+
}
|
|
73362
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
73363
|
+
const localVarHeaderParameter = {};
|
|
73364
|
+
const localVarQueryParameter = {};
|
|
73365
|
+
// authentication ApiKeyAuth required
|
|
73366
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
73367
|
+
// authentication OrganizationId required
|
|
73368
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
73369
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
73370
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
73371
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
73372
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
73373
|
+
return {
|
|
73374
|
+
url: toPathString(localVarUrlObj),
|
|
73375
|
+
options: localVarRequestOptions,
|
|
73376
|
+
};
|
|
73377
|
+
}),
|
|
73336
73378
|
/**
|
|
73337
73379
|
* Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
|
|
73338
73380
|
* @summary Create an event sponsorship level
|
|
@@ -73448,6 +73490,60 @@ export const EventsSponsorshiplevelsApiAxiosParamCreator = function (configurati
|
|
|
73448
73490
|
options: localVarRequestOptions,
|
|
73449
73491
|
};
|
|
73450
73492
|
}),
|
|
73493
|
+
/**
|
|
73494
|
+
* Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
|
|
73495
|
+
* @summary List surveys on a sponsorship level
|
|
73496
|
+
* @param {string} eventId The event identifier
|
|
73497
|
+
* @param {string} levelId The level identifier
|
|
73498
|
+
* @param {number} [page] Page number
|
|
73499
|
+
* @param {number} [pageSize] Number of items per page
|
|
73500
|
+
* @param {string} [orderBy] Field to order by
|
|
73501
|
+
* @param {string} [search] Search query
|
|
73502
|
+
* @param {*} [options] Override http request option.
|
|
73503
|
+
* @throws {RequiredError}
|
|
73504
|
+
*/
|
|
73505
|
+
getEventSponsorshipLevelSurveys: (eventId_1, levelId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, levelId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, levelId, page, pageSize, orderBy, search, options = {}) {
|
|
73506
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
73507
|
+
assertParamExists('getEventSponsorshipLevelSurveys', 'eventId', eventId);
|
|
73508
|
+
// verify required parameter 'levelId' is not null or undefined
|
|
73509
|
+
assertParamExists('getEventSponsorshipLevelSurveys', 'levelId', levelId);
|
|
73510
|
+
const localVarPath = `/events/{eventId}/sponsorshipLevels/{levelId}/surveys`
|
|
73511
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)))
|
|
73512
|
+
.replace('{levelId}', encodeURIComponent(String(levelId)));
|
|
73513
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
73514
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
73515
|
+
let baseOptions;
|
|
73516
|
+
if (configuration) {
|
|
73517
|
+
baseOptions = configuration.baseOptions;
|
|
73518
|
+
}
|
|
73519
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
73520
|
+
const localVarHeaderParameter = {};
|
|
73521
|
+
const localVarQueryParameter = {};
|
|
73522
|
+
// authentication ApiKeyAuth required
|
|
73523
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
73524
|
+
// authentication OrganizationId required
|
|
73525
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
73526
|
+
if (page !== undefined) {
|
|
73527
|
+
localVarQueryParameter['page'] = page;
|
|
73528
|
+
}
|
|
73529
|
+
if (pageSize !== undefined) {
|
|
73530
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
73531
|
+
}
|
|
73532
|
+
if (orderBy !== undefined) {
|
|
73533
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
73534
|
+
}
|
|
73535
|
+
if (search !== undefined) {
|
|
73536
|
+
localVarQueryParameter['search'] = search;
|
|
73537
|
+
}
|
|
73538
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
73539
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
73540
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
73541
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
73542
|
+
return {
|
|
73543
|
+
url: toPathString(localVarUrlObj),
|
|
73544
|
+
options: localVarRequestOptions,
|
|
73545
|
+
};
|
|
73546
|
+
}),
|
|
73451
73547
|
/**
|
|
73452
73548
|
* Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
|
|
73453
73549
|
* @summary List an event\'s sponsorship levels
|
|
@@ -73498,6 +73594,48 @@ export const EventsSponsorshiplevelsApiAxiosParamCreator = function (configurati
|
|
|
73498
73594
|
options: localVarRequestOptions,
|
|
73499
73595
|
};
|
|
73500
73596
|
}),
|
|
73597
|
+
/**
|
|
73598
|
+
* Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
73599
|
+
* @summary Remove a survey from a sponsorship level
|
|
73600
|
+
* @param {string} eventId The event identifier
|
|
73601
|
+
* @param {string} levelId The level identifier
|
|
73602
|
+
* @param {string} surveyId The survey identifier
|
|
73603
|
+
* @param {*} [options] Override http request option.
|
|
73604
|
+
* @throws {RequiredError}
|
|
73605
|
+
*/
|
|
73606
|
+
removeEventSponsorshipLevelSurvey: (eventId_1, levelId_1, surveyId_1, ...args_1) => __awaiter(this, [eventId_1, levelId_1, surveyId_1, ...args_1], void 0, function* (eventId, levelId, surveyId, options = {}) {
|
|
73607
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
73608
|
+
assertParamExists('removeEventSponsorshipLevelSurvey', 'eventId', eventId);
|
|
73609
|
+
// verify required parameter 'levelId' is not null or undefined
|
|
73610
|
+
assertParamExists('removeEventSponsorshipLevelSurvey', 'levelId', levelId);
|
|
73611
|
+
// verify required parameter 'surveyId' is not null or undefined
|
|
73612
|
+
assertParamExists('removeEventSponsorshipLevelSurvey', 'surveyId', surveyId);
|
|
73613
|
+
const localVarPath = `/events/{eventId}/sponsorshipLevels/{levelId}/surveys/{surveyId}`
|
|
73614
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)))
|
|
73615
|
+
.replace('{levelId}', encodeURIComponent(String(levelId)))
|
|
73616
|
+
.replace('{surveyId}', encodeURIComponent(String(surveyId)));
|
|
73617
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
73618
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
73619
|
+
let baseOptions;
|
|
73620
|
+
if (configuration) {
|
|
73621
|
+
baseOptions = configuration.baseOptions;
|
|
73622
|
+
}
|
|
73623
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
73624
|
+
const localVarHeaderParameter = {};
|
|
73625
|
+
const localVarQueryParameter = {};
|
|
73626
|
+
// authentication ApiKeyAuth required
|
|
73627
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
73628
|
+
// authentication OrganizationId required
|
|
73629
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
73630
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
73631
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
73632
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
73633
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
73634
|
+
return {
|
|
73635
|
+
url: toPathString(localVarUrlObj),
|
|
73636
|
+
options: localVarRequestOptions,
|
|
73637
|
+
};
|
|
73638
|
+
}),
|
|
73501
73639
|
/**
|
|
73502
73640
|
* Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
|
|
73503
73641
|
* @summary Reorder an event\'s sponsorship levels
|
|
@@ -73588,6 +73726,24 @@ export const EventsSponsorshiplevelsApiAxiosParamCreator = function (configurati
|
|
|
73588
73726
|
export const EventsSponsorshiplevelsApiFp = function (configuration) {
|
|
73589
73727
|
const localVarAxiosParamCreator = EventsSponsorshiplevelsApiAxiosParamCreator(configuration);
|
|
73590
73728
|
return {
|
|
73729
|
+
/**
|
|
73730
|
+
* Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
73731
|
+
* @summary Add a survey to a sponsorship level
|
|
73732
|
+
* @param {string} eventId The event identifier
|
|
73733
|
+
* @param {string} levelId The level identifier
|
|
73734
|
+
* @param {string} surveyId The survey identifier
|
|
73735
|
+
* @param {*} [options] Override http request option.
|
|
73736
|
+
* @throws {RequiredError}
|
|
73737
|
+
*/
|
|
73738
|
+
addEventSponsorshipLevelSurvey(eventId, levelId, surveyId, options) {
|
|
73739
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
73740
|
+
var _a, _b, _c;
|
|
73741
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addEventSponsorshipLevelSurvey(eventId, levelId, surveyId, options);
|
|
73742
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
73743
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsSponsorshiplevelsApi.addEventSponsorshipLevelSurvey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
73744
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
73745
|
+
});
|
|
73746
|
+
},
|
|
73591
73747
|
/**
|
|
73592
73748
|
* Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
|
|
73593
73749
|
* @summary Create an event sponsorship level
|
|
@@ -73639,6 +73795,27 @@ export const EventsSponsorshiplevelsApiFp = function (configuration) {
|
|
|
73639
73795
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
73640
73796
|
});
|
|
73641
73797
|
},
|
|
73798
|
+
/**
|
|
73799
|
+
* Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
|
|
73800
|
+
* @summary List surveys on a sponsorship level
|
|
73801
|
+
* @param {string} eventId The event identifier
|
|
73802
|
+
* @param {string} levelId The level identifier
|
|
73803
|
+
* @param {number} [page] Page number
|
|
73804
|
+
* @param {number} [pageSize] Number of items per page
|
|
73805
|
+
* @param {string} [orderBy] Field to order by
|
|
73806
|
+
* @param {string} [search] Search query
|
|
73807
|
+
* @param {*} [options] Override http request option.
|
|
73808
|
+
* @throws {RequiredError}
|
|
73809
|
+
*/
|
|
73810
|
+
getEventSponsorshipLevelSurveys(eventId, levelId, page, pageSize, orderBy, search, options) {
|
|
73811
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
73812
|
+
var _a, _b, _c;
|
|
73813
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventSponsorshipLevelSurveys(eventId, levelId, page, pageSize, orderBy, search, options);
|
|
73814
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
73815
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsSponsorshiplevelsApi.getEventSponsorshipLevelSurveys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
73816
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
73817
|
+
});
|
|
73818
|
+
},
|
|
73642
73819
|
/**
|
|
73643
73820
|
* Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
|
|
73644
73821
|
* @summary List an event\'s sponsorship levels
|
|
@@ -73659,6 +73836,24 @@ export const EventsSponsorshiplevelsApiFp = function (configuration) {
|
|
|
73659
73836
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
73660
73837
|
});
|
|
73661
73838
|
},
|
|
73839
|
+
/**
|
|
73840
|
+
* Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
73841
|
+
* @summary Remove a survey from a sponsorship level
|
|
73842
|
+
* @param {string} eventId The event identifier
|
|
73843
|
+
* @param {string} levelId The level identifier
|
|
73844
|
+
* @param {string} surveyId The survey identifier
|
|
73845
|
+
* @param {*} [options] Override http request option.
|
|
73846
|
+
* @throws {RequiredError}
|
|
73847
|
+
*/
|
|
73848
|
+
removeEventSponsorshipLevelSurvey(eventId, levelId, surveyId, options) {
|
|
73849
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
73850
|
+
var _a, _b, _c;
|
|
73851
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.removeEventSponsorshipLevelSurvey(eventId, levelId, surveyId, options);
|
|
73852
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
73853
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsSponsorshiplevelsApi.removeEventSponsorshipLevelSurvey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
73854
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
73855
|
+
});
|
|
73856
|
+
},
|
|
73662
73857
|
/**
|
|
73663
73858
|
* Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
|
|
73664
73859
|
* @summary Reorder an event\'s sponsorship levels
|
|
@@ -73702,6 +73897,16 @@ export const EventsSponsorshiplevelsApiFp = function (configuration) {
|
|
|
73702
73897
|
export const EventsSponsorshiplevelsApiFactory = function (configuration, basePath, axios) {
|
|
73703
73898
|
const localVarFp = EventsSponsorshiplevelsApiFp(configuration);
|
|
73704
73899
|
return {
|
|
73900
|
+
/**
|
|
73901
|
+
* Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
73902
|
+
* @summary Add a survey to a sponsorship level
|
|
73903
|
+
* @param {EventsSponsorshiplevelsApiAddEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
|
|
73904
|
+
* @param {*} [options] Override http request option.
|
|
73905
|
+
* @throws {RequiredError}
|
|
73906
|
+
*/
|
|
73907
|
+
addEventSponsorshipLevelSurvey(requestParameters, options) {
|
|
73908
|
+
return localVarFp.addEventSponsorshipLevelSurvey(requestParameters.eventId, requestParameters.levelId, requestParameters.surveyId, options).then((request) => request(axios, basePath));
|
|
73909
|
+
},
|
|
73705
73910
|
/**
|
|
73706
73911
|
* Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
|
|
73707
73912
|
* @summary Create an event sponsorship level
|
|
@@ -73732,6 +73937,16 @@ export const EventsSponsorshiplevelsApiFactory = function (configuration, basePa
|
|
|
73732
73937
|
getEventSponsorshipLevel(requestParameters, options) {
|
|
73733
73938
|
return localVarFp.getEventSponsorshipLevel(requestParameters.eventId, requestParameters.levelId, options).then((request) => request(axios, basePath));
|
|
73734
73939
|
},
|
|
73940
|
+
/**
|
|
73941
|
+
* Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
|
|
73942
|
+
* @summary List surveys on a sponsorship level
|
|
73943
|
+
* @param {EventsSponsorshiplevelsApiGetEventSponsorshipLevelSurveysRequest} requestParameters Request parameters.
|
|
73944
|
+
* @param {*} [options] Override http request option.
|
|
73945
|
+
* @throws {RequiredError}
|
|
73946
|
+
*/
|
|
73947
|
+
getEventSponsorshipLevelSurveys(requestParameters, options) {
|
|
73948
|
+
return localVarFp.getEventSponsorshipLevelSurveys(requestParameters.eventId, requestParameters.levelId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
73949
|
+
},
|
|
73735
73950
|
/**
|
|
73736
73951
|
* Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
|
|
73737
73952
|
* @summary List an event\'s sponsorship levels
|
|
@@ -73742,6 +73957,16 @@ export const EventsSponsorshiplevelsApiFactory = function (configuration, basePa
|
|
|
73742
73957
|
getEventSponsorshipLevels(requestParameters, options) {
|
|
73743
73958
|
return localVarFp.getEventSponsorshipLevels(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
73744
73959
|
},
|
|
73960
|
+
/**
|
|
73961
|
+
* Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
73962
|
+
* @summary Remove a survey from a sponsorship level
|
|
73963
|
+
* @param {EventsSponsorshiplevelsApiRemoveEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
|
|
73964
|
+
* @param {*} [options] Override http request option.
|
|
73965
|
+
* @throws {RequiredError}
|
|
73966
|
+
*/
|
|
73967
|
+
removeEventSponsorshipLevelSurvey(requestParameters, options) {
|
|
73968
|
+
return localVarFp.removeEventSponsorshipLevelSurvey(requestParameters.eventId, requestParameters.levelId, requestParameters.surveyId, options).then((request) => request(axios, basePath));
|
|
73969
|
+
},
|
|
73745
73970
|
/**
|
|
73746
73971
|
* Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
|
|
73747
73972
|
* @summary Reorder an event\'s sponsorship levels
|
|
@@ -73768,6 +73993,16 @@ export const EventsSponsorshiplevelsApiFactory = function (configuration, basePa
|
|
|
73768
73993
|
* EventsSponsorshiplevelsApi - object-oriented interface
|
|
73769
73994
|
*/
|
|
73770
73995
|
export class EventsSponsorshiplevelsApi extends BaseAPI {
|
|
73996
|
+
/**
|
|
73997
|
+
* Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
73998
|
+
* @summary Add a survey to a sponsorship level
|
|
73999
|
+
* @param {EventsSponsorshiplevelsApiAddEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
|
|
74000
|
+
* @param {*} [options] Override http request option.
|
|
74001
|
+
* @throws {RequiredError}
|
|
74002
|
+
*/
|
|
74003
|
+
addEventSponsorshipLevelSurvey(requestParameters, options) {
|
|
74004
|
+
return EventsSponsorshiplevelsApiFp(this.configuration).addEventSponsorshipLevelSurvey(requestParameters.eventId, requestParameters.levelId, requestParameters.surveyId, options).then((request) => request(this.axios, this.basePath));
|
|
74005
|
+
}
|
|
73771
74006
|
/**
|
|
73772
74007
|
* Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
|
|
73773
74008
|
* @summary Create an event sponsorship level
|
|
@@ -73798,6 +74033,16 @@ export class EventsSponsorshiplevelsApi extends BaseAPI {
|
|
|
73798
74033
|
getEventSponsorshipLevel(requestParameters, options) {
|
|
73799
74034
|
return EventsSponsorshiplevelsApiFp(this.configuration).getEventSponsorshipLevel(requestParameters.eventId, requestParameters.levelId, options).then((request) => request(this.axios, this.basePath));
|
|
73800
74035
|
}
|
|
74036
|
+
/**
|
|
74037
|
+
* Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
|
|
74038
|
+
* @summary List surveys on a sponsorship level
|
|
74039
|
+
* @param {EventsSponsorshiplevelsApiGetEventSponsorshipLevelSurveysRequest} requestParameters Request parameters.
|
|
74040
|
+
* @param {*} [options] Override http request option.
|
|
74041
|
+
* @throws {RequiredError}
|
|
74042
|
+
*/
|
|
74043
|
+
getEventSponsorshipLevelSurveys(requestParameters, options) {
|
|
74044
|
+
return EventsSponsorshiplevelsApiFp(this.configuration).getEventSponsorshipLevelSurveys(requestParameters.eventId, requestParameters.levelId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
74045
|
+
}
|
|
73801
74046
|
/**
|
|
73802
74047
|
* Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
|
|
73803
74048
|
* @summary List an event\'s sponsorship levels
|
|
@@ -73808,6 +74053,16 @@ export class EventsSponsorshiplevelsApi extends BaseAPI {
|
|
|
73808
74053
|
getEventSponsorshipLevels(requestParameters, options) {
|
|
73809
74054
|
return EventsSponsorshiplevelsApiFp(this.configuration).getEventSponsorshipLevels(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
73810
74055
|
}
|
|
74056
|
+
/**
|
|
74057
|
+
* Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
|
|
74058
|
+
* @summary Remove a survey from a sponsorship level
|
|
74059
|
+
* @param {EventsSponsorshiplevelsApiRemoveEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
|
|
74060
|
+
* @param {*} [options] Override http request option.
|
|
74061
|
+
* @throws {RequiredError}
|
|
74062
|
+
*/
|
|
74063
|
+
removeEventSponsorshipLevelSurvey(requestParameters, options) {
|
|
74064
|
+
return EventsSponsorshiplevelsApiFp(this.configuration).removeEventSponsorshipLevelSurvey(requestParameters.eventId, requestParameters.levelId, requestParameters.surveyId, options).then((request) => request(this.axios, this.basePath));
|
|
74065
|
+
}
|
|
73811
74066
|
/**
|
|
73812
74067
|
* Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
|
|
73813
74068
|
* @summary Reorder an event\'s sponsorship levels
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 15.
|
|
5
|
+
* The version of the OpenAPI document: 15.4.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 15.
|
|
7
|
+
* The version of the OpenAPI document: 15.4.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 15.
|
|
5
|
+
* The version of the OpenAPI document: 15.4.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 15.
|
|
7
|
+
* The version of the OpenAPI document: 15.4.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 15.
|
|
5
|
+
* The version of the OpenAPI document: 15.4.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 15.
|
|
6
|
+
* The version of the OpenAPI document: 15.4.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# EventSponsorshipLevelSurvey
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**slug** | **string** | | [default to undefined]
|
|
10
|
+
**name** | **string** | | [default to undefined]
|
|
11
|
+
**status** | [**SurveyStatus**](SurveyStatus.md) | | [default to undefined]
|
|
12
|
+
**description** | **string** | | [default to undefined]
|
|
13
|
+
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
14
|
+
**requireAuth** | **boolean** | | [default to undefined]
|
|
15
|
+
**submissionsPerAccount** | **number** | | [default to undefined]
|
|
16
|
+
**required** | **boolean** | | [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { EventSponsorshipLevelSurvey } from '@connectedxm/admin-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: EventSponsorshipLevelSurvey = {
|
|
24
|
+
id,
|
|
25
|
+
slug,
|
|
26
|
+
name,
|
|
27
|
+
status,
|
|
28
|
+
description,
|
|
29
|
+
image,
|
|
30
|
+
requireAuth,
|
|
31
|
+
submissionsPerAccount,
|
|
32
|
+
required,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|