@connectedxm/admin-sdk 7.10.0 → 7.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +37 -68
- package/dist/api.d.ts +30 -44
- package/dist/api.js +34 -48
- package/dist/esm/api.d.ts +30 -44
- package/dist/esm/api.js +34 -48
- package/docs/EventEmailType.md +2 -0
- package/docs/EventsEmailsApi.md +1 -1
- 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
|
@@ -613,6 +613,7 @@ export var EventEmailType;
|
|
|
613
613
|
EventEmailType["Reminder"] = "reminder";
|
|
614
614
|
EventEmailType["Approval"] = "approval";
|
|
615
615
|
EventEmailType["Denial"] = "denial";
|
|
616
|
+
EventEmailType["Transfer"] = "transfer";
|
|
616
617
|
})(EventEmailType || (EventEmailType = {}));
|
|
617
618
|
export var EventReportDateType;
|
|
618
619
|
(function (EventReportDateType) {
|
|
@@ -31138,7 +31139,7 @@ export class EventsCouponsApi extends BaseAPI {
|
|
|
31138
31139
|
export const EventsEmailsApiAxiosParamCreator = function (configuration) {
|
|
31139
31140
|
return {
|
|
31140
31141
|
/**
|
|
31141
|
-
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, or
|
|
31142
|
+
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, denial, or transfer; requires read permission on events.
|
|
31142
31143
|
* @summary Get an event\'s email configuration
|
|
31143
31144
|
* @param {string} eventId The event identifier
|
|
31144
31145
|
* @param {string} type The type identifier
|
|
@@ -31227,7 +31228,7 @@ export const EventsEmailsApiFp = function (configuration) {
|
|
|
31227
31228
|
const localVarAxiosParamCreator = EventsEmailsApiAxiosParamCreator(configuration);
|
|
31228
31229
|
return {
|
|
31229
31230
|
/**
|
|
31230
|
-
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, or
|
|
31231
|
+
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, denial, or transfer; requires read permission on events.
|
|
31231
31232
|
* @summary Get an event\'s email configuration
|
|
31232
31233
|
* @param {string} eventId The event identifier
|
|
31233
31234
|
* @param {string} type The type identifier
|
|
@@ -31270,7 +31271,7 @@ export const EventsEmailsApiFactory = function (configuration, basePath, axios)
|
|
|
31270
31271
|
const localVarFp = EventsEmailsApiFp(configuration);
|
|
31271
31272
|
return {
|
|
31272
31273
|
/**
|
|
31273
|
-
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, or
|
|
31274
|
+
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, denial, or transfer; requires read permission on events.
|
|
31274
31275
|
* @summary Get an event\'s email configuration
|
|
31275
31276
|
* @param {EventsEmailsApiGetEventEmailRequest} requestParameters Request parameters.
|
|
31276
31277
|
* @param {*} [options] Override http request option.
|
|
@@ -31296,7 +31297,7 @@ export const EventsEmailsApiFactory = function (configuration, basePath, axios)
|
|
|
31296
31297
|
*/
|
|
31297
31298
|
export class EventsEmailsApi extends BaseAPI {
|
|
31298
31299
|
/**
|
|
31299
|
-
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, or
|
|
31300
|
+
* Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, denial, or transfer; requires read permission on events.
|
|
31300
31301
|
* @summary Get an event\'s email configuration
|
|
31301
31302
|
* @param {EventsEmailsApiGetEventEmailRequest} requestParameters Request parameters.
|
|
31302
31303
|
* @param {*} [options] Override http request option.
|
|
@@ -82671,20 +82672,16 @@ export class OrganizationIntegrationsApi extends BaseAPI {
|
|
|
82671
82672
|
export const OrganizationLanguageoverridesApiAxiosParamCreator = function (configuration) {
|
|
82672
82673
|
return {
|
|
82673
82674
|
/**
|
|
82674
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82675
|
+
* 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
82676
|
* @summary Delete a language override
|
|
82676
|
-
* @param {string} locale The locale identifier
|
|
82677
82677
|
* @param {string} key Filter by key
|
|
82678
82678
|
* @param {*} [options] Override http request option.
|
|
82679
82679
|
* @throws {RequiredError}
|
|
82680
82680
|
*/
|
|
82681
|
-
deleteOrganizationLanguageOverride: (
|
|
82682
|
-
// verify required parameter 'locale' is not null or undefined
|
|
82683
|
-
assertParamExists('deleteOrganizationLanguageOverride', 'locale', locale);
|
|
82681
|
+
deleteOrganizationLanguageOverride: (key_1, ...args_1) => __awaiter(this, [key_1, ...args_1], void 0, function* (key, options = {}) {
|
|
82684
82682
|
// verify required parameter 'key' is not null or undefined
|
|
82685
82683
|
assertParamExists('deleteOrganizationLanguageOverride', 'key', key);
|
|
82686
|
-
const localVarPath = `/organization/language-overrides
|
|
82687
|
-
.replace(`{${"locale"}}`, encodeURIComponent(String(locale)));
|
|
82684
|
+
const localVarPath = `/organization/language-overrides`;
|
|
82688
82685
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82689
82686
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82690
82687
|
let baseOptions;
|
|
@@ -82711,9 +82708,8 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82711
82708
|
};
|
|
82712
82709
|
}),
|
|
82713
82710
|
/**
|
|
82714
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82711
|
+
* 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
82712
|
* @summary List an organization\'s language overrides
|
|
82716
|
-
* @param {string} [locale] Filter by locale
|
|
82717
82713
|
* @param {number} [page] Page number
|
|
82718
82714
|
* @param {number} [pageSize] Number of items per page
|
|
82719
82715
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82721,7 +82717,7 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82721
82717
|
* @param {*} [options] Override http request option.
|
|
82722
82718
|
* @throws {RequiredError}
|
|
82723
82719
|
*/
|
|
82724
|
-
getOrganizationLanguageOverrides: (
|
|
82720
|
+
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
82721
|
const localVarPath = `/organization/language-overrides`;
|
|
82726
82722
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82727
82723
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -82736,9 +82732,6 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82736
82732
|
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
82737
82733
|
// authentication OrganizationId required
|
|
82738
82734
|
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
82739
|
-
if (locale !== undefined) {
|
|
82740
|
-
localVarQueryParameter['locale'] = locale;
|
|
82741
|
-
}
|
|
82742
82735
|
if (page !== undefined) {
|
|
82743
82736
|
localVarQueryParameter['page'] = page;
|
|
82744
82737
|
}
|
|
@@ -82761,20 +82754,16 @@ export const OrganizationLanguageoverridesApiAxiosParamCreator = function (confi
|
|
|
82761
82754
|
};
|
|
82762
82755
|
}),
|
|
82763
82756
|
/**
|
|
82764
|
-
* Upserts the organization\'s i18n string override for
|
|
82757
|
+
* 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
82758
|
* @summary Create or update a language override
|
|
82766
|
-
* @param {string} locale The locale identifier
|
|
82767
82759
|
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
82768
82760
|
* @param {*} [options] Override http request option.
|
|
82769
82761
|
* @throws {RequiredError}
|
|
82770
82762
|
*/
|
|
82771
|
-
upsertOrganizationLanguageOverride: (
|
|
82772
|
-
// verify required parameter 'locale' is not null or undefined
|
|
82773
|
-
assertParamExists('upsertOrganizationLanguageOverride', 'locale', locale);
|
|
82763
|
+
upsertOrganizationLanguageOverride: (organizationLanguageOverrideUpsertInputs_1, ...args_1) => __awaiter(this, [organizationLanguageOverrideUpsertInputs_1, ...args_1], void 0, function* (organizationLanguageOverrideUpsertInputs, options = {}) {
|
|
82774
82764
|
// verify required parameter 'organizationLanguageOverrideUpsertInputs' is not null or undefined
|
|
82775
82765
|
assertParamExists('upsertOrganizationLanguageOverride', 'organizationLanguageOverrideUpsertInputs', organizationLanguageOverrideUpsertInputs);
|
|
82776
|
-
const localVarPath = `/organization/language-overrides
|
|
82777
|
-
.replace(`{${"locale"}}`, encodeURIComponent(String(locale)));
|
|
82766
|
+
const localVarPath = `/organization/language-overrides`;
|
|
82778
82767
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82779
82768
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
82780
82769
|
let baseOptions;
|
|
@@ -82808,26 +82797,24 @@ export const OrganizationLanguageoverridesApiFp = function (configuration) {
|
|
|
82808
82797
|
const localVarAxiosParamCreator = OrganizationLanguageoverridesApiAxiosParamCreator(configuration);
|
|
82809
82798
|
return {
|
|
82810
82799
|
/**
|
|
82811
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82800
|
+
* 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
82801
|
* @summary Delete a language override
|
|
82813
|
-
* @param {string} locale The locale identifier
|
|
82814
82802
|
* @param {string} key Filter by key
|
|
82815
82803
|
* @param {*} [options] Override http request option.
|
|
82816
82804
|
* @throws {RequiredError}
|
|
82817
82805
|
*/
|
|
82818
|
-
deleteOrganizationLanguageOverride(
|
|
82806
|
+
deleteOrganizationLanguageOverride(key, options) {
|
|
82819
82807
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82820
82808
|
var _a, _b, _c;
|
|
82821
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationLanguageOverride(
|
|
82809
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationLanguageOverride(key, options);
|
|
82822
82810
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82823
82811
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.deleteOrganizationLanguageOverride']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82824
82812
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82825
82813
|
});
|
|
82826
82814
|
},
|
|
82827
82815
|
/**
|
|
82828
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82816
|
+
* 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
82817
|
* @summary List an organization\'s language overrides
|
|
82830
|
-
* @param {string} [locale] Filter by locale
|
|
82831
82818
|
* @param {number} [page] Page number
|
|
82832
82819
|
* @param {number} [pageSize] Number of items per page
|
|
82833
82820
|
* @param {string} [orderBy] Field to order by
|
|
@@ -82835,27 +82822,26 @@ export const OrganizationLanguageoverridesApiFp = function (configuration) {
|
|
|
82835
82822
|
* @param {*} [options] Override http request option.
|
|
82836
82823
|
* @throws {RequiredError}
|
|
82837
82824
|
*/
|
|
82838
|
-
getOrganizationLanguageOverrides(
|
|
82825
|
+
getOrganizationLanguageOverrides(page, pageSize, orderBy, search, options) {
|
|
82839
82826
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82840
82827
|
var _a, _b, _c;
|
|
82841
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationLanguageOverrides(
|
|
82828
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationLanguageOverrides(page, pageSize, orderBy, search, options);
|
|
82842
82829
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82843
82830
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.getOrganizationLanguageOverrides']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82844
82831
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
82845
82832
|
});
|
|
82846
82833
|
},
|
|
82847
82834
|
/**
|
|
82848
|
-
* Upserts the organization\'s i18n string override for
|
|
82835
|
+
* 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
82836
|
* @summary Create or update a language override
|
|
82850
|
-
* @param {string} locale The locale identifier
|
|
82851
82837
|
* @param {OrganizationLanguageOverrideUpsertInputs} organizationLanguageOverrideUpsertInputs
|
|
82852
82838
|
* @param {*} [options] Override http request option.
|
|
82853
82839
|
* @throws {RequiredError}
|
|
82854
82840
|
*/
|
|
82855
|
-
upsertOrganizationLanguageOverride(
|
|
82841
|
+
upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs, options) {
|
|
82856
82842
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82857
82843
|
var _a, _b, _c;
|
|
82858
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.upsertOrganizationLanguageOverride(
|
|
82844
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs, options);
|
|
82859
82845
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
82860
82846
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationLanguageoverridesApi.upsertOrganizationLanguageOverride']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
82861
82847
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -82870,34 +82856,34 @@ export const OrganizationLanguageoverridesApiFactory = function (configuration,
|
|
|
82870
82856
|
const localVarFp = OrganizationLanguageoverridesApiFp(configuration);
|
|
82871
82857
|
return {
|
|
82872
82858
|
/**
|
|
82873
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82859
|
+
* 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
82860
|
* @summary Delete a language override
|
|
82875
82861
|
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82876
82862
|
* @param {*} [options] Override http request option.
|
|
82877
82863
|
* @throws {RequiredError}
|
|
82878
82864
|
*/
|
|
82879
82865
|
deleteOrganizationLanguageOverride(requestParameters, options) {
|
|
82880
|
-
return localVarFp.deleteOrganizationLanguageOverride(requestParameters.
|
|
82866
|
+
return localVarFp.deleteOrganizationLanguageOverride(requestParameters.key, options).then((request) => request(axios, basePath));
|
|
82881
82867
|
},
|
|
82882
82868
|
/**
|
|
82883
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82869
|
+
* 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
82870
|
* @summary List an organization\'s language overrides
|
|
82885
82871
|
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
82886
82872
|
* @param {*} [options] Override http request option.
|
|
82887
82873
|
* @throws {RequiredError}
|
|
82888
82874
|
*/
|
|
82889
82875
|
getOrganizationLanguageOverrides(requestParameters = {}, options) {
|
|
82890
|
-
return localVarFp.getOrganizationLanguageOverrides(requestParameters.
|
|
82876
|
+
return localVarFp.getOrganizationLanguageOverrides(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
82891
82877
|
},
|
|
82892
82878
|
/**
|
|
82893
|
-
* Upserts the organization\'s i18n string override for
|
|
82879
|
+
* 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
82880
|
* @summary Create or update a language override
|
|
82895
82881
|
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82896
82882
|
* @param {*} [options] Override http request option.
|
|
82897
82883
|
* @throws {RequiredError}
|
|
82898
82884
|
*/
|
|
82899
82885
|
upsertOrganizationLanguageOverride(requestParameters, options) {
|
|
82900
|
-
return localVarFp.upsertOrganizationLanguageOverride(requestParameters.
|
|
82886
|
+
return localVarFp.upsertOrganizationLanguageOverride(requestParameters.organizationLanguageOverrideUpsertInputs, options).then((request) => request(axios, basePath));
|
|
82901
82887
|
},
|
|
82902
82888
|
};
|
|
82903
82889
|
};
|
|
@@ -82906,34 +82892,34 @@ export const OrganizationLanguageoverridesApiFactory = function (configuration,
|
|
|
82906
82892
|
*/
|
|
82907
82893
|
export class OrganizationLanguageoverridesApi extends BaseAPI {
|
|
82908
82894
|
/**
|
|
82909
|
-
* Deletes the organization\'s i18n string override for the given
|
|
82895
|
+
* 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
82896
|
* @summary Delete a language override
|
|
82911
82897
|
* @param {OrganizationLanguageoverridesApiDeleteOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82912
82898
|
* @param {*} [options] Override http request option.
|
|
82913
82899
|
* @throws {RequiredError}
|
|
82914
82900
|
*/
|
|
82915
82901
|
deleteOrganizationLanguageOverride(requestParameters, options) {
|
|
82916
|
-
return OrganizationLanguageoverridesApiFp(this.configuration).deleteOrganizationLanguageOverride(requestParameters.
|
|
82902
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).deleteOrganizationLanguageOverride(requestParameters.key, options).then((request) => request(this.axios, this.basePath));
|
|
82917
82903
|
}
|
|
82918
82904
|
/**
|
|
82919
|
-
* Returns a paginated list of the organization\'s i18n string overrides,
|
|
82905
|
+
* 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
82906
|
* @summary List an organization\'s language overrides
|
|
82921
82907
|
* @param {OrganizationLanguageoverridesApiGetOrganizationLanguageOverridesRequest} requestParameters Request parameters.
|
|
82922
82908
|
* @param {*} [options] Override http request option.
|
|
82923
82909
|
* @throws {RequiredError}
|
|
82924
82910
|
*/
|
|
82925
82911
|
getOrganizationLanguageOverrides(requestParameters = {}, options) {
|
|
82926
|
-
return OrganizationLanguageoverridesApiFp(this.configuration).getOrganizationLanguageOverrides(requestParameters.
|
|
82912
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).getOrganizationLanguageOverrides(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
82927
82913
|
}
|
|
82928
82914
|
/**
|
|
82929
|
-
* Upserts the organization\'s i18n string override for
|
|
82915
|
+
* 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
82916
|
* @summary Create or update a language override
|
|
82931
82917
|
* @param {OrganizationLanguageoverridesApiUpsertOrganizationLanguageOverrideRequest} requestParameters Request parameters.
|
|
82932
82918
|
* @param {*} [options] Override http request option.
|
|
82933
82919
|
* @throws {RequiredError}
|
|
82934
82920
|
*/
|
|
82935
82921
|
upsertOrganizationLanguageOverride(requestParameters, options) {
|
|
82936
|
-
return OrganizationLanguageoverridesApiFp(this.configuration).upsertOrganizationLanguageOverride(requestParameters.
|
|
82922
|
+
return OrganizationLanguageoverridesApiFp(this.configuration).upsertOrganizationLanguageOverride(requestParameters.organizationLanguageOverrideUpsertInputs, options).then((request) => request(this.axios, this.basePath));
|
|
82937
82923
|
}
|
|
82938
82924
|
}
|
|
82939
82925
|
/**
|
package/docs/EventEmailType.md
CHANGED
package/docs/EventsEmailsApi.md
CHANGED
|
@@ -10,7 +10,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
10
10
|
# **getEventEmail**
|
|
11
11
|
> GetEventEmail200Response getEventEmail()
|
|
12
12
|
|
|
13
|
-
Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, or
|
|
13
|
+
Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, denial, or transfer; requires read permission on events.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -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
|