@connectedxm/admin-sdk 7.9.5 → 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 +4 -0
- package/AdminApi.ts +3 -0
- package/README.md +6 -0
- package/api.ts +373 -0
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +196 -0
- package/dist/api.js +300 -21
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +196 -0
- package/dist/esm/api.js +275 -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/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -8235,6 +8235,15 @@ export interface GetOrganizationDomain200Response {
|
|
|
8235
8235
|
export declare enum GetOrganizationDomain200ResponseStatusEnum {
|
|
8236
8236
|
Ok = "ok"
|
|
8237
8237
|
}
|
|
8238
|
+
export interface GetOrganizationLanguageOverrides200Response {
|
|
8239
|
+
'status': GetOrganizationLanguageOverrides200ResponseStatusEnum;
|
|
8240
|
+
'message': string;
|
|
8241
|
+
'data': Array<OrganizationLanguageOverride>;
|
|
8242
|
+
'count'?: number;
|
|
8243
|
+
}
|
|
8244
|
+
export declare enum GetOrganizationLanguageOverrides200ResponseStatusEnum {
|
|
8245
|
+
Ok = "ok"
|
|
8246
|
+
}
|
|
8238
8247
|
export interface GetOrganizationModule200Response {
|
|
8239
8248
|
'status': GetOrganizationModule200ResponseStatusEnum;
|
|
8240
8249
|
'message': string;
|
|
@@ -10004,6 +10013,17 @@ export declare enum OrganizationActionType {
|
|
|
10004
10013
|
export interface OrganizationAllOfOAuth {
|
|
10005
10014
|
'id': string;
|
|
10006
10015
|
}
|
|
10016
|
+
export interface OrganizationLanguageOverride {
|
|
10017
|
+
'locale': string;
|
|
10018
|
+
'key': string;
|
|
10019
|
+
'value': string;
|
|
10020
|
+
'createdAt': string;
|
|
10021
|
+
'updatedAt': string;
|
|
10022
|
+
}
|
|
10023
|
+
export interface OrganizationLanguageOverrideUpsertInputs {
|
|
10024
|
+
'key': string;
|
|
10025
|
+
'value': string;
|
|
10026
|
+
}
|
|
10007
10027
|
export interface OrganizationMembership {
|
|
10008
10028
|
'id': string;
|
|
10009
10029
|
'organizationId': string;
|
|
@@ -66391,6 +66411,182 @@ export declare class OrganizationIntegrationsApi extends BaseAPI {
|
|
|
66391
66411
|
*/
|
|
66392
66412
|
updateIntegration(requestParameters: OrganizationIntegrationsApiUpdateIntegrationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateIntegration200Response, any, {}>>;
|
|
66393
66413
|
}
|
|
66414
|
+
/**
|
|
66415
|
+
* OrganizationLanguageoverridesApi - axios parameter creator
|
|
66416
|
+
*/
|
|
66417
|
+
export declare const OrganizationLanguageoverridesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
66418
|
+
/**
|
|
66419
|
+
* 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.
|
|
66420
|
+
* @summary Delete a language override
|
|
66421
|
+
* @param {string} locale The locale identifier
|
|
66422
|
+
* @param {string} key Filter by key
|
|
66423
|
+
* @param {*} [options] Override http request option.
|
|
66424
|
+
* @throws {RequiredError}
|
|
66425
|
+
*/
|
|
66426
|
+
deleteOrganizationLanguageOverride: (locale: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66427
|
+
/**
|
|
66428
|
+
* 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.
|
|
66429
|
+
* @summary List an organization\'s language overrides
|
|
66430
|
+
* @param {string} [locale] Filter by locale
|
|
66431
|
+
* @param {number} [page] Page number
|
|
66432
|
+
* @param {number} [pageSize] Number of items per page
|
|
66433
|
+
* @param {string} [orderBy] Field to order by
|
|
66434
|
+
* @param {string} [search] Search query
|
|
66435
|
+
* @param {*} [options] Override http request option.
|
|
66436
|
+
* @throws {RequiredError}
|
|
66437
|
+
*/
|
|
66438
|
+
getOrganizationLanguageOverrides: (locale?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66439
|
+
/**
|
|
66440
|
+
* 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.
|
|
66441
|
+
* @summary Create or update a language override
|
|
66442
|
+
* @param {string} locale The locale identifier
|
|
66443
|
+
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
66444
|
+
* @param {*} [options] Override http request option.
|
|
66445
|
+
* @throws {RequiredError}
|
|
66446
|
+
*/
|
|
66447
|
+
upsertOrganizationLanguageOverride: (locale: string, organizationLanguageOverrideUpsertInputs: OrganizationLanguageOverrideUpsertInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66448
|
+
};
|
|
66449
|
+
/**
|
|
66450
|
+
* OrganizationLanguageoverridesApi - functional programming interface
|
|
66451
|
+
*/
|
|
66452
|
+
export declare const OrganizationLanguageoverridesApiFp: (configuration?: Configuration) => {
|
|
66453
|
+
/**
|
|
66454
|
+
* 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.
|
|
66455
|
+
* @summary Delete a language override
|
|
66456
|
+
* @param {string} locale The locale identifier
|
|
66457
|
+
* @param {string} key Filter by key
|
|
66458
|
+
* @param {*} [options] Override http request option.
|
|
66459
|
+
* @throws {RequiredError}
|
|
66460
|
+
*/
|
|
66461
|
+
deleteOrganizationLanguageOverride(locale: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncAccounts200Response>>;
|
|
66462
|
+
/**
|
|
66463
|
+
* 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.
|
|
66464
|
+
* @summary List an organization\'s language overrides
|
|
66465
|
+
* @param {string} [locale] Filter by locale
|
|
66466
|
+
* @param {number} [page] Page number
|
|
66467
|
+
* @param {number} [pageSize] Number of items per page
|
|
66468
|
+
* @param {string} [orderBy] Field to order by
|
|
66469
|
+
* @param {string} [search] Search query
|
|
66470
|
+
* @param {*} [options] Override http request option.
|
|
66471
|
+
* @throws {RequiredError}
|
|
66472
|
+
*/
|
|
66473
|
+
getOrganizationLanguageOverrides(locale?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationLanguageOverrides200Response>>;
|
|
66474
|
+
/**
|
|
66475
|
+
* 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.
|
|
66476
|
+
* @summary Create or update a language override
|
|
66477
|
+
* @param {string} locale The locale identifier
|
|
66478
|
+
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
66479
|
+
* @param {*} [options] Override http request option.
|
|
66480
|
+
* @throws {RequiredError}
|
|
66481
|
+
*/
|
|
66482
|
+
upsertOrganizationLanguageOverride(locale: string, organizationLanguageOverrideUpsertInputs: OrganizationLanguageOverrideUpsertInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncAccounts200Response>>;
|
|
66483
|
+
};
|
|
66484
|
+
/**
|
|
66485
|
+
* OrganizationLanguageoverridesApi - factory interface
|
|
66486
|
+
*/
|
|
66487
|
+
export declare const OrganizationLanguageoverridesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
66488
|
+
/**
|
|
66489
|
+
* 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.
|
|
66490
|
+
* @summary Delete a language override
|
|
66491
|
+
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
66492
|
+
* @param {*} [options] Override http request option.
|
|
66493
|
+
* @throws {RequiredError}
|
|
66494
|
+
*/
|
|
66495
|
+
deleteOrganizationLanguageOverride(requestParameters: OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest, options?: RawAxiosRequestConfig): AxiosPromise<SyncAccounts200Response>;
|
|
66496
|
+
/**
|
|
66497
|
+
* 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.
|
|
66498
|
+
* @summary List an organization\'s language overrides
|
|
66499
|
+
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
66500
|
+
* @param {*} [options] Override http request option.
|
|
66501
|
+
* @throws {RequiredError}
|
|
66502
|
+
*/
|
|
66503
|
+
getOrganizationLanguageOverrides(requestParameters?: OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationLanguageOverrides200Response>;
|
|
66504
|
+
/**
|
|
66505
|
+
* 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.
|
|
66506
|
+
* @summary Create or update a language override
|
|
66507
|
+
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
66508
|
+
* @param {*} [options] Override http request option.
|
|
66509
|
+
* @throws {RequiredError}
|
|
66510
|
+
*/
|
|
66511
|
+
upsertOrganizationLanguageOverride(requestParameters: OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest, options?: RawAxiosRequestConfig): AxiosPromise<SyncAccounts200Response>;
|
|
66512
|
+
};
|
|
66513
|
+
/**
|
|
66514
|
+
* Request parameters for deleteOrganizationLanguageOverride operation in OrganizationLanguageoverridesApi.
|
|
66515
|
+
*/
|
|
66516
|
+
export interface OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest {
|
|
66517
|
+
/**
|
|
66518
|
+
* The locale identifier
|
|
66519
|
+
*/
|
|
66520
|
+
readonly locale: string;
|
|
66521
|
+
/**
|
|
66522
|
+
* Filter by key
|
|
66523
|
+
*/
|
|
66524
|
+
readonly key: string;
|
|
66525
|
+
}
|
|
66526
|
+
/**
|
|
66527
|
+
* Request parameters for getOrganizationLanguageOverrides operation in OrganizationLanguageoverridesApi.
|
|
66528
|
+
*/
|
|
66529
|
+
export interface OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest {
|
|
66530
|
+
/**
|
|
66531
|
+
* Filter by locale
|
|
66532
|
+
*/
|
|
66533
|
+
readonly locale?: string;
|
|
66534
|
+
/**
|
|
66535
|
+
* Page number
|
|
66536
|
+
*/
|
|
66537
|
+
readonly page?: number;
|
|
66538
|
+
/**
|
|
66539
|
+
* Number of items per page
|
|
66540
|
+
*/
|
|
66541
|
+
readonly pageSize?: number;
|
|
66542
|
+
/**
|
|
66543
|
+
* Field to order by
|
|
66544
|
+
*/
|
|
66545
|
+
readonly orderBy?: string;
|
|
66546
|
+
/**
|
|
66547
|
+
* Search query
|
|
66548
|
+
*/
|
|
66549
|
+
readonly search?: string;
|
|
66550
|
+
}
|
|
66551
|
+
/**
|
|
66552
|
+
* Request parameters for upsertOrganizationLanguageOverride operation in OrganizationLanguageoverridesApi.
|
|
66553
|
+
*/
|
|
66554
|
+
export interface OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest {
|
|
66555
|
+
/**
|
|
66556
|
+
* The locale identifier
|
|
66557
|
+
*/
|
|
66558
|
+
readonly locale: string;
|
|
66559
|
+
readonly organizationLanguageOverrideUpsertInputs: OrganizationLanguageOverrideUpsertInputs;
|
|
66560
|
+
}
|
|
66561
|
+
/**
|
|
66562
|
+
* OrganizationLanguageoverridesApi - object-oriented interface
|
|
66563
|
+
*/
|
|
66564
|
+
export declare class OrganizationLanguageoverridesApi extends BaseAPI {
|
|
66565
|
+
/**
|
|
66566
|
+
* 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.
|
|
66567
|
+
* @summary Delete a language override
|
|
66568
|
+
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
66569
|
+
* @param {*} [options] Override http request option.
|
|
66570
|
+
* @throws {RequiredError}
|
|
66571
|
+
*/
|
|
66572
|
+
deleteOrganizationLanguageOverride(requestParameters: OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}>>;
|
|
66573
|
+
/**
|
|
66574
|
+
* 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.
|
|
66575
|
+
* @summary List an organization\'s language overrides
|
|
66576
|
+
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
66577
|
+
* @param {*} [options] Override http request option.
|
|
66578
|
+
* @throws {RequiredError}
|
|
66579
|
+
*/
|
|
66580
|
+
getOrganizationLanguageOverrides(requestParameters?: OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationLanguageOverrides200Response, any, {}>>;
|
|
66581
|
+
/**
|
|
66582
|
+
* 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.
|
|
66583
|
+
* @summary Create or update a language override
|
|
66584
|
+
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
66585
|
+
* @param {*} [options] Override http request option.
|
|
66586
|
+
* @throws {RequiredError}
|
|
66587
|
+
*/
|
|
66588
|
+
upsertOrganizationLanguageOverride(requestParameters: OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}>>;
|
|
66589
|
+
}
|
|
66394
66590
|
/**
|
|
66395
66591
|
* OrganizationModulesApi - axios parameter creator
|
|
66396
66592
|
*/
|
package/dist/esm/api.js
CHANGED
|
@@ -1626,6 +1626,10 @@ export var GetOrganizationDomain200ResponseStatusEnum;
|
|
|
1626
1626
|
(function (GetOrganizationDomain200ResponseStatusEnum) {
|
|
1627
1627
|
GetOrganizationDomain200ResponseStatusEnum["Ok"] = "ok";
|
|
1628
1628
|
})(GetOrganizationDomain200ResponseStatusEnum || (GetOrganizationDomain200ResponseStatusEnum = {}));
|
|
1629
|
+
export var GetOrganizationLanguageOverrides200ResponseStatusEnum;
|
|
1630
|
+
(function (GetOrganizationLanguageOverrides200ResponseStatusEnum) {
|
|
1631
|
+
GetOrganizationLanguageOverrides200ResponseStatusEnum["Ok"] = "ok";
|
|
1632
|
+
})(GetOrganizationLanguageOverrides200ResponseStatusEnum || (GetOrganizationLanguageOverrides200ResponseStatusEnum = {}));
|
|
1629
1633
|
export var GetOrganizationModule200ResponseStatusEnum;
|
|
1630
1634
|
(function (GetOrganizationModule200ResponseStatusEnum) {
|
|
1631
1635
|
GetOrganizationModule200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -82661,6 +82665,277 @@ export class OrganizationIntegrationsApi extends BaseAPI {
|
|
|
82661
82665
|
return OrganizationIntegrationsApiFp(this.configuration).updateIntegration(requestParameters.integrationId, requestParameters.integrationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
82662
82666
|
}
|
|
82663
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
|
+
}
|
|
82664
82939
|
/**
|
|
82665
82940
|
* OrganizationModulesApi - axios parameter creator
|
|
82666
82941
|
*/
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetOrganizationLanguageOverrides200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<OrganizationLanguageOverride>**](OrganizationLanguageOverride.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetOrganizationLanguageOverrides200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetOrganizationLanguageOverrides200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# OrganizationLanguageOverride
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**locale** | **string** | | [default to undefined]
|
|
9
|
+
**key** | **string** | | [default to undefined]
|
|
10
|
+
**value** | **string** | | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | | [default to undefined]
|
|
12
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { OrganizationLanguageOverride } from '@connectedxm/admin-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: OrganizationLanguageOverride = {
|
|
20
|
+
locale,
|
|
21
|
+
key,
|
|
22
|
+
value,
|
|
23
|
+
createdAt,
|
|
24
|
+
updatedAt,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# OrganizationLanguageOverrideUpsertInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**key** | **string** | | [default to undefined]
|
|
9
|
+
**value** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { OrganizationLanguageOverrideUpsertInputs } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: OrganizationLanguageOverrideUpsertInputs = {
|
|
17
|
+
key,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|