@connectedxm/admin-sdk 7.9.4 → 7.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +5 -0
- package/AdminApi.ts +3 -0
- package/README.md +9 -0
- package/api.ts +593 -0
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +312 -0
- package/dist/api.js +469 -26
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +312 -0
- package/dist/esm/api.js +439 -0
- package/docs/BasePassAddOn.md +2 -0
- package/docs/EventsPassesAddonsApi.md +116 -0
- package/docs/FulfillEventPassAddOn200Response.md +24 -0
- package/docs/GetOrganizationLanguageOverrides200Response.md +26 -0
- package/docs/OrganizationLanguageOverride.md +28 -0
- package/docs/OrganizationLanguageOverrideUpsertInputs.md +22 -0
- package/docs/OrganizationLanguageoverridesApi.md +182 -0
- package/docs/PassAddOn.md +2 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -674,6 +674,10 @@ export var FileSource;
|
|
|
674
674
|
FileSource["Content"] = "content";
|
|
675
675
|
FileSource["Thread"] = "thread";
|
|
676
676
|
})(FileSource || (FileSource = {}));
|
|
677
|
+
export var FulfillEventPassAddOn200ResponseStatusEnum;
|
|
678
|
+
(function (FulfillEventPassAddOn200ResponseStatusEnum) {
|
|
679
|
+
FulfillEventPassAddOn200ResponseStatusEnum["Ok"] = "ok";
|
|
680
|
+
})(FulfillEventPassAddOn200ResponseStatusEnum || (FulfillEventPassAddOn200ResponseStatusEnum = {}));
|
|
677
681
|
export var GetAPILog200ResponseStatusEnum;
|
|
678
682
|
(function (GetAPILog200ResponseStatusEnum) {
|
|
679
683
|
GetAPILog200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1622,6 +1626,10 @@ export var GetOrganizationDomain200ResponseStatusEnum;
|
|
|
1622
1626
|
(function (GetOrganizationDomain200ResponseStatusEnum) {
|
|
1623
1627
|
GetOrganizationDomain200ResponseStatusEnum["Ok"] = "ok";
|
|
1624
1628
|
})(GetOrganizationDomain200ResponseStatusEnum || (GetOrganizationDomain200ResponseStatusEnum = {}));
|
|
1629
|
+
export var GetOrganizationLanguageOverrides200ResponseStatusEnum;
|
|
1630
|
+
(function (GetOrganizationLanguageOverrides200ResponseStatusEnum) {
|
|
1631
|
+
GetOrganizationLanguageOverrides200ResponseStatusEnum["Ok"] = "ok";
|
|
1632
|
+
})(GetOrganizationLanguageOverrides200ResponseStatusEnum || (GetOrganizationLanguageOverrides200ResponseStatusEnum = {}));
|
|
1625
1633
|
export var GetOrganizationModule200ResponseStatusEnum;
|
|
1626
1634
|
(function (GetOrganizationModule200ResponseStatusEnum) {
|
|
1627
1635
|
GetOrganizationModule200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -42326,6 +42334,48 @@ export const EventsPassesAddonsApiAxiosParamCreator = function (configuration) {
|
|
|
42326
42334
|
options: localVarRequestOptions,
|
|
42327
42335
|
};
|
|
42328
42336
|
}),
|
|
42337
|
+
/**
|
|
42338
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42339
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42340
|
+
* @param {string} eventId The event identifier
|
|
42341
|
+
* @param {string} passId The pass identifier
|
|
42342
|
+
* @param {string} addOnId The addOn identifier
|
|
42343
|
+
* @param {*} [options] Override http request option.
|
|
42344
|
+
* @throws {RequiredError}
|
|
42345
|
+
*/
|
|
42346
|
+
fulfillEventPassAddOn: (eventId_1, passId_1, addOnId_1, ...args_1) => __awaiter(this, [eventId_1, passId_1, addOnId_1, ...args_1], void 0, function* (eventId, passId, addOnId, options = {}) {
|
|
42347
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
42348
|
+
assertParamExists('fulfillEventPassAddOn', 'eventId', eventId);
|
|
42349
|
+
// verify required parameter 'passId' is not null or undefined
|
|
42350
|
+
assertParamExists('fulfillEventPassAddOn', 'passId', passId);
|
|
42351
|
+
// verify required parameter 'addOnId' is not null or undefined
|
|
42352
|
+
assertParamExists('fulfillEventPassAddOn', 'addOnId', addOnId);
|
|
42353
|
+
const localVarPath = `/events/{eventId}/passes/{passId}/addOns/{addOnId}/fulfill`
|
|
42354
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
42355
|
+
.replace(`{${"passId"}}`, encodeURIComponent(String(passId)))
|
|
42356
|
+
.replace(`{${"addOnId"}}`, encodeURIComponent(String(addOnId)));
|
|
42357
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42358
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42359
|
+
let baseOptions;
|
|
42360
|
+
if (configuration) {
|
|
42361
|
+
baseOptions = configuration.baseOptions;
|
|
42362
|
+
}
|
|
42363
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
42364
|
+
const localVarHeaderParameter = {};
|
|
42365
|
+
const localVarQueryParameter = {};
|
|
42366
|
+
// authentication ApiKeyAuth required
|
|
42367
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
42368
|
+
// authentication OrganizationId required
|
|
42369
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
42370
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
42371
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42372
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42373
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42374
|
+
return {
|
|
42375
|
+
url: toPathString(localVarUrlObj),
|
|
42376
|
+
options: localVarRequestOptions,
|
|
42377
|
+
};
|
|
42378
|
+
}),
|
|
42329
42379
|
/**
|
|
42330
42380
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42331
42381
|
* @summary List an event pass\'s add-ons
|
|
@@ -42422,6 +42472,48 @@ export const EventsPassesAddonsApiAxiosParamCreator = function (configuration) {
|
|
|
42422
42472
|
options: localVarRequestOptions,
|
|
42423
42473
|
};
|
|
42424
42474
|
}),
|
|
42475
|
+
/**
|
|
42476
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42477
|
+
* @summary Undo an add-on fulfillment
|
|
42478
|
+
* @param {string} eventId The event identifier
|
|
42479
|
+
* @param {string} passId The pass identifier
|
|
42480
|
+
* @param {string} addOnId The addOn identifier
|
|
42481
|
+
* @param {*} [options] Override http request option.
|
|
42482
|
+
* @throws {RequiredError}
|
|
42483
|
+
*/
|
|
42484
|
+
unfulfillEventPassAddOn: (eventId_1, passId_1, addOnId_1, ...args_1) => __awaiter(this, [eventId_1, passId_1, addOnId_1, ...args_1], void 0, function* (eventId, passId, addOnId, options = {}) {
|
|
42485
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
42486
|
+
assertParamExists('unfulfillEventPassAddOn', 'eventId', eventId);
|
|
42487
|
+
// verify required parameter 'passId' is not null or undefined
|
|
42488
|
+
assertParamExists('unfulfillEventPassAddOn', 'passId', passId);
|
|
42489
|
+
// verify required parameter 'addOnId' is not null or undefined
|
|
42490
|
+
assertParamExists('unfulfillEventPassAddOn', 'addOnId', addOnId);
|
|
42491
|
+
const localVarPath = `/events/{eventId}/passes/{passId}/addOns/{addOnId}/undo`
|
|
42492
|
+
.replace(`{${"eventId"}}`, encodeURIComponent(String(eventId)))
|
|
42493
|
+
.replace(`{${"passId"}}`, encodeURIComponent(String(passId)))
|
|
42494
|
+
.replace(`{${"addOnId"}}`, encodeURIComponent(String(addOnId)));
|
|
42495
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42496
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42497
|
+
let baseOptions;
|
|
42498
|
+
if (configuration) {
|
|
42499
|
+
baseOptions = configuration.baseOptions;
|
|
42500
|
+
}
|
|
42501
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
42502
|
+
const localVarHeaderParameter = {};
|
|
42503
|
+
const localVarQueryParameter = {};
|
|
42504
|
+
// authentication ApiKeyAuth required
|
|
42505
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
42506
|
+
// authentication OrganizationId required
|
|
42507
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
42508
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
42509
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42510
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42511
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42512
|
+
return {
|
|
42513
|
+
url: toPathString(localVarUrlObj),
|
|
42514
|
+
options: localVarRequestOptions,
|
|
42515
|
+
};
|
|
42516
|
+
}),
|
|
42425
42517
|
};
|
|
42426
42518
|
};
|
|
42427
42519
|
/**
|
|
@@ -42448,6 +42540,24 @@ export const EventsPassesAddonsApiFp = function (configuration) {
|
|
|
42448
42540
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42449
42541
|
});
|
|
42450
42542
|
},
|
|
42543
|
+
/**
|
|
42544
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42545
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42546
|
+
* @param {string} eventId The event identifier
|
|
42547
|
+
* @param {string} passId The pass identifier
|
|
42548
|
+
* @param {string} addOnId The addOn identifier
|
|
42549
|
+
* @param {*} [options] Override http request option.
|
|
42550
|
+
* @throws {RequiredError}
|
|
42551
|
+
*/
|
|
42552
|
+
fulfillEventPassAddOn(eventId, passId, addOnId, options) {
|
|
42553
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42554
|
+
var _a, _b, _c;
|
|
42555
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.fulfillEventPassAddOn(eventId, passId, addOnId, options);
|
|
42556
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42557
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPassesAddonsApi.fulfillEventPassAddOn']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42558
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42559
|
+
});
|
|
42560
|
+
},
|
|
42451
42561
|
/**
|
|
42452
42562
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42453
42563
|
* @summary List an event pass\'s add-ons
|
|
@@ -42487,6 +42597,24 @@ export const EventsPassesAddonsApiFp = function (configuration) {
|
|
|
42487
42597
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42488
42598
|
});
|
|
42489
42599
|
},
|
|
42600
|
+
/**
|
|
42601
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42602
|
+
* @summary Undo an add-on fulfillment
|
|
42603
|
+
* @param {string} eventId The event identifier
|
|
42604
|
+
* @param {string} passId The pass identifier
|
|
42605
|
+
* @param {string} addOnId The addOn identifier
|
|
42606
|
+
* @param {*} [options] Override http request option.
|
|
42607
|
+
* @throws {RequiredError}
|
|
42608
|
+
*/
|
|
42609
|
+
unfulfillEventPassAddOn(eventId, passId, addOnId, options) {
|
|
42610
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42611
|
+
var _a, _b, _c;
|
|
42612
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.unfulfillEventPassAddOn(eventId, passId, addOnId, options);
|
|
42613
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42614
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPassesAddonsApi.unfulfillEventPassAddOn']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42615
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42616
|
+
});
|
|
42617
|
+
},
|
|
42490
42618
|
};
|
|
42491
42619
|
};
|
|
42492
42620
|
/**
|
|
@@ -42505,6 +42633,16 @@ export const EventsPassesAddonsApiFactory = function (configuration, basePath, a
|
|
|
42505
42633
|
addEventPassAddOn(requestParameters, options) {
|
|
42506
42634
|
return localVarFp.addEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42507
42635
|
},
|
|
42636
|
+
/**
|
|
42637
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42638
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42639
|
+
* @param {EventsPassesAddonsApiFulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42640
|
+
* @param {*} [options] Override http request option.
|
|
42641
|
+
* @throws {RequiredError}
|
|
42642
|
+
*/
|
|
42643
|
+
fulfillEventPassAddOn(requestParameters, options) {
|
|
42644
|
+
return localVarFp.fulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42645
|
+
},
|
|
42508
42646
|
/**
|
|
42509
42647
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42510
42648
|
* @summary List an event pass\'s add-ons
|
|
@@ -42525,6 +42663,16 @@ export const EventsPassesAddonsApiFactory = function (configuration, basePath, a
|
|
|
42525
42663
|
removeEventPassAddOn(requestParameters, options) {
|
|
42526
42664
|
return localVarFp.removeEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42527
42665
|
},
|
|
42666
|
+
/**
|
|
42667
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42668
|
+
* @summary Undo an add-on fulfillment
|
|
42669
|
+
* @param {EventsPassesAddonsApiUnfulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42670
|
+
* @param {*} [options] Override http request option.
|
|
42671
|
+
* @throws {RequiredError}
|
|
42672
|
+
*/
|
|
42673
|
+
unfulfillEventPassAddOn(requestParameters, options) {
|
|
42674
|
+
return localVarFp.unfulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(axios, basePath));
|
|
42675
|
+
},
|
|
42528
42676
|
};
|
|
42529
42677
|
};
|
|
42530
42678
|
/**
|
|
@@ -42541,6 +42689,16 @@ export class EventsPassesAddonsApi extends BaseAPI {
|
|
|
42541
42689
|
addEventPassAddOn(requestParameters, options) {
|
|
42542
42690
|
return EventsPassesAddonsApiFp(this.configuration).addEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42543
42691
|
}
|
|
42692
|
+
/**
|
|
42693
|
+
* Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
42694
|
+
* @summary Fulfill an add-on on an attendee\'s pass
|
|
42695
|
+
* @param {EventsPassesAddonsApiFulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42696
|
+
* @param {*} [options] Override http request option.
|
|
42697
|
+
* @throws {RequiredError}
|
|
42698
|
+
*/
|
|
42699
|
+
fulfillEventPassAddOn(requestParameters, options) {
|
|
42700
|
+
return EventsPassesAddonsApiFp(this.configuration).fulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42701
|
+
}
|
|
42544
42702
|
/**
|
|
42545
42703
|
* Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
42546
42704
|
* @summary List an event pass\'s add-ons
|
|
@@ -42561,6 +42719,16 @@ export class EventsPassesAddonsApi extends BaseAPI {
|
|
|
42561
42719
|
removeEventPassAddOn(requestParameters, options) {
|
|
42562
42720
|
return EventsPassesAddonsApiFp(this.configuration).removeEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42563
42721
|
}
|
|
42722
|
+
/**
|
|
42723
|
+
* Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
42724
|
+
* @summary Undo an add-on fulfillment
|
|
42725
|
+
* @param {EventsPassesAddonsApiUnfulfillEventPassAddOnRequest} requestParameters Request parameters.
|
|
42726
|
+
* @param {*} [options] Override http request option.
|
|
42727
|
+
* @throws {RequiredError}
|
|
42728
|
+
*/
|
|
42729
|
+
unfulfillEventPassAddOn(requestParameters, options) {
|
|
42730
|
+
return EventsPassesAddonsApiFp(this.configuration).unfulfillEventPassAddOn(requestParameters.eventId, requestParameters.passId, requestParameters.addOnId, options).then((request) => request(this.axios, this.basePath));
|
|
42731
|
+
}
|
|
42564
42732
|
}
|
|
42565
42733
|
/**
|
|
42566
42734
|
* EventsPassesAttributesApi - axios parameter creator
|
|
@@ -82497,6 +82665,277 @@ export class OrganizationIntegrationsApi extends BaseAPI {
|
|
|
82497
82665
|
return OrganizationIntegrationsApiFp(this.configuration).updateIntegration(requestParameters.integrationId, requestParameters.integrationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
82498
82666
|
}
|
|
82499
82667
|
}
|
|
82668
|
+
/**
|
|
82669
|
+
* OrganizationLanguageoverridesApi - axios parameter creator
|
|
82670
|
+
*/
|
|
82671
|
+
export const OrganizationLanguageoverridesApiAxiosParamCreator = function (configuration) {
|
|
82672
|
+
return {
|
|
82673
|
+
/**
|
|
82674
|
+
* Deletes the organization\'s i18n string override for the given locale and key (sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.
|
|
82675
|
+
* @summary Delete a language override
|
|
82676
|
+
* @param {string} locale The locale identifier
|
|
82677
|
+
* @param {string} key Filter by key
|
|
82678
|
+
* @param {*} [options] Override http request option.
|
|
82679
|
+
* @throws {RequiredError}
|
|
82680
|
+
*/
|
|
82681
|
+
deleteOrganizationLanguageOverride: (locale_1, key_1, ...args_1) => __awaiter(this, [locale_1, key_1, ...args_1], void 0, function* (locale, key, options = {}) {
|
|
82682
|
+
// verify required parameter 'locale' is not null or undefined
|
|
82683
|
+
assertParamExists('deleteOrganizationLanguageOverride', 'locale', locale);
|
|
82684
|
+
// verify required parameter 'key' is not null or undefined
|
|
82685
|
+
assertParamExists('deleteOrganizationLanguageOverride', 'key', key);
|
|
82686
|
+
const localVarPath = `/organization/language-overrides/{locale}`
|
|
82687
|
+
.replace(`{${"locale"}}`, encodeURIComponent(String(locale)));
|
|
82688
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82689
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82690
|
+
let baseOptions;
|
|
82691
|
+
if (configuration) {
|
|
82692
|
+
baseOptions = configuration.baseOptions;
|
|
82693
|
+
}
|
|
82694
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
82695
|
+
const localVarHeaderParameter = {};
|
|
82696
|
+
const localVarQueryParameter = {};
|
|
82697
|
+
// authentication ApiKeyAuth required
|
|
82698
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
82699
|
+
// authentication OrganizationId required
|
|
82700
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
82701
|
+
if (key !== undefined) {
|
|
82702
|
+
localVarQueryParameter['key'] = key;
|
|
82703
|
+
}
|
|
82704
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
82705
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82706
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
82707
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
82708
|
+
return {
|
|
82709
|
+
url: toPathString(localVarUrlObj),
|
|
82710
|
+
options: localVarRequestOptions,
|
|
82711
|
+
};
|
|
82712
|
+
}),
|
|
82713
|
+
/**
|
|
82714
|
+
* Returns a paginated list of the organization\'s i18n string overrides, optionally filtered by locale and searchable by key or value; requires org read permission.
|
|
82715
|
+
* @summary List an organization\'s language overrides
|
|
82716
|
+
* @param {string} [locale] Filter by locale
|
|
82717
|
+
* @param {number} [page] Page number
|
|
82718
|
+
* @param {number} [pageSize] Number of items per page
|
|
82719
|
+
* @param {string} [orderBy] Field to order by
|
|
82720
|
+
* @param {string} [search] Search query
|
|
82721
|
+
* @param {*} [options] Override http request option.
|
|
82722
|
+
* @throws {RequiredError}
|
|
82723
|
+
*/
|
|
82724
|
+
getOrganizationLanguageOverrides: (locale_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [locale_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (locale, page, pageSize, orderBy, search, options = {}) {
|
|
82725
|
+
const localVarPath = `/organization/language-overrides`;
|
|
82726
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82727
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82728
|
+
let baseOptions;
|
|
82729
|
+
if (configuration) {
|
|
82730
|
+
baseOptions = configuration.baseOptions;
|
|
82731
|
+
}
|
|
82732
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
82733
|
+
const localVarHeaderParameter = {};
|
|
82734
|
+
const localVarQueryParameter = {};
|
|
82735
|
+
// authentication ApiKeyAuth required
|
|
82736
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
82737
|
+
// authentication OrganizationId required
|
|
82738
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
82739
|
+
if (locale !== undefined) {
|
|
82740
|
+
localVarQueryParameter['locale'] = locale;
|
|
82741
|
+
}
|
|
82742
|
+
if (page !== undefined) {
|
|
82743
|
+
localVarQueryParameter['page'] = page;
|
|
82744
|
+
}
|
|
82745
|
+
if (pageSize !== undefined) {
|
|
82746
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
82747
|
+
}
|
|
82748
|
+
if (orderBy !== undefined) {
|
|
82749
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
82750
|
+
}
|
|
82751
|
+
if (search !== undefined) {
|
|
82752
|
+
localVarQueryParameter['search'] = search;
|
|
82753
|
+
}
|
|
82754
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
82755
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82756
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
82757
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
82758
|
+
return {
|
|
82759
|
+
url: toPathString(localVarUrlObj),
|
|
82760
|
+
options: localVarRequestOptions,
|
|
82761
|
+
};
|
|
82762
|
+
}),
|
|
82763
|
+
/**
|
|
82764
|
+
* Upserts the organization\'s i18n string override for the given locale and key, requires the update org permission, and refreshes the language overrides list on success.
|
|
82765
|
+
* @summary Create or update a language override
|
|
82766
|
+
* @param {string} locale The locale identifier
|
|
82767
|
+
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
82768
|
+
* @param {*} [options] Override http request option.
|
|
82769
|
+
* @throws {RequiredError}
|
|
82770
|
+
*/
|
|
82771
|
+
upsertOrganizationLanguageOverride: (locale_1, organizationLanguageOverrideUpsertInputs_1, ...args_1) => __awaiter(this, [locale_1, organizationLanguageOverrideUpsertInputs_1, ...args_1], void 0, function* (locale, organizationLanguageOverrideUpsertInputs, options = {}) {
|
|
82772
|
+
// verify required parameter 'locale' is not null or undefined
|
|
82773
|
+
assertParamExists('upsertOrganizationLanguageOverride', 'locale', locale);
|
|
82774
|
+
// verify required parameter 'organizationLanguageOverrideUpsertInputs' is not null or undefined
|
|
82775
|
+
assertParamExists('upsertOrganizationLanguageOverride', 'organizationLanguageOverrideUpsertInputs', organizationLanguageOverrideUpsertInputs);
|
|
82776
|
+
const localVarPath = `/organization/language-overrides/{locale}`
|
|
82777
|
+
.replace(`{${"locale"}}`, encodeURIComponent(String(locale)));
|
|
82778
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82779
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82780
|
+
let baseOptions;
|
|
82781
|
+
if (configuration) {
|
|
82782
|
+
baseOptions = configuration.baseOptions;
|
|
82783
|
+
}
|
|
82784
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
82785
|
+
const localVarHeaderParameter = {};
|
|
82786
|
+
const localVarQueryParameter = {};
|
|
82787
|
+
// authentication ApiKeyAuth required
|
|
82788
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
82789
|
+
// authentication OrganizationId required
|
|
82790
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
82791
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
82792
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
82793
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82794
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
82795
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
82796
|
+
localVarRequestOptions.data = serializeDataIfNeeded(organizationLanguageOverrideUpsertInputs, localVarRequestOptions, configuration);
|
|
82797
|
+
return {
|
|
82798
|
+
url: toPathString(localVarUrlObj),
|
|
82799
|
+
options: localVarRequestOptions,
|
|
82800
|
+
};
|
|
82801
|
+
}),
|
|
82802
|
+
};
|
|
82803
|
+
};
|
|
82804
|
+
/**
|
|
82805
|
+
* OrganizationLanguageoverridesApi - functional programming interface
|
|
82806
|
+
*/
|
|
82807
|
+
export const OrganizationLanguageoverridesApiFp = function (configuration) {
|
|
82808
|
+
const localVarAxiosParamCreator = OrganizationLanguageoverridesApiAxiosParamCreator(configuration);
|
|
82809
|
+
return {
|
|
82810
|
+
/**
|
|
82811
|
+
* Deletes the organization\'s i18n string override for the given locale and key (sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.
|
|
82812
|
+
* @summary Delete a language override
|
|
82813
|
+
* @param {string} locale The locale identifier
|
|
82814
|
+
* @param {string} key Filter by key
|
|
82815
|
+
* @param {*} [options] Override http request option.
|
|
82816
|
+
* @throws {RequiredError}
|
|
82817
|
+
*/
|
|
82818
|
+
deleteOrganizationLanguageOverride(locale, key, options) {
|
|
82819
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82820
|
+
var _a, _b, _c;
|
|
82821
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationLanguageOverride(locale, key, options);
|
|
82822
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82823
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.deleteOrganizationLanguageOverride']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82824
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82825
|
+
});
|
|
82826
|
+
},
|
|
82827
|
+
/**
|
|
82828
|
+
* Returns a paginated list of the organization\'s i18n string overrides, optionally filtered by locale and searchable by key or value; requires org read permission.
|
|
82829
|
+
* @summary List an organization\'s language overrides
|
|
82830
|
+
* @param {string} [locale] Filter by locale
|
|
82831
|
+
* @param {number} [page] Page number
|
|
82832
|
+
* @param {number} [pageSize] Number of items per page
|
|
82833
|
+
* @param {string} [orderBy] Field to order by
|
|
82834
|
+
* @param {string} [search] Search query
|
|
82835
|
+
* @param {*} [options] Override http request option.
|
|
82836
|
+
* @throws {RequiredError}
|
|
82837
|
+
*/
|
|
82838
|
+
getOrganizationLanguageOverrides(locale, page, pageSize, orderBy, search, options) {
|
|
82839
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82840
|
+
var _a, _b, _c;
|
|
82841
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationLanguageOverrides(locale, page, pageSize, orderBy, search, options);
|
|
82842
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82843
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.getOrganizationLanguageOverrides']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82844
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82845
|
+
});
|
|
82846
|
+
},
|
|
82847
|
+
/**
|
|
82848
|
+
* Upserts the organization\'s i18n string override for the given locale and key, requires the update org permission, and refreshes the language overrides list on success.
|
|
82849
|
+
* @summary Create or update a language override
|
|
82850
|
+
* @param {string} locale The locale identifier
|
|
82851
|
+
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
82852
|
+
* @param {*} [options] Override http request option.
|
|
82853
|
+
* @throws {RequiredError}
|
|
82854
|
+
*/
|
|
82855
|
+
upsertOrganizationLanguageOverride(locale, organizationLanguageOverrideUpsertInputs, options) {
|
|
82856
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82857
|
+
var _a, _b, _c;
|
|
82858
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.upsertOrganizationLanguageOverride(locale, organizationLanguageOverrideUpsertInputs, options);
|
|
82859
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82860
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.upsertOrganizationLanguageOverride']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82861
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82862
|
+
});
|
|
82863
|
+
},
|
|
82864
|
+
};
|
|
82865
|
+
};
|
|
82866
|
+
/**
|
|
82867
|
+
* OrganizationLanguageoverridesApi - factory interface
|
|
82868
|
+
*/
|
|
82869
|
+
export const OrganizationLanguageoverridesApiFactory = function (configuration, basePath, axios) {
|
|
82870
|
+
const localVarFp = OrganizationLanguageoverridesApiFp(configuration);
|
|
82871
|
+
return {
|
|
82872
|
+
/**
|
|
82873
|
+
* Deletes the organization\'s i18n string override for the given locale and key (sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.
|
|
82874
|
+
* @summary Delete a language override
|
|
82875
|
+
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82876
|
+
* @param {*} [options] Override http request option.
|
|
82877
|
+
* @throws {RequiredError}
|
|
82878
|
+
*/
|
|
82879
|
+
deleteOrganizationLanguageOverride(requestParameters, options) {
|
|
82880
|
+
return localVarFp.deleteOrganizationLanguageOverride(requestParameters.locale, requestParameters.key, options).then((request) => request(axios, basePath));
|
|
82881
|
+
},
|
|
82882
|
+
/**
|
|
82883
|
+
* Returns a paginated list of the organization\'s i18n string overrides, optionally filtered by locale and searchable by key or value; requires org read permission.
|
|
82884
|
+
* @summary List an organization\'s language overrides
|
|
82885
|
+
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
82886
|
+
* @param {*} [options] Override http request option.
|
|
82887
|
+
* @throws {RequiredError}
|
|
82888
|
+
*/
|
|
82889
|
+
getOrganizationLanguageOverrides(requestParameters = {}, options) {
|
|
82890
|
+
return localVarFp.getOrganizationLanguageOverrides(requestParameters.locale, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
82891
|
+
},
|
|
82892
|
+
/**
|
|
82893
|
+
* Upserts the organization\'s i18n string override for the given locale and key, requires the update org permission, and refreshes the language overrides list on success.
|
|
82894
|
+
* @summary Create or update a language override
|
|
82895
|
+
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82896
|
+
* @param {*} [options] Override http request option.
|
|
82897
|
+
* @throws {RequiredError}
|
|
82898
|
+
*/
|
|
82899
|
+
upsertOrganizationLanguageOverride(requestParameters, options) {
|
|
82900
|
+
return localVarFp.upsertOrganizationLanguageOverride(requestParameters.locale, requestParameters.organizationLanguageOverrideUpsertInputs, options).then((request) => request(axios, basePath));
|
|
82901
|
+
},
|
|
82902
|
+
};
|
|
82903
|
+
};
|
|
82904
|
+
/**
|
|
82905
|
+
* OrganizationLanguageoverridesApi - object-oriented interface
|
|
82906
|
+
*/
|
|
82907
|
+
export class OrganizationLanguageoverridesApi extends BaseAPI {
|
|
82908
|
+
/**
|
|
82909
|
+
* Deletes the organization\'s i18n string override for the given locale and key (sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.
|
|
82910
|
+
* @summary Delete a language override
|
|
82911
|
+
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82912
|
+
* @param {*} [options] Override http request option.
|
|
82913
|
+
* @throws {RequiredError}
|
|
82914
|
+
*/
|
|
82915
|
+
deleteOrganizationLanguageOverride(requestParameters, options) {
|
|
82916
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).deleteOrganizationLanguageOverride(requestParameters.locale, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
|
|
82917
|
+
}
|
|
82918
|
+
/**
|
|
82919
|
+
* Returns a paginated list of the organization\'s i18n string overrides, optionally filtered by locale and searchable by key or value; requires org read permission.
|
|
82920
|
+
* @summary List an organization\'s language overrides
|
|
82921
|
+
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
82922
|
+
* @param {*} [options] Override http request option.
|
|
82923
|
+
* @throws {RequiredError}
|
|
82924
|
+
*/
|
|
82925
|
+
getOrganizationLanguageOverrides(requestParameters = {}, options) {
|
|
82926
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).getOrganizationLanguageOverrides(requestParameters.locale, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
82927
|
+
}
|
|
82928
|
+
/**
|
|
82929
|
+
* Upserts the organization\'s i18n string override for the given locale and key, requires the update org permission, and refreshes the language overrides list on success.
|
|
82930
|
+
* @summary Create or update a language override
|
|
82931
|
+
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82932
|
+
* @param {*} [options] Override http request option.
|
|
82933
|
+
* @throws {RequiredError}
|
|
82934
|
+
*/
|
|
82935
|
+
upsertOrganizationLanguageOverride(requestParameters, options) {
|
|
82936
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).upsertOrganizationLanguageOverride(requestParameters.locale, requestParameters.organizationLanguageOverrideUpsertInputs, options).then((request) => request(this.axios, this.basePath));
|
|
82937
|
+
}
|
|
82938
|
+
}
|
|
82500
82939
|
/**
|
|
82501
82940
|
* OrganizationModulesApi - axios parameter creator
|
|
82502
82941
|
*/
|
package/docs/BasePassAddOn.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**addOnId** | **string** | | [default to undefined]
|
|
9
9
|
**addOn** | [**BaseEventAddOn**](BaseEventAddOn.md) | | [default to undefined]
|
|
10
|
+
**fulfilledAt** | **string** | | [default to undefined]
|
|
10
11
|
**pass** | [**BasePassAddOnPass**](BasePassAddOnPass.md) | | [default to undefined]
|
|
11
12
|
**createdAt** | **string** | | [default to undefined]
|
|
12
13
|
|
|
@@ -18,6 +19,7 @@ import { BasePassAddOn } from '@connectedxm/admin-sdk';
|
|
|
18
19
|
const instance: BasePassAddOn = {
|
|
19
20
|
addOnId,
|
|
20
21
|
addOn,
|
|
22
|
+
fulfilledAt,
|
|
21
23
|
pass,
|
|
22
24
|
createdAt,
|
|
23
25
|
};
|