@connectedxm/admin-sdk 7.10.0 → 7.11.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/README.md +2 -2
- package/api.ts +31 -63
- package/dist/api.d.ts +24 -39
- package/dist/api.js +29 -44
- package/dist/esm/api.d.ts +24 -39
- package/dist/esm/api.js +29 -44
- package/docs/OrganizationLanguageOverride.md +2 -4
- package/docs/OrganizationLanguageOverrideUpsertInputs.md +2 -2
- package/docs/OrganizationLanguageoverridesApi.md +5 -14
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -82671,20 +82671,16 @@ export class OrganizationIntegrationsApi extends BaseAPI {
|
|
|
82671
82671
|
export const OrganizationLanguageoverridesApiAxiosParamCreator = function (configuration) {
|
|
82672
82672
|
return {
|
|
82673
82673
|
/**
|
|
82674
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82674
|
+
* Deletes the organization\'s i18n string override for the given key across all locales (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
82675
|
* @summary Delete a language override
|
|
82676
|
-
* @param {string} locale The locale identifier
|
|
82677
82676
|
* @param {string} key Filter by key
|
|
82678
82677
|
* @param {*} [options] Override http request option.
|
|
82679
82678
|
* @throws {RequiredError}
|
|
82680
82679
|
*/
|
|
82681
|
-
deleteOrganizationLanguageOverride: (
|
|
82682
|
-
// verify required parameter 'locale' is not null or undefined
|
|
82683
|
-
assertParamExists('deleteOrganizationLanguageOverride', 'locale', locale);
|
|
82680
|
+
deleteOrganizationLanguageOverride: (key_1, ...args_1) => __awaiter(this, [key_1, ...args_1], void 0, function* (key, options = {}) {
|
|
82684
82681
|
// verify required parameter 'key' is not null or undefined
|
|
82685
82682
|
assertParamExists('deleteOrganizationLanguageOverride', 'key', key);
|
|
82686
|
-
const localVarPath = `/organization/language-overrides
|
|
82687
|
-
.replace(`{${"locale"}}`, encodeURIComponent(String(locale)));
|
|
82683
|
+
const localVarPath = `/organization/language-overrides`;
|
|
82688
82684
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82689
82685
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82690
82686
|
let baseOptions;
|
|
@@ -82711,9 +82707,8 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82711
82707
|
};
|
|
82712
82708
|
}),
|
|
82713
82709
|
/**
|
|
82714
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82710
|
+
* Returns a paginated list of the organization\'s i18n string overrides grouped by key, each with its per-locale values; searchable by key. Requires org read permission.
|
|
82715
82711
|
* @summary List an organization\'s language overrides
|
|
82716
|
-
* @param {string} [locale] Filter by locale
|
|
82717
82712
|
* @param {number} [page] Page number
|
|
82718
82713
|
* @param {number} [pageSize] Number of items per page
|
|
82719
82714
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82721,7 +82716,7 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82721
82716
|
* @param {*} [options] Override http request option.
|
|
82722
82717
|
* @throws {RequiredError}
|
|
82723
82718
|
*/
|
|
82724
|
-
getOrganizationLanguageOverrides: (
|
|
82719
|
+
getOrganizationLanguageOverrides: (page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (page, pageSize, orderBy, search, options = {}) {
|
|
82725
82720
|
const localVarPath = `/organization/language-overrides`;
|
|
82726
82721
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82727
82722
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -82736,9 +82731,6 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82736
82731
|
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
82737
82732
|
// authentication OrganizationId required
|
|
82738
82733
|
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
82739
|
-
if (locale !== undefined) {
|
|
82740
|
-
localVarQueryParameter['locale'] = locale;
|
|
82741
|
-
}
|
|
82742
82734
|
if (page !== undefined) {
|
|
82743
82735
|
localVarQueryParameter['page'] = page;
|
|
82744
82736
|
}
|
|
@@ -82761,20 +82753,16 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82761
82753
|
};
|
|
82762
82754
|
}),
|
|
82763
82755
|
/**
|
|
82764
|
-
* Upserts the organization\'s i18n string override for
|
|
82756
|
+
* Upserts the organization\'s i18n string override for a key across all supplied locale values in a single request, requires the update org permission, and refreshes the language overrides list on success.
|
|
82765
82757
|
* @summary Create or update a language override
|
|
82766
|
-
* @param {string} locale The locale identifier
|
|
82767
82758
|
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
82768
82759
|
* @param {*} [options] Override http request option.
|
|
82769
82760
|
* @throws {RequiredError}
|
|
82770
82761
|
*/
|
|
82771
|
-
upsertOrganizationLanguageOverride: (
|
|
82772
|
-
// verify required parameter 'locale' is not null or undefined
|
|
82773
|
-
assertParamExists('upsertOrganizationLanguageOverride', 'locale', locale);
|
|
82762
|
+
upsertOrganizationLanguageOverride: (organizationLanguageOverrideUpsertInputs_1, ...args_1) => __awaiter(this, [organizationLanguageOverrideUpsertInputs_1, ...args_1], void 0, function* (organizationLanguageOverrideUpsertInputs, options = {}) {
|
|
82774
82763
|
// verify required parameter 'organizationLanguageOverrideUpsertInputs' is not null or undefined
|
|
82775
82764
|
assertParamExists('upsertOrganizationLanguageOverride', 'organizationLanguageOverrideUpsertInputs', organizationLanguageOverrideUpsertInputs);
|
|
82776
|
-
const localVarPath = `/organization/language-overrides
|
|
82777
|
-
.replace(`{${"locale"}}`, encodeURIComponent(String(locale)));
|
|
82765
|
+
const localVarPath = `/organization/language-overrides`;
|
|
82778
82766
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82779
82767
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82780
82768
|
let baseOptions;
|
|
@@ -82808,26 +82796,24 @@ export const OrganizationLanguageoverridesApiFp = function (configuration) {
|
|
|
82808
82796
|
const localVarAxiosParamCreator = OrganizationLanguageoverridesApiAxiosParamCreator(configuration);
|
|
82809
82797
|
return {
|
|
82810
82798
|
/**
|
|
82811
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82799
|
+
* Deletes the organization\'s i18n string override for the given key across all locales (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
82800
|
* @summary Delete a language override
|
|
82813
|
-
* @param {string} locale The locale identifier
|
|
82814
82801
|
* @param {string} key Filter by key
|
|
82815
82802
|
* @param {*} [options] Override http request option.
|
|
82816
82803
|
* @throws {RequiredError}
|
|
82817
82804
|
*/
|
|
82818
|
-
deleteOrganizationLanguageOverride(
|
|
82805
|
+
deleteOrganizationLanguageOverride(key, options) {
|
|
82819
82806
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82820
82807
|
var _a, _b, _c;
|
|
82821
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationLanguageOverride(
|
|
82808
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationLanguageOverride(key, options);
|
|
82822
82809
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82823
82810
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.deleteOrganizationLanguageOverride']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82824
82811
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82825
82812
|
});
|
|
82826
82813
|
},
|
|
82827
82814
|
/**
|
|
82828
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82815
|
+
* Returns a paginated list of the organization\'s i18n string overrides grouped by key, each with its per-locale values; searchable by key. Requires org read permission.
|
|
82829
82816
|
* @summary List an organization\'s language overrides
|
|
82830
|
-
* @param {string} [locale] Filter by locale
|
|
82831
82817
|
* @param {number} [page] Page number
|
|
82832
82818
|
* @param {number} [pageSize] Number of items per page
|
|
82833
82819
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82835,27 +82821,26 @@ export const OrganizationLanguageoverridesApiFp = function (configuration) {
|
|
|
82835
82821
|
* @param {*} [options] Override http request option.
|
|
82836
82822
|
* @throws {RequiredError}
|
|
82837
82823
|
*/
|
|
82838
|
-
getOrganizationLanguageOverrides(
|
|
82824
|
+
getOrganizationLanguageOverrides(page, pageSize, orderBy, search, options) {
|
|
82839
82825
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82840
82826
|
var _a, _b, _c;
|
|
82841
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationLanguageOverrides(
|
|
82827
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationLanguageOverrides(page, pageSize, orderBy, search, options);
|
|
82842
82828
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82843
82829
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.getOrganizationLanguageOverrides']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82844
82830
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82845
82831
|
});
|
|
82846
82832
|
},
|
|
82847
82833
|
/**
|
|
82848
|
-
* Upserts the organization\'s i18n string override for
|
|
82834
|
+
* Upserts the organization\'s i18n string override for a key across all supplied locale values in a single request, requires the update org permission, and refreshes the language overrides list on success.
|
|
82849
82835
|
* @summary Create or update a language override
|
|
82850
|
-
* @param {string} locale The locale identifier
|
|
82851
82836
|
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
82852
82837
|
* @param {*} [options] Override http request option.
|
|
82853
82838
|
* @throws {RequiredError}
|
|
82854
82839
|
*/
|
|
82855
|
-
upsertOrganizationLanguageOverride(
|
|
82840
|
+
upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs, options) {
|
|
82856
82841
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82857
82842
|
var _a, _b, _c;
|
|
82858
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.upsertOrganizationLanguageOverride(
|
|
82843
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs, options);
|
|
82859
82844
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82860
82845
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.upsertOrganizationLanguageOverride']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82861
82846
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -82870,34 +82855,34 @@ export const OrganizationLanguageoverridesApiFactory = function (configuration,
|
|
|
82870
82855
|
const localVarFp = OrganizationLanguageoverridesApiFp(configuration);
|
|
82871
82856
|
return {
|
|
82872
82857
|
/**
|
|
82873
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82858
|
+
* Deletes the organization\'s i18n string override for the given key across all locales (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
82859
|
* @summary Delete a language override
|
|
82875
82860
|
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82876
82861
|
* @param {*} [options] Override http request option.
|
|
82877
82862
|
* @throws {RequiredError}
|
|
82878
82863
|
*/
|
|
82879
82864
|
deleteOrganizationLanguageOverride(requestParameters, options) {
|
|
82880
|
-
return localVarFp.deleteOrganizationLanguageOverride(requestParameters.
|
|
82865
|
+
return localVarFp.deleteOrganizationLanguageOverride(requestParameters.key, options).then((request) => request(axios, basePath));
|
|
82881
82866
|
},
|
|
82882
82867
|
/**
|
|
82883
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82868
|
+
* Returns a paginated list of the organization\'s i18n string overrides grouped by key, each with its per-locale values; searchable by key. Requires org read permission.
|
|
82884
82869
|
* @summary List an organization\'s language overrides
|
|
82885
82870
|
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
82886
82871
|
* @param {*} [options] Override http request option.
|
|
82887
82872
|
* @throws {RequiredError}
|
|
82888
82873
|
*/
|
|
82889
82874
|
getOrganizationLanguageOverrides(requestParameters = {}, options) {
|
|
82890
|
-
return localVarFp.getOrganizationLanguageOverrides(requestParameters.
|
|
82875
|
+
return localVarFp.getOrganizationLanguageOverrides(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
82891
82876
|
},
|
|
82892
82877
|
/**
|
|
82893
|
-
* Upserts the organization\'s i18n string override for
|
|
82878
|
+
* Upserts the organization\'s i18n string override for a key across all supplied locale values in a single request, requires the update org permission, and refreshes the language overrides list on success.
|
|
82894
82879
|
* @summary Create or update a language override
|
|
82895
82880
|
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82896
82881
|
* @param {*} [options] Override http request option.
|
|
82897
82882
|
* @throws {RequiredError}
|
|
82898
82883
|
*/
|
|
82899
82884
|
upsertOrganizationLanguageOverride(requestParameters, options) {
|
|
82900
|
-
return localVarFp.upsertOrganizationLanguageOverride(requestParameters.
|
|
82885
|
+
return localVarFp.upsertOrganizationLanguageOverride(requestParameters.organizationLanguageOverrideUpsertInputs, options).then((request) => request(axios, basePath));
|
|
82901
82886
|
},
|
|
82902
82887
|
};
|
|
82903
82888
|
};
|
|
@@ -82906,34 +82891,34 @@ export const OrganizationLanguageoverridesApiFactory = function (configuration,
|
|
|
82906
82891
|
*/
|
|
82907
82892
|
export class OrganizationLanguageoverridesApi extends BaseAPI {
|
|
82908
82893
|
/**
|
|
82909
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82894
|
+
* Deletes the organization\'s i18n string override for the given key across all locales (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
82895
|
* @summary Delete a language override
|
|
82911
82896
|
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82912
82897
|
* @param {*} [options] Override http request option.
|
|
82913
82898
|
* @throws {RequiredError}
|
|
82914
82899
|
*/
|
|
82915
82900
|
deleteOrganizationLanguageOverride(requestParameters, options) {
|
|
82916
|
-
return OrganizationLanguageoverridesApiFp(this.configuration).deleteOrganizationLanguageOverride(requestParameters.
|
|
82901
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).deleteOrganizationLanguageOverride(requestParameters.key, options).then((request) => request(this.axios, this.basePath));
|
|
82917
82902
|
}
|
|
82918
82903
|
/**
|
|
82919
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82904
|
+
* Returns a paginated list of the organization\'s i18n string overrides grouped by key, each with its per-locale values; searchable by key. Requires org read permission.
|
|
82920
82905
|
* @summary List an organization\'s language overrides
|
|
82921
82906
|
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
82922
82907
|
* @param {*} [options] Override http request option.
|
|
82923
82908
|
* @throws {RequiredError}
|
|
82924
82909
|
*/
|
|
82925
82910
|
getOrganizationLanguageOverrides(requestParameters = {}, options) {
|
|
82926
|
-
return OrganizationLanguageoverridesApiFp(this.configuration).getOrganizationLanguageOverrides(requestParameters.
|
|
82911
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).getOrganizationLanguageOverrides(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
82927
82912
|
}
|
|
82928
82913
|
/**
|
|
82929
|
-
* Upserts the organization\'s i18n string override for
|
|
82914
|
+
* Upserts the organization\'s i18n string override for a key across all supplied locale values in a single request, requires the update org permission, and refreshes the language overrides list on success.
|
|
82930
82915
|
* @summary Create or update a language override
|
|
82931
82916
|
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82932
82917
|
* @param {*} [options] Override http request option.
|
|
82933
82918
|
* @throws {RequiredError}
|
|
82934
82919
|
*/
|
|
82935
82920
|
upsertOrganizationLanguageOverride(requestParameters, options) {
|
|
82936
|
-
return OrganizationLanguageoverridesApiFp(this.configuration).upsertOrganizationLanguageOverride(requestParameters.
|
|
82921
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).upsertOrganizationLanguageOverride(requestParameters.organizationLanguageOverrideUpsertInputs, options).then((request) => request(this.axios, this.basePath));
|
|
82937
82922
|
}
|
|
82938
82923
|
}
|
|
82939
82924
|
/**
|
|
@@ -5,9 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**locale** | **string** | | [default to undefined]
|
|
9
8
|
**key** | **string** | | [default to undefined]
|
|
10
|
-
**
|
|
9
|
+
**values** | **{ [key: string]: any; }** | | [default to undefined]
|
|
11
10
|
**createdAt** | **string** | | [default to undefined]
|
|
12
11
|
**updatedAt** | **string** | | [default to undefined]
|
|
13
12
|
|
|
@@ -17,9 +16,8 @@ Name | Type | Description | Notes
|
|
|
17
16
|
import { OrganizationLanguageOverride } from '@connectedxm/admin-sdk';
|
|
18
17
|
|
|
19
18
|
const instance: OrganizationLanguageOverride = {
|
|
20
|
-
locale,
|
|
21
19
|
key,
|
|
22
|
-
|
|
20
|
+
values,
|
|
23
21
|
createdAt,
|
|
24
22
|
updatedAt,
|
|
25
23
|
};
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**key** | **string** | | [default to undefined]
|
|
9
|
-
**
|
|
9
|
+
**values** | **{ [key: string]: any; }** | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -15,7 +15,7 @@ import { OrganizationLanguageOverrideUpsertInputs } from '@connectedxm/admin-sdk
|
|
|
15
15
|
|
|
16
16
|
const instance: OrganizationLanguageOverrideUpsertInputs = {
|
|
17
17
|
key,
|
|
18
|
-
|
|
18
|
+
values,
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteOrganizationLanguageOverride**](#deleteorganizationlanguageoverride) | **DELETE** /organization/language-overrides
|
|
7
|
+
|[**deleteOrganizationLanguageOverride**](#deleteorganizationlanguageoverride) | **DELETE** /organization/language-overrides | Delete a language override|
|
|
8
8
|
|[**getOrganizationLanguageOverrides**](#getorganizationlanguageoverrides) | **GET** /organization/language-overrides | List an organization\'s language overrides|
|
|
9
|
-
|[**upsertOrganizationLanguageOverride**](#upsertorganizationlanguageoverride) | **PUT** /organization/language-overrides
|
|
9
|
+
|[**upsertOrganizationLanguageOverride**](#upsertorganizationlanguageoverride) | **PUT** /organization/language-overrides | Create or update a language override|
|
|
10
10
|
|
|
11
11
|
# **deleteOrganizationLanguageOverride**
|
|
12
12
|
> SyncAccounts200Response deleteOrganizationLanguageOverride()
|
|
13
13
|
|
|
14
|
-
Deletes the organization\'s i18n string override for the given
|
|
14
|
+
Deletes the organization\'s i18n string override for the given key across all locales (key sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -24,11 +24,9 @@ import {
|
|
|
24
24
|
const configuration = new Configuration();
|
|
25
25
|
const apiInstance = new OrganizationLanguageoverridesApi(configuration);
|
|
26
26
|
|
|
27
|
-
let locale: string; //The locale identifier (default to undefined)
|
|
28
27
|
let key: string; //Filter by key (default to undefined)
|
|
29
28
|
|
|
30
29
|
const { status, data } = await apiInstance.deleteOrganizationLanguageOverride(
|
|
31
|
-
locale,
|
|
32
30
|
key
|
|
33
31
|
);
|
|
34
32
|
```
|
|
@@ -37,7 +35,6 @@ const { status, data } = await apiInstance.deleteOrganizationLanguageOverride(
|
|
|
37
35
|
|
|
38
36
|
|Name | Type | Description | Notes|
|
|
39
37
|
|------------- | ------------- | ------------- | -------------|
|
|
40
|
-
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
41
38
|
| **key** | [**string**] | Filter by key | defaults to undefined|
|
|
42
39
|
|
|
43
40
|
|
|
@@ -65,7 +62,7 @@ const { status, data } = await apiInstance.deleteOrganizationLanguageOverride(
|
|
|
65
62
|
# **getOrganizationLanguageOverrides**
|
|
66
63
|
> GetOrganizationLanguageOverrides200Response getOrganizationLanguageOverrides()
|
|
67
64
|
|
|
68
|
-
Returns a paginated list of the organization\'s i18n string overrides,
|
|
65
|
+
Returns a paginated list of the organization\'s i18n string overrides grouped by key, each with its per-locale values; searchable by key. Requires org read permission.
|
|
69
66
|
|
|
70
67
|
### Example
|
|
71
68
|
|
|
@@ -78,14 +75,12 @@ import {
|
|
|
78
75
|
const configuration = new Configuration();
|
|
79
76
|
const apiInstance = new OrganizationLanguageoverridesApi(configuration);
|
|
80
77
|
|
|
81
|
-
let locale: string; //Filter by locale (optional) (default to undefined)
|
|
82
78
|
let page: number; //Page number (optional) (default to 1)
|
|
83
79
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
84
80
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
85
81
|
let search: string; //Search query (optional) (default to undefined)
|
|
86
82
|
|
|
87
83
|
const { status, data } = await apiInstance.getOrganizationLanguageOverrides(
|
|
88
|
-
locale,
|
|
89
84
|
page,
|
|
90
85
|
pageSize,
|
|
91
86
|
orderBy,
|
|
@@ -97,7 +92,6 @@ const { status, data } = await apiInstance.getOrganizationLanguageOverrides(
|
|
|
97
92
|
|
|
98
93
|
|Name | Type | Description | Notes|
|
|
99
94
|
|------------- | ------------- | ------------- | -------------|
|
|
100
|
-
| **locale** | [**string**] | Filter by locale | (optional) defaults to undefined|
|
|
101
95
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
102
96
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
103
97
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -128,7 +122,7 @@ const { status, data } = await apiInstance.getOrganizationLanguageOverrides(
|
|
|
128
122
|
# **upsertOrganizationLanguageOverride**
|
|
129
123
|
> SyncAccounts200Response upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs)
|
|
130
124
|
|
|
131
|
-
Upserts the organization\'s i18n string override for
|
|
125
|
+
Upserts the organization\'s i18n string override for a key across all supplied locale values in a single request, requires the update org permission, and refreshes the language overrides list on success.
|
|
132
126
|
|
|
133
127
|
### Example
|
|
134
128
|
|
|
@@ -142,11 +136,9 @@ import {
|
|
|
142
136
|
const configuration = new Configuration();
|
|
143
137
|
const apiInstance = new OrganizationLanguageoverridesApi(configuration);
|
|
144
138
|
|
|
145
|
-
let locale: string; //The locale identifier (default to undefined)
|
|
146
139
|
let organizationLanguageOverrideUpsertInputs: OrganizationLanguageOverrideUpsertInputs; //
|
|
147
140
|
|
|
148
141
|
const { status, data } = await apiInstance.upsertOrganizationLanguageOverride(
|
|
149
|
-
locale,
|
|
150
142
|
organizationLanguageOverrideUpsertInputs
|
|
151
143
|
);
|
|
152
144
|
```
|
|
@@ -156,7 +148,6 @@ const { status, data } = await apiInstance.upsertOrganizationLanguageOverride(
|
|
|
156
148
|
|Name | Type | Description | Notes|
|
|
157
149
|
|------------- | ------------- | ------------- | -------------|
|
|
158
150
|
| **organizationLanguageOverrideUpsertInputs** | **OrganizationLanguageOverrideUpsertInputs**| | |
|
|
159
|
-
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
160
151
|
|
|
161
152
|
|
|
162
153
|
### Return type
|