@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
@@ -90,14 +90,6 @@ export declare const OAuthApiAxiosParamCreator: (configuration?: Configuration)
90
90
  * @throws {RequiredError}
91
91
  */
92
92
  par: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
93
- /**
94
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
95
- * @summary Passkey login entry point
96
- * @param {string} orgId
97
- * @param {*} [options] Override http request option.
98
- * @throws {RequiredError}
99
- */
100
- passkeyLogin: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
101
93
  /**
102
94
  * 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.
103
95
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -157,14 +149,6 @@ export declare const OAuthApiAxiosParamCreator: (configuration?: Configuration)
157
149
  * @throws {RequiredError}
158
150
  */
159
151
  submitDeviceVerification: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
160
- /**
161
- * 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.
162
- * @summary Hosted login form submission
163
- * @param {string} orgId
164
- * @param {*} [options] Override http request option.
165
- * @throws {RequiredError}
166
- */
167
- submitLogin: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
168
152
  /**
169
153
  * 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.
170
154
  * @summary Programmatic (JSON) login for the authorization flow
@@ -260,14 +244,6 @@ export declare const OAuthApiFp: (configuration?: Configuration) => {
260
244
  * @throws {RequiredError}
261
245
  */
262
246
  par(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParResponse>>;
263
- /**
264
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
265
- * @summary Passkey login entry point
266
- * @param {string} orgId
267
- * @param {*} [options] Override http request option.
268
- * @throws {RequiredError}
269
- */
270
- passkeyLogin(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
271
247
  /**
272
248
  * 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.
273
249
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -327,14 +303,6 @@ export declare const OAuthApiFp: (configuration?: Configuration) => {
327
303
  * @throws {RequiredError}
328
304
  */
329
305
  submitDeviceVerification(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
330
- /**
331
- * 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.
332
- * @summary Hosted login form submission
333
- * @param {string} orgId
334
- * @param {*} [options] Override http request option.
335
- * @throws {RequiredError}
336
- */
337
- submitLogin(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
338
306
  /**
339
307
  * 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.
340
308
  * @summary Programmatic (JSON) login for the authorization flow
@@ -429,14 +397,6 @@ export declare const OAuthApiFactory: (configuration?: Configuration, basePath?:
429
397
  * @throws {RequiredError}
430
398
  */
431
399
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
432
- /**
433
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
434
- * @summary Passkey login entry point
435
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
436
- * @param {*} [options] Override http request option.
437
- * @throws {RequiredError}
438
- */
439
- passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
440
400
  /**
441
401
  * 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.
442
402
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -493,14 +453,6 @@ export declare const OAuthApiFactory: (configuration?: Configuration, basePath?:
493
453
  * @throws {RequiredError}
494
454
  */
495
455
  submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
496
- /**
497
- * 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.
498
- * @summary Hosted login form submission
499
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
500
- * @param {*} [options] Override http request option.
501
- * @throws {RequiredError}
502
- */
503
- submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
504
456
  /**
505
457
  * 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.
506
458
  * @summary Programmatic (JSON) login for the authorization flow
@@ -604,15 +556,6 @@ export interface OAuthApiInterface {
604
556
  * @memberof OAuthApiInterface
605
557
  */
606
558
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
607
- /**
608
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
609
- * @summary Passkey login entry point
610
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
611
- * @param {*} [options] Override http request option.
612
- * @throws {RequiredError}
613
- * @memberof OAuthApiInterface
614
- */
615
- passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
616
559
  /**
617
560
  * 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.
618
561
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -676,15 +619,6 @@ export interface OAuthApiInterface {
676
619
  * @memberof OAuthApiInterface
677
620
  */
678
621
  submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
679
- /**
680
- * 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.
681
- * @summary Hosted login form submission
682
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
683
- * @param {*} [options] Override http request option.
684
- * @throws {RequiredError}
685
- * @memberof OAuthApiInterface
686
- */
687
- submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
688
622
  /**
689
623
  * 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.
690
624
  * @summary Programmatic (JSON) login for the authorization flow
@@ -823,19 +757,6 @@ export interface OAuthApiParRequest {
823
757
  */
824
758
  readonly orgId: string;
825
759
  }
826
- /**
827
- * Request parameters for passkeyLogin operation in OAuthApi.
828
- * @export
829
- * @interface OAuthApiPasskeyLoginRequest
830
- */
831
- export interface OAuthApiPasskeyLoginRequest {
832
- /**
833
- *
834
- * @type {string}
835
- * @memberof OAuthApiPasskeyLogin
836
- */
837
- readonly orgId: string;
838
- }
839
760
  /**
840
761
  * Request parameters for registerClient operation in OAuthApi.
841
762
  * @export
@@ -945,19 +866,6 @@ export interface OAuthApiSubmitDeviceVerificationRequest {
945
866
  */
946
867
  readonly orgId: string;
947
868
  }
948
- /**
949
- * Request parameters for submitLogin operation in OAuthApi.
950
- * @export
951
- * @interface OAuthApiSubmitLoginRequest
952
- */
953
- export interface OAuthApiSubmitLoginRequest {
954
- /**
955
- *
956
- * @type {string}
957
- * @memberof OAuthApiSubmitLogin
958
- */
959
- readonly orgId: string;
960
- }
961
869
  /**
962
870
  * Request parameters for submitLoginJson operation in OAuthApi.
963
871
  * @export
@@ -1076,15 +984,6 @@ export declare class OAuthApi extends BaseAPI implements OAuthApiInterface {
1076
984
  * @memberof OAuthApi
1077
985
  */
1078
986
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParResponse, any, {}>>;
1079
- /**
1080
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
1081
- * @summary Passkey login entry point
1082
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
1083
- * @param {*} [options] Override http request option.
1084
- * @throws {RequiredError}
1085
- * @memberof OAuthApi
1086
- */
1087
- passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1088
987
  /**
1089
988
  * 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.
1090
989
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -1148,15 +1047,6 @@ export declare class OAuthApi extends BaseAPI implements OAuthApiInterface {
1148
1047
  * @memberof OAuthApi
1149
1048
  */
1150
1049
  submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
1151
- /**
1152
- * 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.
1153
- * @summary Hosted login form submission
1154
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
1155
- * @param {*} [options] Override http request option.
1156
- * @throws {RequiredError}
1157
- * @memberof OAuthApi
1158
- */
1159
- submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1160
1050
  /**
1161
1051
  * 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.
1162
1052
  * @summary Programmatic (JSON) login for the authorization flow
@@ -288,35 +288,6 @@ const OAuthApiAxiosParamCreator = function (configuration) {
288
288
  options: localVarRequestOptions,
289
289
  };
290
290
  }),
291
- /**
292
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
293
- * @summary Passkey login entry point
294
- * @param {string} orgId
295
- * @param {*} [options] Override http request option.
296
- * @throws {RequiredError}
297
- */
298
- passkeyLogin: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
299
- // verify required parameter 'orgId' is not null or undefined
300
- (0, common_1.assertParamExists)('passkeyLogin', 'orgId', orgId);
301
- const localVarPath = `/orgs/{orgId}/api/v1/oauth/passkey-login`
302
- .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
303
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
304
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
305
- let baseOptions;
306
- if (configuration) {
307
- baseOptions = configuration.baseOptions;
308
- }
309
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
310
- const localVarHeaderParameter = {};
311
- const localVarQueryParameter = {};
312
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
313
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
314
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
315
- return {
316
- url: (0, common_1.toPathString)(localVarUrlObj),
317
- options: localVarRequestOptions,
318
- };
319
- }),
320
291
  /**
321
292
  * 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.
322
293
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -540,35 +511,6 @@ const OAuthApiAxiosParamCreator = function (configuration) {
540
511
  options: localVarRequestOptions,
541
512
  };
542
513
  }),
543
- /**
544
- * 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.
545
- * @summary Hosted login form submission
546
- * @param {string} orgId
547
- * @param {*} [options] Override http request option.
548
- * @throws {RequiredError}
549
- */
550
- submitLogin: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
551
- // verify required parameter 'orgId' is not null or undefined
552
- (0, common_1.assertParamExists)('submitLogin', 'orgId', orgId);
553
- const localVarPath = `/orgs/{orgId}/api/v1/oauth/login/submit`
554
- .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
555
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
556
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
557
- let baseOptions;
558
- if (configuration) {
559
- baseOptions = configuration.baseOptions;
560
- }
561
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
562
- const localVarHeaderParameter = {};
563
- const localVarQueryParameter = {};
564
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
565
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
566
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
567
- return {
568
- url: (0, common_1.toPathString)(localVarUrlObj),
569
- options: localVarRequestOptions,
570
- };
571
- }),
572
514
  /**
573
515
  * 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.
574
516
  * @summary Programmatic (JSON) login for the authorization flow
@@ -798,22 +740,6 @@ const OAuthApiFp = function (configuration) {
798
740
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
799
741
  });
800
742
  },
801
- /**
802
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
803
- * @summary Passkey login entry point
804
- * @param {string} orgId
805
- * @param {*} [options] Override http request option.
806
- * @throws {RequiredError}
807
- */
808
- passkeyLogin(orgId, options) {
809
- return __awaiter(this, void 0, void 0, function* () {
810
- var _a, _b, _c;
811
- const localVarAxiosArgs = yield localVarAxiosParamCreator.passkeyLogin(orgId, options);
812
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
813
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthApi.passkeyLogin']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
814
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
815
- });
816
- },
817
743
  /**
818
744
  * 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.
819
745
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -929,22 +855,6 @@ const OAuthApiFp = function (configuration) {
929
855
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
930
856
  });
931
857
  },
932
- /**
933
- * 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.
934
- * @summary Hosted login form submission
935
- * @param {string} orgId
936
- * @param {*} [options] Override http request option.
937
- * @throws {RequiredError}
938
- */
939
- submitLogin(orgId, options) {
940
- return __awaiter(this, void 0, void 0, function* () {
941
- var _a, _b, _c;
942
- const localVarAxiosArgs = yield localVarAxiosParamCreator.submitLogin(orgId, options);
943
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
944
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthApi.submitLogin']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
945
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
946
- });
947
- },
948
858
  /**
949
859
  * 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.
950
860
  * @summary Programmatic (JSON) login for the authorization flow
@@ -1083,16 +993,6 @@ const OAuthApiFactory = function (configuration, basePath, axios) {
1083
993
  par(requestParameters, options) {
1084
994
  return localVarFp.par(requestParameters.orgId, options).then((request) => request(axios, basePath));
1085
995
  },
1086
- /**
1087
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
1088
- * @summary Passkey login entry point
1089
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
1090
- * @param {*} [options] Override http request option.
1091
- * @throws {RequiredError}
1092
- */
1093
- passkeyLogin(requestParameters, options) {
1094
- return localVarFp.passkeyLogin(requestParameters.orgId, options).then((request) => request(axios, basePath));
1095
- },
1096
996
  /**
1097
997
  * 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.
1098
998
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -1163,16 +1063,6 @@ const OAuthApiFactory = function (configuration, basePath, axios) {
1163
1063
  submitDeviceVerification(requestParameters, options) {
1164
1064
  return localVarFp.submitDeviceVerification(requestParameters.orgId, options).then((request) => request(axios, basePath));
1165
1065
  },
1166
- /**
1167
- * 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.
1168
- * @summary Hosted login form submission
1169
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
1170
- * @param {*} [options] Override http request option.
1171
- * @throws {RequiredError}
1172
- */
1173
- submitLogin(requestParameters, options) {
1174
- return localVarFp.submitLogin(requestParameters.orgId, options).then((request) => request(axios, basePath));
1175
- },
1176
1066
  /**
1177
1067
  * 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.
1178
1068
  * @summary Programmatic (JSON) login for the authorization flow
@@ -1301,17 +1191,6 @@ class OAuthApi extends base_1.BaseAPI {
1301
1191
  par(requestParameters, options) {
1302
1192
  return (0, exports.OAuthApiFp)(this.configuration).par(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1303
1193
  }
1304
- /**
1305
- * Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
1306
- * @summary Passkey login entry point
1307
- * @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
1308
- * @param {*} [options] Override http request option.
1309
- * @throws {RequiredError}
1310
- * @memberof OAuthApi
1311
- */
1312
- passkeyLogin(requestParameters, options) {
1313
- return (0, exports.OAuthApiFp)(this.configuration).passkeyLogin(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1314
- }
1315
1194
  /**
1316
1195
  * 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.
1317
1196
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
@@ -1389,17 +1268,6 @@ class OAuthApi extends base_1.BaseAPI {
1389
1268
  submitDeviceVerification(requestParameters, options) {
1390
1269
  return (0, exports.OAuthApiFp)(this.configuration).submitDeviceVerification(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1391
1270
  }
1392
- /**
1393
- * 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.
1394
- * @summary Hosted login form submission
1395
- * @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
1396
- * @param {*} [options] Override http request option.
1397
- * @throws {RequiredError}
1398
- * @memberof OAuthApi
1399
- */
1400
- submitLogin(requestParameters, options) {
1401
- return (0, exports.OAuthApiFp)(this.configuration).submitLogin(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1402
- }
1403
1271
  /**
1404
1272
  * 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.
1405
1273
  * @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.