@lumoauth/api-client 1.2.0 → 1.3.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.
Files changed (64) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +10 -4
  3. package/api/admin-email-api.ts +67 -15
  4. package/api/admin-oauth-clients-api.ts +370 -0
  5. package/api/oauth-api.ts +0 -186
  6. package/dist/api/admin-email-api.d.ts +41 -9
  7. package/dist/api/admin-email-api.js +34 -14
  8. package/dist/api/admin-oauth-clients-api.d.ts +210 -0
  9. package/dist/api/admin-oauth-clients-api.js +236 -0
  10. package/dist/api/oauth-api.d.ts +0 -110
  11. package/dist/api/oauth-api.js +0 -132
  12. package/dist/esm/api/admin-email-api.d.ts +41 -9
  13. package/dist/esm/api/admin-email-api.js +34 -14
  14. package/dist/esm/api/admin-oauth-clients-api.d.ts +210 -0
  15. package/dist/esm/api/admin-oauth-clients-api.js +236 -0
  16. package/dist/esm/api/oauth-api.d.ts +0 -110
  17. package/dist/esm/api/oauth-api.js +0 -132
  18. package/dist/esm/models/admin-clients-get-branding-response-data.d.ts +34 -0
  19. package/dist/esm/models/admin-clients-get-branding-response-data.js +14 -0
  20. package/dist/esm/models/admin-clients-get-branding-response.d.ts +25 -0
  21. package/dist/esm/models/admin-clients-get-branding-response.js +14 -0
  22. package/dist/esm/models/authorization-server-metadata.d.ts +0 -6
  23. package/dist/esm/models/index.d.ts +5 -0
  24. package/dist/esm/models/index.js +5 -0
  25. package/dist/esm/models/open-id-configuration.d.ts +6 -6
  26. package/dist/esm/models/patch-admin-clients-update-branding-response.d.ts +32 -0
  27. package/dist/esm/models/patch-admin-clients-update-branding-response.js +14 -0
  28. package/dist/esm/models/put-admin-clients-update-branding-request.d.ts +34 -0
  29. package/dist/esm/models/put-admin-clients-update-branding-request.js +14 -0
  30. package/dist/esm/models/put-admin-clients-update-branding-response.d.ts +32 -0
  31. package/dist/esm/models/put-admin-clients-update-branding-response.js +14 -0
  32. package/dist/models/admin-clients-get-branding-response-data.d.ts +34 -0
  33. package/dist/models/admin-clients-get-branding-response-data.js +15 -0
  34. package/dist/models/admin-clients-get-branding-response.d.ts +25 -0
  35. package/dist/models/admin-clients-get-branding-response.js +15 -0
  36. package/dist/models/authorization-server-metadata.d.ts +0 -6
  37. package/dist/models/index.d.ts +5 -0
  38. package/dist/models/index.js +5 -0
  39. package/dist/models/open-id-configuration.d.ts +6 -6
  40. package/dist/models/patch-admin-clients-update-branding-response.d.ts +32 -0
  41. package/dist/models/patch-admin-clients-update-branding-response.js +15 -0
  42. package/dist/models/put-admin-clients-update-branding-request.d.ts +34 -0
  43. package/dist/models/put-admin-clients-update-branding-request.js +15 -0
  44. package/dist/models/put-admin-clients-update-branding-response.d.ts +32 -0
  45. package/dist/models/put-admin-clients-update-branding-response.js +15 -0
  46. package/docs/AdminClientsGetBrandingResponse.md +20 -0
  47. package/docs/AdminClientsGetBrandingResponseData.md +22 -0
  48. package/docs/AdminEmailApi.md +15 -2
  49. package/docs/AdminOAuthClientsApi.md +174 -0
  50. package/docs/AuthorizationServerMetadata.md +0 -2
  51. package/docs/OAuthApi.md +0 -105
  52. package/docs/OpenIdConfiguration.md +2 -2
  53. package/docs/PatchAdminClientsUpdateBrandingResponse.md +22 -0
  54. package/docs/PutAdminClientsUpdateBrandingRequest.md +22 -0
  55. package/docs/PutAdminClientsUpdateBrandingResponse.md +22 -0
  56. package/models/admin-clients-get-branding-response-data.ts +36 -0
  57. package/models/admin-clients-get-branding-response.ts +33 -0
  58. package/models/authorization-server-metadata.ts +0 -6
  59. package/models/index.ts +5 -0
  60. package/models/open-id-configuration.ts +6 -6
  61. package/models/patch-admin-clients-update-branding-response.ts +36 -0
  62. package/models/put-admin-clients-update-branding-request.ts +36 -0
  63. package/models/put-admin-clients-update-branding-response.ts +36 -0
  64. package/package.json +1 -1
package/api/oauth-api.ts CHANGED
@@ -333,40 +333,6 @@ export const OAuthApiAxiosParamCreator = function (configuration?: Configuration
333
333
 
334
334
 
335
335
 
336
- setSearchParams(localVarUrlObj, localVarQueryParameter);
337
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
338
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
339
-
340
- return {
341
- url: toPathString(localVarUrlObj),
342
- options: localVarRequestOptions,
343
- };
344
- },
345
- /**
346
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
347
- * @summary Passkey login entry point
348
- * @param {string} orgId
349
- * @param {*} [options] Override http request option.
350
- * @throws {RequiredError}
351
- */
352
- passkeyLogin: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
353
- // verify required parameter 'orgId' is not null or undefined
354
- assertParamExists('passkeyLogin', 'orgId', orgId)
355
- const localVarPath = `/orgs/{orgId}/api/v1/oauth/passkey-login`
356
- .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
357
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
358
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
359
- let baseOptions;
360
- if (configuration) {
361
- baseOptions = configuration.baseOptions;
362
- }
363
-
364
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
365
- const localVarHeaderParameter = {} as any;
366
- const localVarQueryParameter = {} as any;
367
-
368
-
369
-
370
336
  setSearchParams(localVarUrlObj, localVarQueryParameter);
371
337
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
372
338
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -628,40 +594,6 @@ export const OAuthApiAxiosParamCreator = function (configuration?: Configuration
628
594
 
629
595
 
630
596
 
631
- setSearchParams(localVarUrlObj, localVarQueryParameter);
632
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
633
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
634
-
635
- return {
636
- url: toPathString(localVarUrlObj),
637
- options: localVarRequestOptions,
638
- };
639
- },
640
- /**
641
- * Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
642
- * @summary Hosted login form submission
643
- * @param {string} orgId
644
- * @param {*} [options] Override http request option.
645
- * @throws {RequiredError}
646
- */
647
- submitLogin: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
648
- // verify required parameter 'orgId' is not null or undefined
649
- assertParamExists('submitLogin', 'orgId', orgId)
650
- const localVarPath = `/orgs/{orgId}/api/v1/oauth/login/submit`
651
- .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
652
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
653
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
654
- let baseOptions;
655
- if (configuration) {
656
- baseOptions = configuration.baseOptions;
657
- }
658
-
659
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
660
- const localVarHeaderParameter = {} as any;
661
- const localVarQueryParameter = {} as any;
662
-
663
-
664
-
665
597
  setSearchParams(localVarUrlObj, localVarQueryParameter);
666
598
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
667
599
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -892,19 +824,6 @@ export const OAuthApiFp = function(configuration?: Configuration) {
892
824
  const localVarOperationServerBasePath = operationServerMap['OAuthApi.par']?.[localVarOperationServerIndex]?.url;
893
825
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
894
826
  },
895
- /**
896
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
897
- * @summary Passkey login entry point
898
- * @param {string} orgId
899
- * @param {*} [options] Override http request option.
900
- * @throws {RequiredError}
901
- */
902
- async passkeyLogin(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
903
- const localVarAxiosArgs = await localVarAxiosParamCreator.passkeyLogin(orgId, options);
904
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
905
- const localVarOperationServerBasePath = operationServerMap['OAuthApi.passkeyLogin']?.[localVarOperationServerIndex]?.url;
906
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
907
- },
908
827
  /**
909
828
  * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
910
829
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -999,19 +918,6 @@ export const OAuthApiFp = function(configuration?: Configuration) {
999
918
  const localVarOperationServerBasePath = operationServerMap['OAuthApi.submitDeviceVerification']?.[localVarOperationServerIndex]?.url;
1000
919
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1001
920
  },
1002
- /**
1003
- * Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
1004
- * @summary Hosted login form submission
1005
- * @param {string} orgId
1006
- * @param {*} [options] Override http request option.
1007
- * @throws {RequiredError}
1008
- */
1009
- async submitLogin(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1010
- const localVarAxiosArgs = await localVarAxiosParamCreator.submitLogin(orgId, options);
1011
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1012
- const localVarOperationServerBasePath = operationServerMap['OAuthApi.submitLogin']?.[localVarOperationServerIndex]?.url;
1013
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1014
- },
1015
921
  /**
1016
922
  * Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
1017
923
  * @summary Programmatic (JSON) login for the authorization flow
@@ -1141,16 +1047,6 @@ export const OAuthApiFactory = function (configuration?: Configuration, basePath
1141
1047
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse> {
1142
1048
  return localVarFp.par(requestParameters.orgId, options).then((request) => request(axios, basePath));
1143
1049
  },
1144
- /**
1145
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
1146
- * @summary Passkey login entry point
1147
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
1148
- * @param {*} [options] Override http request option.
1149
- * @throws {RequiredError}
1150
- */
1151
- passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1152
- return localVarFp.passkeyLogin(requestParameters.orgId, options).then((request) => request(axios, basePath));
1153
- },
1154
1050
  /**
1155
1051
  * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
1156
1052
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -1221,16 +1117,6 @@ export const OAuthApiFactory = function (configuration?: Configuration, basePath
1221
1117
  submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<string> {
1222
1118
  return localVarFp.submitDeviceVerification(requestParameters.orgId, options).then((request) => request(axios, basePath));
1223
1119
  },
1224
- /**
1225
- * Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
1226
- * @summary Hosted login form submission
1227
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
1228
- * @param {*} [options] Override http request option.
1229
- * @throws {RequiredError}
1230
- */
1231
- submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1232
- return localVarFp.submitLogin(requestParameters.orgId, options).then((request) => request(axios, basePath));
1233
- },
1234
1120
  /**
1235
1121
  * Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
1236
1122
  * @summary Programmatic (JSON) login for the authorization flow
@@ -1350,16 +1236,6 @@ export interface OAuthApiInterface {
1350
1236
  */
1351
1237
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
1352
1238
 
1353
- /**
1354
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
1355
- * @summary Passkey login entry point
1356
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
1357
- * @param {*} [options] Override http request option.
1358
- * @throws {RequiredError}
1359
- * @memberof OAuthApiInterface
1360
- */
1361
- passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1362
-
1363
1239
  /**
1364
1240
  * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
1365
1241
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -1430,16 +1306,6 @@ export interface OAuthApiInterface {
1430
1306
  */
1431
1307
  submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
1432
1308
 
1433
- /**
1434
- * Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
1435
- * @summary Hosted login form submission
1436
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
1437
- * @param {*} [options] Override http request option.
1438
- * @throws {RequiredError}
1439
- * @memberof OAuthApiInterface
1440
- */
1441
- submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1442
-
1443
1309
  /**
1444
1310
  * Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
1445
1311
  * @summary Programmatic (JSON) login for the authorization flow
@@ -1591,20 +1457,6 @@ export interface OAuthApiParRequest {
1591
1457
  readonly orgId: string
1592
1458
  }
1593
1459
 
1594
- /**
1595
- * Request parameters for passkeyLogin operation in OAuthApi.
1596
- * @export
1597
- * @interface OAuthApiPasskeyLoginRequest
1598
- */
1599
- export interface OAuthApiPasskeyLoginRequest {
1600
- /**
1601
- *
1602
- * @type {string}
1603
- * @memberof OAuthApiPasskeyLogin
1604
- */
1605
- readonly orgId: string
1606
- }
1607
-
1608
1460
  /**
1609
1461
  * Request parameters for registerClient operation in OAuthApi.
1610
1462
  * @export
@@ -1724,20 +1576,6 @@ export interface OAuthApiSubmitDeviceVerificationRequest {
1724
1576
  readonly orgId: string
1725
1577
  }
1726
1578
 
1727
- /**
1728
- * Request parameters for submitLogin operation in OAuthApi.
1729
- * @export
1730
- * @interface OAuthApiSubmitLoginRequest
1731
- */
1732
- export interface OAuthApiSubmitLoginRequest {
1733
- /**
1734
- *
1735
- * @type {string}
1736
- * @memberof OAuthApiSubmitLogin
1737
- */
1738
- readonly orgId: string
1739
- }
1740
-
1741
1579
  /**
1742
1580
  * Request parameters for submitLoginJson operation in OAuthApi.
1743
1581
  * @export
@@ -1883,18 +1721,6 @@ export class OAuthApi extends BaseAPI implements OAuthApiInterface {
1883
1721
  return OAuthApiFp(this.configuration).par(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1884
1722
  }
1885
1723
 
1886
- /**
1887
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
1888
- * @summary Passkey login entry point
1889
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
1890
- * @param {*} [options] Override http request option.
1891
- * @throws {RequiredError}
1892
- * @memberof OAuthApi
1893
- */
1894
- public passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig) {
1895
- return OAuthApiFp(this.configuration).passkeyLogin(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1896
- }
1897
-
1898
1724
  /**
1899
1725
  * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
1900
1726
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -1979,18 +1805,6 @@ export class OAuthApi extends BaseAPI implements OAuthApiInterface {
1979
1805
  return OAuthApiFp(this.configuration).submitDeviceVerification(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1980
1806
  }
1981
1807
 
1982
- /**
1983
- * Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
1984
- * @summary Hosted login form submission
1985
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
1986
- * @param {*} [options] Override http request option.
1987
- * @throws {RequiredError}
1988
- * @memberof OAuthApi
1989
- */
1990
- public submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig) {
1991
- return OAuthApiFp(this.configuration).submitLogin(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1992
- }
1993
-
1994
1808
  /**
1995
1809
  * Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
1996
1810
  * @summary Programmatic (JSON) login for the authorization flow
@@ -27,19 +27,23 @@ export declare const AdminEmailApiAxiosParamCreator: (configuration?: Configurat
27
27
  * @summary Remove the custom email template so the built-in default is used
28
28
  * @param {string} orgId
29
29
  * @param {string} type
30
+ * @param {string} [locale]
31
+ * @param {string} [clientId]
30
32
  * @param {*} [options] Override http request option.
31
33
  * @throws {RequiredError}
32
34
  */
33
- adminEmailTemplatesDelete: (orgId: string, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
35
+ adminEmailTemplatesDelete: (orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
34
36
  /**
35
37
  *
36
38
  * @summary Get an email template (custom or built-in default)
37
39
  * @param {string} orgId
38
40
  * @param {string} type
41
+ * @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
42
+ * @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
39
43
  * @param {*} [options] Override http request option.
40
44
  * @throws {RequiredError}
41
45
  */
42
- adminEmailTemplatesGet: (orgId: string, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
+ adminEmailTemplatesGet: (orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
43
47
  /**
44
48
  *
45
49
  * @summary List every email template type with its current (custom or built-in) template
@@ -58,7 +62,7 @@ export declare const AdminEmailApiAxiosParamCreator: (configuration?: Configurat
58
62
  */
59
63
  adminEmailTemplatesPreview: (orgId: string, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60
64
  /**
61
- *
65
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
62
66
  * @summary Create or replace the custom email template for a type
63
67
  * @param {string} orgId
64
68
  * @param {string} type
@@ -86,19 +90,23 @@ export declare const AdminEmailApiFp: (configuration?: Configuration) => {
86
90
  * @summary Remove the custom email template so the built-in default is used
87
91
  * @param {string} orgId
88
92
  * @param {string} type
93
+ * @param {string} [locale]
94
+ * @param {string} [clientId]
89
95
  * @param {*} [options] Override http request option.
90
96
  * @throws {RequiredError}
91
97
  */
92
- adminEmailTemplatesDelete(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
98
+ adminEmailTemplatesDelete(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
93
99
  /**
94
100
  *
95
101
  * @summary Get an email template (custom or built-in default)
96
102
  * @param {string} orgId
97
103
  * @param {string} type
104
+ * @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
105
+ * @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
98
106
  * @param {*} [options] Override http request option.
99
107
  * @throws {RequiredError}
100
108
  */
101
- adminEmailTemplatesGet(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>>;
109
+ adminEmailTemplatesGet(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>>;
102
110
  /**
103
111
  *
104
112
  * @summary List every email template type with its current (custom or built-in) template
@@ -117,7 +125,7 @@ export declare const AdminEmailApiFp: (configuration?: Configuration) => {
117
125
  */
118
126
  adminEmailTemplatesPreview(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminEmailTemplatesPreviewResponse>>;
119
127
  /**
120
- *
128
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
121
129
  * @summary Create or replace the custom email template for a type
122
130
  * @param {string} orgId
123
131
  * @param {string} type
@@ -173,7 +181,7 @@ export declare const AdminEmailApiFactory: (configuration?: Configuration, baseP
173
181
  */
174
182
  adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminEmailTemplatesPreviewResponse>;
175
183
  /**
176
- *
184
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
177
185
  * @summary Create or replace the custom email template for a type
178
186
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
179
187
  * @param {*} [options] Override http request option.
@@ -232,7 +240,7 @@ export interface AdminEmailApiInterface {
232
240
  */
233
241
  adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminEmailTemplatesPreviewResponse>;
234
242
  /**
235
- *
243
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
236
244
  * @summary Create or replace the custom email template for a type
237
245
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
238
246
  * @param {*} [options] Override http request option.
@@ -268,6 +276,18 @@ export interface AdminEmailApiAdminEmailTemplatesDeleteRequest {
268
276
  * @memberof AdminEmailApiAdminEmailTemplatesDelete
269
277
  */
270
278
  readonly type: string;
279
+ /**
280
+ *
281
+ * @type {string}
282
+ * @memberof AdminEmailApiAdminEmailTemplatesDelete
283
+ */
284
+ readonly locale?: string;
285
+ /**
286
+ *
287
+ * @type {string}
288
+ * @memberof AdminEmailApiAdminEmailTemplatesDelete
289
+ */
290
+ readonly clientId?: string;
271
291
  }
272
292
  /**
273
293
  * Request parameters for adminEmailTemplatesGet operation in AdminEmailApi.
@@ -287,6 +307,18 @@ export interface AdminEmailApiAdminEmailTemplatesGetRequest {
287
307
  * @memberof AdminEmailApiAdminEmailTemplatesGet
288
308
  */
289
309
  readonly type: string;
310
+ /**
311
+ * Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
312
+ * @type {string}
313
+ * @memberof AdminEmailApiAdminEmailTemplatesGet
314
+ */
315
+ readonly locale?: string;
316
+ /**
317
+ * Application variant (OAuth client_id); omit for the variant used by every application
318
+ * @type {string}
319
+ * @memberof AdminEmailApiAdminEmailTemplatesGet
320
+ */
321
+ readonly clientId?: string;
290
322
  }
291
323
  /**
292
324
  * Request parameters for adminEmailTemplatesList operation in AdminEmailApi.
@@ -402,7 +434,7 @@ export declare class AdminEmailApi extends BaseAPI implements AdminEmailApiInter
402
434
  */
403
435
  adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminEmailTemplatesPreviewResponse, any, {}>>;
404
436
  /**
405
- *
437
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
406
438
  * @summary Create or replace the custom email template for a type
407
439
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
408
440
  * @param {*} [options] Override http request option.
@@ -40,10 +40,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
40
40
  * @summary Remove the custom email template so the built-in default is used
41
41
  * @param {string} orgId
42
42
  * @param {string} type
43
+ * @param {string} [locale]
44
+ * @param {string} [clientId]
43
45
  * @param {*} [options] Override http request option.
44
46
  * @throws {RequiredError}
45
47
  */
46
- adminEmailTemplatesDelete: (orgId_1, type_1, ...args_1) => __awaiter(this, [orgId_1, type_1, ...args_1], void 0, function* (orgId, type, options = {}) {
48
+ adminEmailTemplatesDelete: (orgId_1, type_1, locale_1, clientId_1, ...args_1) => __awaiter(this, [orgId_1, type_1, locale_1, clientId_1, ...args_1], void 0, function* (orgId, type, locale, clientId, options = {}) {
47
49
  // verify required parameter 'orgId' is not null or undefined
48
50
  (0, common_1.assertParamExists)('adminEmailTemplatesDelete', 'orgId', orgId);
49
51
  // verify required parameter 'type' is not null or undefined
@@ -65,6 +67,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
65
67
  // authentication BearerAuth required
66
68
  // http bearer authentication required
67
69
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
70
+ if (locale !== undefined) {
71
+ localVarQueryParameter['locale'] = locale;
72
+ }
73
+ if (clientId !== undefined) {
74
+ localVarQueryParameter['client_id'] = clientId;
75
+ }
68
76
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
69
77
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
70
78
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -78,10 +86,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
78
86
  * @summary Get an email template (custom or built-in default)
79
87
  * @param {string} orgId
80
88
  * @param {string} type
89
+ * @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
90
+ * @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
81
91
  * @param {*} [options] Override http request option.
82
92
  * @throws {RequiredError}
83
93
  */
84
- adminEmailTemplatesGet: (orgId_1, type_1, ...args_1) => __awaiter(this, [orgId_1, type_1, ...args_1], void 0, function* (orgId, type, options = {}) {
94
+ adminEmailTemplatesGet: (orgId_1, type_1, locale_1, clientId_1, ...args_1) => __awaiter(this, [orgId_1, type_1, locale_1, clientId_1, ...args_1], void 0, function* (orgId, type, locale, clientId, options = {}) {
85
95
  // verify required parameter 'orgId' is not null or undefined
86
96
  (0, common_1.assertParamExists)('adminEmailTemplatesGet', 'orgId', orgId);
87
97
  // verify required parameter 'type' is not null or undefined
@@ -103,6 +113,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
103
113
  // authentication BearerAuth required
104
114
  // http bearer authentication required
105
115
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
116
+ if (locale !== undefined) {
117
+ localVarQueryParameter['locale'] = locale;
118
+ }
119
+ if (clientId !== undefined) {
120
+ localVarQueryParameter['client_id'] = clientId;
121
+ }
106
122
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
107
123
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
108
124
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -184,7 +200,7 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
184
200
  };
185
201
  }),
186
202
  /**
187
- *
203
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
188
204
  * @summary Create or replace the custom email template for a type
189
205
  * @param {string} orgId
190
206
  * @param {string} type
@@ -274,13 +290,15 @@ const AdminEmailApiFp = function (configuration) {
274
290
  * @summary Remove the custom email template so the built-in default is used
275
291
  * @param {string} orgId
276
292
  * @param {string} type
293
+ * @param {string} [locale]
294
+ * @param {string} [clientId]
277
295
  * @param {*} [options] Override http request option.
278
296
  * @throws {RequiredError}
279
297
  */
280
- adminEmailTemplatesDelete(orgId, type, options) {
298
+ adminEmailTemplatesDelete(orgId, type, locale, clientId, options) {
281
299
  return __awaiter(this, void 0, void 0, function* () {
282
300
  var _a, _b, _c;
283
- const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, options);
301
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, locale, clientId, options);
284
302
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
285
303
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminEmailApi.adminEmailTemplatesDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
286
304
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -291,13 +309,15 @@ const AdminEmailApiFp = function (configuration) {
291
309
  * @summary Get an email template (custom or built-in default)
292
310
  * @param {string} orgId
293
311
  * @param {string} type
312
+ * @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
313
+ * @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
294
314
  * @param {*} [options] Override http request option.
295
315
  * @throws {RequiredError}
296
316
  */
297
- adminEmailTemplatesGet(orgId, type, options) {
317
+ adminEmailTemplatesGet(orgId, type, locale, clientId, options) {
298
318
  return __awaiter(this, void 0, void 0, function* () {
299
319
  var _a, _b, _c;
300
- const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, options);
320
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, locale, clientId, options);
301
321
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
302
322
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminEmailApi.adminEmailTemplatesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
303
323
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -337,7 +357,7 @@ const AdminEmailApiFp = function (configuration) {
337
357
  });
338
358
  },
339
359
  /**
340
- *
360
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
341
361
  * @summary Create or replace the custom email template for a type
342
362
  * @param {string} orgId
343
363
  * @param {string} type
@@ -388,7 +408,7 @@ const AdminEmailApiFactory = function (configuration, basePath, axios) {
388
408
  * @throws {RequiredError}
389
409
  */
390
410
  adminEmailTemplatesDelete(requestParameters, options) {
391
- return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
411
+ return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
392
412
  },
393
413
  /**
394
414
  *
@@ -398,7 +418,7 @@ const AdminEmailApiFactory = function (configuration, basePath, axios) {
398
418
  * @throws {RequiredError}
399
419
  */
400
420
  adminEmailTemplatesGet(requestParameters, options) {
401
- return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
421
+ return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
402
422
  },
403
423
  /**
404
424
  *
@@ -421,7 +441,7 @@ const AdminEmailApiFactory = function (configuration, basePath, axios) {
421
441
  return localVarFp.adminEmailTemplatesPreview(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
422
442
  },
423
443
  /**
424
- *
444
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
425
445
  * @summary Create or replace the custom email template for a type
426
446
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
427
447
  * @param {*} [options] Override http request option.
@@ -459,7 +479,7 @@ class AdminEmailApi extends base_1.BaseAPI {
459
479
  * @memberof AdminEmailApi
460
480
  */
461
481
  adminEmailTemplatesDelete(requestParameters, options) {
462
- return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
482
+ return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
463
483
  }
464
484
  /**
465
485
  *
@@ -470,7 +490,7 @@ class AdminEmailApi extends base_1.BaseAPI {
470
490
  * @memberof AdminEmailApi
471
491
  */
472
492
  adminEmailTemplatesGet(requestParameters, options) {
473
- return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
493
+ return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
474
494
  }
475
495
  /**
476
496
  *
@@ -495,7 +515,7 @@ class AdminEmailApi extends base_1.BaseAPI {
495
515
  return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesPreview(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
496
516
  }
497
517
  /**
498
- *
518
+ * Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
499
519
  * @summary Create or replace the custom email template for a type
500
520
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
501
521
  * @param {*} [options] Override http request option.