@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/dist/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
  */