@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
@@ -96,6 +96,8 @@ docs/AdminAuditLogsStatsResponseDataPeriod.md
96
96
  docs/AdminClientTokensRevokeAllResponse.md
97
97
  docs/AdminClientsCimdCheckRequest.md
98
98
  docs/AdminClientsCimdCheckResponse.md
99
+ docs/AdminClientsGetBrandingResponse.md
100
+ docs/AdminClientsGetBrandingResponseData.md
99
101
  docs/AdminEmailApi.md
100
102
  docs/AdminEmailTemplatesListResponse.md
101
103
  docs/AdminEmailTemplatesPreviewResponse.md
@@ -375,6 +377,7 @@ docs/OrganizationRole.md
375
377
  docs/PaginationMeta.md
376
378
  docs/ParResponse.md
377
379
  docs/PasskeyEnrollmentStarted.md
380
+ docs/PatchAdminClientsUpdateBrandingResponse.md
378
381
  docs/Permission.md
379
382
  docs/ProtectedResourceList.md
380
383
  docs/ProtectedResourceMetadata.md
@@ -383,6 +386,8 @@ docs/PutAbacAttributesUpdateResponse.md
383
386
  docs/PutAbacPoliciesUpdateResponse.md
384
387
  docs/PutAdminAgentsUpdateRequest.md
385
388
  docs/PutAdminAgentsUpdateResponse.md
389
+ docs/PutAdminClientsUpdateBrandingRequest.md
390
+ docs/PutAdminClientsUpdateBrandingResponse.md
386
391
  docs/PutAdminOrgMembersUpdateResponse.md
387
392
  docs/PutAdminSettingsAuthenticationUpdateResponse.md
388
393
  docs/PutAdminSettingsBrandingUpdateResponse.md
@@ -517,6 +522,8 @@ models/admin-audit-logs-stats-response.ts
517
522
  models/admin-client-tokens-revoke-all-response.ts
518
523
  models/admin-clients-cimd-check-request.ts
519
524
  models/admin-clients-cimd-check-response.ts
525
+ models/admin-clients-get-branding-response-data.ts
526
+ models/admin-clients-get-branding-response.ts
520
527
  models/admin-email-templates-list-response.ts
521
528
  models/admin-email-templates-preview-response.ts
522
529
  models/admin-email-templates-variables-response.ts
@@ -775,6 +782,7 @@ models/organization.ts
775
782
  models/pagination-meta.ts
776
783
  models/par-response.ts
777
784
  models/passkey-enrollment-started.ts
785
+ models/patch-admin-clients-update-branding-response.ts
778
786
  models/permission.ts
779
787
  models/protected-resource-list.ts
780
788
  models/protected-resource-metadata.ts
@@ -783,6 +791,8 @@ models/put-abac-attributes-update-response.ts
783
791
  models/put-abac-policies-update-response.ts
784
792
  models/put-admin-agents-update-request.ts
785
793
  models/put-admin-agents-update-response.ts
794
+ models/put-admin-clients-update-branding-request.ts
795
+ models/put-admin-clients-update-branding-response.ts
786
796
  models/put-admin-org-members-update-response.ts
787
797
  models/put-admin-settings-authentication-update-response.ts
788
798
  models/put-admin-settings-branding-update-response.ts
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  > `github.com/lumoauth/lumo-auth-go`), prefer it.
8
8
  > Do not edit by hand: changes are overwritten on the next regeneration.
9
9
 
10
- ## @lumoauth/api-client@1.2.0
10
+ ## @lumoauth/api-client@1.3.0
11
11
 
12
12
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
13
13
 
@@ -45,7 +45,7 @@ navigate to the folder of your consuming project and run one of the following co
45
45
  _published:_
46
46
 
47
47
  ```
48
- npm install @lumoauth/api-client@1.2.0 --save
48
+ npm install @lumoauth/api-client@1.3.0 --save
49
49
  ```
50
50
 
51
51
  _unPublished (not recommended):_
@@ -154,6 +154,7 @@ Class | Method | HTTP request | Description
154
154
  *AdminMfaApi* | [**listUserAuthenticators**](docs/AdminMfaApi.md#listuserauthenticators) | **GET** /orgs/{orgId}/api/v1/admin/users/{userId}/authenticators | List a user\'s authenticators
155
155
  *AdminMfaApi* | [**updateMfaPolicy**](docs/AdminMfaApi.md#updatemfapolicy) | **PUT** /orgs/{orgId}/api/v1/admin/policies/mfa | Update the MFA policy
156
156
  *AdminOAuthClientsApi* | [**adminClientsCimdCheck**](docs/AdminOAuthClientsApi.md#adminclientscimdcheck) | **POST** /orgs/{orgId}/api/v1/admin/clients/cimd/check | Check a Client ID Metadata Document
157
+ *AdminOAuthClientsApi* | [**adminClientsGetBranding**](docs/AdminOAuthClientsApi.md#adminclientsgetbranding) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Get an OAuth client\'s login and consent page branding
157
158
  *AdminOAuthClientsApi* | [**createClient**](docs/AdminOAuthClientsApi.md#createclient) | **POST** /orgs/{orgId}/api/v1/admin/clients | Create an OAuth client
158
159
  *AdminOAuthClientsApi* | [**deleteClient**](docs/AdminOAuthClientsApi.md#deleteclient) | **DELETE** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Delete an OAuth client
159
160
  *AdminOAuthClientsApi* | [**disableClient**](docs/AdminOAuthClientsApi.md#disableclient) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/disable | Disable an OAuth client
@@ -161,7 +162,9 @@ Class | Method | HTTP request | Description
161
162
  *AdminOAuthClientsApi* | [**getClient**](docs/AdminOAuthClientsApi.md#getclient) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Get an OAuth client
162
163
  *AdminOAuthClientsApi* | [**listClientScopes**](docs/AdminOAuthClientsApi.md#listclientscopes) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | List the scopes granted to an OAuth client
163
164
  *AdminOAuthClientsApi* | [**listClients**](docs/AdminOAuthClientsApi.md#listclients) | **GET** /orgs/{orgId}/api/v1/admin/clients | List OAuth clients
165
+ *AdminOAuthClientsApi* | [**patchAdminClientsUpdateBranding**](docs/AdminOAuthClientsApi.md#patchadminclientsupdatebranding) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Change keys of an OAuth client\'s login and/or consent page branding
164
166
  *AdminOAuthClientsApi* | [**patchClient**](docs/AdminOAuthClientsApi.md#patchclient) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client
167
+ *AdminOAuthClientsApi* | [**putAdminClientsUpdateBranding**](docs/AdminOAuthClientsApi.md#putadminclientsupdatebranding) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Replace an OAuth client\'s login and/or consent page branding
165
168
  *AdminOAuthClientsApi* | [**rotateClientSecret**](docs/AdminOAuthClientsApi.md#rotateclientsecret) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret
166
169
  *AdminOAuthClientsApi* | [**setClientScopes**](docs/AdminOAuthClientsApi.md#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client
167
170
  *AdminOAuthClientsApi* | [**updateClient**](docs/AdminOAuthClientsApi.md#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Replace an OAuth client
@@ -366,7 +369,6 @@ Class | Method | HTTP request | Description
366
369
  *OAuthApi* | [**getOrgSelection**](docs/OAuthApi.md#getorgselection) | **GET** /orgs/{orgId}/api/v1/oauth/org-select | Organization selector page
367
370
  *OAuthApi* | [**introspect**](docs/OAuthApi.md#introspect) | **POST** /orgs/{orgId}/api/v1/oauth/introspect | Token introspection (RFC 7662)
368
371
  *OAuthApi* | [**par**](docs/OAuthApi.md#par) | **POST** /orgs/{orgId}/api/v1/oauth/par | Pushed authorization request (RFC 9126)
369
- *OAuthApi* | [**passkeyLogin**](docs/OAuthApi.md#passkeylogin) | **GET** /orgs/{orgId}/api/v1/oauth/passkey-login | Passkey login entry point
370
372
  *OAuthApi* | [**registerClient**](docs/OAuthApi.md#registerclient) | **POST** /orgs/{orgId}/api/v1/connect/register | Dynamic client registration (RFC 7591 / OIDC DCR)
371
373
  *OAuthApi* | [**revoke**](docs/OAuthApi.md#revoke) | **POST** /orgs/{orgId}/api/v1/oauth/revoke | Token revocation (RFC 7009)
372
374
  *OAuthApi* | [**socialCallback**](docs/OAuthApi.md#socialcallback) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback
@@ -374,7 +376,6 @@ Class | Method | HTTP request | Description
374
376
  *OAuthApi* | [**socialLogin**](docs/OAuthApi.md#sociallogin) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider} | Start social / enterprise identity-provider login
375
377
  *OAuthApi* | [**submitAuthorization**](docs/OAuthApi.md#submitauthorization) | **POST** /orgs/{orgId}/api/v1/oauth/authorize | OAuth 2.1 / OIDC authorization endpoint (form submission)
376
378
  *OAuthApi* | [**submitDeviceVerification**](docs/OAuthApi.md#submitdeviceverification) | **POST** /orgs/{orgId}/api/v1/oauth/device | Submit device verification
377
- *OAuthApi* | [**submitLogin**](docs/OAuthApi.md#submitlogin) | **POST** /orgs/{orgId}/api/v1/oauth/login/submit | Hosted login form submission
378
379
  *OAuthApi* | [**submitLoginJson**](docs/OAuthApi.md#submitloginjson) | **POST** /orgs/{orgId}/api/v1/oauth/login/json | Programmatic (JSON) login for the authorization flow
379
380
  *OAuthApi* | [**submitOrgSelection**](docs/OAuthApi.md#submitorgselection) | **POST** /orgs/{orgId}/api/v1/oauth/org-select | Submit organization selection
380
381
  *OAuthApi* | [**token**](docs/OAuthApi.md#token) | **POST** /orgs/{orgId}/api/v1/oauth/token | OAuth 2.1 token endpoint
@@ -455,6 +456,8 @@ Class | Method | HTTP request | Description
455
456
  - [AdminClientTokensRevokeAllResponse](docs/AdminClientTokensRevokeAllResponse.md)
456
457
  - [AdminClientsCimdCheckRequest](docs/AdminClientsCimdCheckRequest.md)
457
458
  - [AdminClientsCimdCheckResponse](docs/AdminClientsCimdCheckResponse.md)
459
+ - [AdminClientsGetBrandingResponse](docs/AdminClientsGetBrandingResponse.md)
460
+ - [AdminClientsGetBrandingResponseData](docs/AdminClientsGetBrandingResponseData.md)
458
461
  - [AdminEmailTemplatesListResponse](docs/AdminEmailTemplatesListResponse.md)
459
462
  - [AdminEmailTemplatesPreviewResponse](docs/AdminEmailTemplatesPreviewResponse.md)
460
463
  - [AdminEmailTemplatesVariablesResponse](docs/AdminEmailTemplatesVariablesResponse.md)
@@ -712,6 +715,7 @@ Class | Method | HTTP request | Description
712
715
  - [PaginationMeta](docs/PaginationMeta.md)
713
716
  - [ParResponse](docs/ParResponse.md)
714
717
  - [PasskeyEnrollmentStarted](docs/PasskeyEnrollmentStarted.md)
718
+ - [PatchAdminClientsUpdateBrandingResponse](docs/PatchAdminClientsUpdateBrandingResponse.md)
715
719
  - [Permission](docs/Permission.md)
716
720
  - [ProtectedResourceList](docs/ProtectedResourceList.md)
717
721
  - [ProtectedResourceMetadata](docs/ProtectedResourceMetadata.md)
@@ -720,6 +724,8 @@ Class | Method | HTTP request | Description
720
724
  - [PutAbacPoliciesUpdateResponse](docs/PutAbacPoliciesUpdateResponse.md)
721
725
  - [PutAdminAgentsUpdateRequest](docs/PutAdminAgentsUpdateRequest.md)
722
726
  - [PutAdminAgentsUpdateResponse](docs/PutAdminAgentsUpdateResponse.md)
727
+ - [PutAdminClientsUpdateBrandingRequest](docs/PutAdminClientsUpdateBrandingRequest.md)
728
+ - [PutAdminClientsUpdateBrandingResponse](docs/PutAdminClientsUpdateBrandingResponse.md)
723
729
  - [PutAdminOrgMembersUpdateResponse](docs/PutAdminOrgMembersUpdateResponse.md)
724
730
  - [PutAdminSettingsAuthenticationUpdateResponse](docs/PutAdminSettingsAuthenticationUpdateResponse.md)
725
731
  - [PutAdminSettingsBrandingUpdateResponse](docs/PutAdminSettingsBrandingUpdateResponse.md)
@@ -42,10 +42,12 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
42
42
  * @summary Remove the custom email template so the built-in default is used
43
43
  * @param {string} orgId
44
44
  * @param {string} type
45
+ * @param {string} [locale]
46
+ * @param {string} [clientId]
45
47
  * @param {*} [options] Override http request option.
46
48
  * @throws {RequiredError}
47
49
  */
48
- adminEmailTemplatesDelete: async (orgId: string, type: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
50
+ adminEmailTemplatesDelete: async (orgId: string, type: string, locale?: string, clientId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
49
51
  // verify required parameter 'orgId' is not null or undefined
50
52
  assertParamExists('adminEmailTemplatesDelete', 'orgId', orgId)
51
53
  // verify required parameter 'type' is not null or undefined
@@ -71,6 +73,14 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
71
73
  // http bearer authentication required
72
74
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
73
75
 
76
+ if (locale !== undefined) {
77
+ localVarQueryParameter['locale'] = locale;
78
+ }
79
+
80
+ if (clientId !== undefined) {
81
+ localVarQueryParameter['client_id'] = clientId;
82
+ }
83
+
74
84
 
75
85
 
76
86
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -87,10 +97,12 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
87
97
  * @summary Get an email template (custom or built-in default)
88
98
  * @param {string} orgId
89
99
  * @param {string} type
100
+ * @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
101
+ * @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
90
102
  * @param {*} [options] Override http request option.
91
103
  * @throws {RequiredError}
92
104
  */
93
- adminEmailTemplatesGet: async (orgId: string, type: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
105
+ adminEmailTemplatesGet: async (orgId: string, type: string, locale?: string, clientId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
94
106
  // verify required parameter 'orgId' is not null or undefined
95
107
  assertParamExists('adminEmailTemplatesGet', 'orgId', orgId)
96
108
  // verify required parameter 'type' is not null or undefined
@@ -116,6 +128,14 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
116
128
  // http bearer authentication required
117
129
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
118
130
 
131
+ if (locale !== undefined) {
132
+ localVarQueryParameter['locale'] = locale;
133
+ }
134
+
135
+ if (clientId !== undefined) {
136
+ localVarQueryParameter['client_id'] = clientId;
137
+ }
138
+
119
139
 
120
140
 
121
141
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -214,7 +234,7 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
214
234
  };
215
235
  },
216
236
  /**
217
- *
237
+ * 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.
218
238
  * @summary Create or replace the custom email template for a type
219
239
  * @param {string} orgId
220
240
  * @param {string} type
@@ -318,11 +338,13 @@ export const AdminEmailApiFp = function(configuration?: Configuration) {
318
338
  * @summary Remove the custom email template so the built-in default is used
319
339
  * @param {string} orgId
320
340
  * @param {string} type
341
+ * @param {string} [locale]
342
+ * @param {string} [clientId]
321
343
  * @param {*} [options] Override http request option.
322
344
  * @throws {RequiredError}
323
345
  */
324
- async adminEmailTemplatesDelete(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>> {
325
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, options);
346
+ async adminEmailTemplatesDelete(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>> {
347
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, locale, clientId, options);
326
348
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
327
349
  const localVarOperationServerBasePath = operationServerMap['AdminEmailApi.adminEmailTemplatesDelete']?.[localVarOperationServerIndex]?.url;
328
350
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -332,11 +354,13 @@ export const AdminEmailApiFp = function(configuration?: Configuration) {
332
354
  * @summary Get an email template (custom or built-in default)
333
355
  * @param {string} orgId
334
356
  * @param {string} type
357
+ * @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
358
+ * @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
335
359
  * @param {*} [options] Override http request option.
336
360
  * @throws {RequiredError}
337
361
  */
338
- async adminEmailTemplatesGet(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>> {
339
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, options);
362
+ async adminEmailTemplatesGet(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>> {
363
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, locale, clientId, options);
340
364
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
341
365
  const localVarOperationServerBasePath = operationServerMap['AdminEmailApi.adminEmailTemplatesGet']?.[localVarOperationServerIndex]?.url;
342
366
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -369,7 +393,7 @@ export const AdminEmailApiFp = function(configuration?: Configuration) {
369
393
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
370
394
  },
371
395
  /**
372
- *
396
+ * 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.
373
397
  * @summary Create or replace the custom email template for a type
374
398
  * @param {string} orgId
375
399
  * @param {string} type
@@ -414,7 +438,7 @@ export const AdminEmailApiFactory = function (configuration?: Configuration, bas
414
438
  * @throws {RequiredError}
415
439
  */
416
440
  adminEmailTemplatesDelete(requestParameters: AdminEmailApiAdminEmailTemplatesDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse> {
417
- return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
441
+ return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
418
442
  },
419
443
  /**
420
444
  *
@@ -424,7 +448,7 @@ export const AdminEmailApiFactory = function (configuration?: Configuration, bas
424
448
  * @throws {RequiredError}
425
449
  */
426
450
  adminEmailTemplatesGet(requestParameters: AdminEmailApiAdminEmailTemplatesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailTemplate> {
427
- return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
451
+ return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
428
452
  },
429
453
  /**
430
454
  *
@@ -447,7 +471,7 @@ export const AdminEmailApiFactory = function (configuration?: Configuration, bas
447
471
  return localVarFp.adminEmailTemplatesPreview(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
448
472
  },
449
473
  /**
450
- *
474
+ * 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.
451
475
  * @summary Create or replace the custom email template for a type
452
476
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
453
477
  * @param {*} [options] Override http request option.
@@ -516,7 +540,7 @@ export interface AdminEmailApiInterface {
516
540
  adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminEmailTemplatesPreviewResponse>;
517
541
 
518
542
  /**
519
- *
543
+ * 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.
520
544
  * @summary Create or replace the custom email template for a type
521
545
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
522
546
  * @param {*} [options] Override http request option.
@@ -556,6 +580,20 @@ export interface AdminEmailApiAdminEmailTemplatesDeleteRequest {
556
580
  * @memberof AdminEmailApiAdminEmailTemplatesDelete
557
581
  */
558
582
  readonly type: string
583
+
584
+ /**
585
+ *
586
+ * @type {string}
587
+ * @memberof AdminEmailApiAdminEmailTemplatesDelete
588
+ */
589
+ readonly locale?: string
590
+
591
+ /**
592
+ *
593
+ * @type {string}
594
+ * @memberof AdminEmailApiAdminEmailTemplatesDelete
595
+ */
596
+ readonly clientId?: string
559
597
  }
560
598
 
561
599
  /**
@@ -577,6 +615,20 @@ export interface AdminEmailApiAdminEmailTemplatesGetRequest {
577
615
  * @memberof AdminEmailApiAdminEmailTemplatesGet
578
616
  */
579
617
  readonly type: string
618
+
619
+ /**
620
+ * Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
621
+ * @type {string}
622
+ * @memberof AdminEmailApiAdminEmailTemplatesGet
623
+ */
624
+ readonly locale?: string
625
+
626
+ /**
627
+ * Application variant (OAuth client_id); omit for the variant used by every application
628
+ * @type {string}
629
+ * @memberof AdminEmailApiAdminEmailTemplatesGet
630
+ */
631
+ readonly clientId?: string
580
632
  }
581
633
 
582
634
  /**
@@ -672,7 +724,7 @@ export class AdminEmailApi extends BaseAPI implements AdminEmailApiInterface {
672
724
  * @memberof AdminEmailApi
673
725
  */
674
726
  public adminEmailTemplatesDelete(requestParameters: AdminEmailApiAdminEmailTemplatesDeleteRequest, options?: RawAxiosRequestConfig) {
675
- return AdminEmailApiFp(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
727
+ return AdminEmailApiFp(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
676
728
  }
677
729
 
678
730
  /**
@@ -684,7 +736,7 @@ export class AdminEmailApi extends BaseAPI implements AdminEmailApiInterface {
684
736
  * @memberof AdminEmailApi
685
737
  */
686
738
  public adminEmailTemplatesGet(requestParameters: AdminEmailApiAdminEmailTemplatesGetRequest, options?: RawAxiosRequestConfig) {
687
- return AdminEmailApiFp(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
739
+ return AdminEmailApiFp(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
688
740
  }
689
741
 
690
742
  /**
@@ -712,7 +764,7 @@ export class AdminEmailApi extends BaseAPI implements AdminEmailApiInterface {
712
764
  }
713
765
 
714
766
  /**
715
- *
767
+ * 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.
716
768
  * @summary Create or replace the custom email template for a type
717
769
  * @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
718
770
  * @param {*} [options] Override http request option.