@lumoauth/api-client 1.1.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 (147) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +14 -4
  3. package/api/aauth-api.ts +5 -5
  4. package/api/admin-email-api.ts +67 -15
  5. package/api/admin-mcp-api.ts +5 -5
  6. package/api/admin-oauth-clients-api.ts +370 -0
  7. package/api/agents-api.ts +5 -5
  8. package/api/mcp-api.ts +130 -0
  9. package/api/oauth-api.ts +0 -186
  10. package/api/well-known-api.ts +10 -10
  11. package/dist/api/aauth-api.d.ts +5 -5
  12. package/dist/api/aauth-api.js +4 -4
  13. package/dist/api/admin-email-api.d.ts +41 -9
  14. package/dist/api/admin-email-api.js +34 -14
  15. package/dist/api/admin-mcp-api.d.ts +5 -5
  16. package/dist/api/admin-mcp-api.js +4 -4
  17. package/dist/api/admin-oauth-clients-api.d.ts +210 -0
  18. package/dist/api/admin-oauth-clients-api.js +236 -0
  19. package/dist/api/agents-api.d.ts +5 -5
  20. package/dist/api/agents-api.js +4 -4
  21. package/dist/api/mcp-api.d.ts +73 -0
  22. package/dist/api/mcp-api.js +82 -0
  23. package/dist/api/oauth-api.d.ts +0 -110
  24. package/dist/api/oauth-api.js +0 -132
  25. package/dist/api/well-known-api.d.ts +10 -10
  26. package/dist/api/well-known-api.js +8 -8
  27. package/dist/esm/api/aauth-api.d.ts +5 -5
  28. package/dist/esm/api/aauth-api.js +4 -4
  29. package/dist/esm/api/admin-email-api.d.ts +41 -9
  30. package/dist/esm/api/admin-email-api.js +34 -14
  31. package/dist/esm/api/admin-mcp-api.d.ts +5 -5
  32. package/dist/esm/api/admin-mcp-api.js +4 -4
  33. package/dist/esm/api/admin-oauth-clients-api.d.ts +210 -0
  34. package/dist/esm/api/admin-oauth-clients-api.js +236 -0
  35. package/dist/esm/api/agents-api.d.ts +5 -5
  36. package/dist/esm/api/agents-api.js +4 -4
  37. package/dist/esm/api/mcp-api.d.ts +73 -0
  38. package/dist/esm/api/mcp-api.js +83 -1
  39. package/dist/esm/api/oauth-api.d.ts +0 -110
  40. package/dist/esm/api/oauth-api.js +0 -132
  41. package/dist/esm/api/well-known-api.d.ts +10 -10
  42. package/dist/esm/api/well-known-api.js +8 -8
  43. package/dist/esm/models/admin-agents-generate-token-request.d.ts +7 -1
  44. package/dist/esm/models/admin-agents-generate-token-response-data.d.ts +12 -0
  45. package/dist/esm/models/admin-clients-get-branding-response-data.d.ts +34 -0
  46. package/dist/esm/models/admin-clients-get-branding-response-data.js +14 -0
  47. package/dist/esm/models/admin-clients-get-branding-response.d.ts +25 -0
  48. package/dist/esm/models/admin-clients-get-branding-response.js +14 -0
  49. package/dist/esm/models/attest-response.d.ts +2 -1
  50. package/dist/esm/models/attest-response.js +1 -0
  51. package/dist/esm/models/authorization-server-metadata.d.ts +0 -6
  52. package/dist/esm/models/authorize-mcp-request.d.ts +1 -1
  53. package/dist/esm/models/get-protected-resource-metadata-root-response1-resources-item.d.ts +1 -1
  54. package/dist/esm/models/index.d.ts +8 -0
  55. package/dist/esm/models/index.js +8 -0
  56. package/dist/esm/models/mcp-server-tool-authorize-request-subject.d.ts +38 -0
  57. package/dist/esm/models/mcp-server-tool-authorize-request-subject.js +22 -0
  58. package/dist/esm/models/mcp-server-tool-authorize-request.d.ts +31 -0
  59. package/dist/esm/models/mcp-server-tool-authorize-request.js +14 -0
  60. package/dist/esm/models/mcp-server-tool-authorize-response.d.ts +36 -0
  61. package/dist/esm/models/mcp-server-tool-authorize-response.js +14 -0
  62. package/dist/esm/models/mcp-server.d.ts +18 -0
  63. package/dist/esm/models/open-id-configuration.d.ts +7 -7
  64. package/dist/esm/models/patch-admin-clients-update-branding-response.d.ts +32 -0
  65. package/dist/esm/models/patch-admin-clients-update-branding-response.js +14 -0
  66. package/dist/esm/models/protected-resource-metadata.d.ts +1 -1
  67. package/dist/esm/models/put-admin-clients-update-branding-request.d.ts +34 -0
  68. package/dist/esm/models/put-admin-clients-update-branding-request.js +14 -0
  69. package/dist/esm/models/put-admin-clients-update-branding-response.d.ts +32 -0
  70. package/dist/esm/models/put-admin-clients-update-branding-response.js +14 -0
  71. package/dist/esm/models/single-server-metadata.d.ts +1 -1
  72. package/dist/models/admin-agents-generate-token-request.d.ts +7 -1
  73. package/dist/models/admin-agents-generate-token-response-data.d.ts +12 -0
  74. package/dist/models/admin-clients-get-branding-response-data.d.ts +34 -0
  75. package/dist/models/admin-clients-get-branding-response-data.js +15 -0
  76. package/dist/models/admin-clients-get-branding-response.d.ts +25 -0
  77. package/dist/models/admin-clients-get-branding-response.js +15 -0
  78. package/dist/models/attest-response.d.ts +2 -1
  79. package/dist/models/attest-response.js +1 -0
  80. package/dist/models/authorization-server-metadata.d.ts +0 -6
  81. package/dist/models/authorize-mcp-request.d.ts +1 -1
  82. package/dist/models/get-protected-resource-metadata-root-response1-resources-item.d.ts +1 -1
  83. package/dist/models/index.d.ts +8 -0
  84. package/dist/models/index.js +8 -0
  85. package/dist/models/mcp-server-tool-authorize-request-subject.d.ts +38 -0
  86. package/dist/models/mcp-server-tool-authorize-request-subject.js +25 -0
  87. package/dist/models/mcp-server-tool-authorize-request.d.ts +31 -0
  88. package/dist/models/mcp-server-tool-authorize-request.js +15 -0
  89. package/dist/models/mcp-server-tool-authorize-response.d.ts +36 -0
  90. package/dist/models/mcp-server-tool-authorize-response.js +15 -0
  91. package/dist/models/mcp-server.d.ts +18 -0
  92. package/dist/models/open-id-configuration.d.ts +7 -7
  93. package/dist/models/patch-admin-clients-update-branding-response.d.ts +32 -0
  94. package/dist/models/patch-admin-clients-update-branding-response.js +15 -0
  95. package/dist/models/protected-resource-metadata.d.ts +1 -1
  96. package/dist/models/put-admin-clients-update-branding-request.d.ts +34 -0
  97. package/dist/models/put-admin-clients-update-branding-request.js +15 -0
  98. package/dist/models/put-admin-clients-update-branding-response.d.ts +32 -0
  99. package/dist/models/put-admin-clients-update-branding-response.js +15 -0
  100. package/dist/models/single-server-metadata.d.ts +1 -1
  101. package/docs/AAuthApi.md +1 -1
  102. package/docs/AdminAgentsApi.md +1 -1
  103. package/docs/AdminAgentsGenerateTokenRequest.md +3 -1
  104. package/docs/AdminAgentsGenerateTokenResponseData.md +4 -0
  105. package/docs/AdminClientsGetBrandingResponse.md +20 -0
  106. package/docs/AdminClientsGetBrandingResponseData.md +22 -0
  107. package/docs/AdminEmailApi.md +15 -2
  108. package/docs/AdminMcpApi.md +1 -1
  109. package/docs/AdminOAuthClientsApi.md +174 -0
  110. package/docs/AgentsApi.md +4 -3
  111. package/docs/AuthorizationServerMetadata.md +0 -2
  112. package/docs/AuthorizeMcpRequest.md +1 -1
  113. package/docs/GetProtectedResourceMetadataRoot200Response.md +1 -1
  114. package/docs/GetProtectedResourceMetadataRootResponse1ResourcesItem.md +1 -1
  115. package/docs/McpApi.md +64 -0
  116. package/docs/McpServer.md +6 -0
  117. package/docs/McpServerToolAuthorizeRequest.md +22 -0
  118. package/docs/McpServerToolAuthorizeRequestSubject.md +22 -0
  119. package/docs/McpServerToolAuthorizeResponse.md +24 -0
  120. package/docs/OAuthApi.md +0 -105
  121. package/docs/OpenIdConfiguration.md +3 -3
  122. package/docs/PatchAdminClientsUpdateBrandingResponse.md +22 -0
  123. package/docs/ProtectedResourceMetadata.md +1 -1
  124. package/docs/PutAdminClientsUpdateBrandingRequest.md +22 -0
  125. package/docs/PutAdminClientsUpdateBrandingResponse.md +22 -0
  126. package/docs/SingleServerMetadata.md +1 -1
  127. package/docs/WellKnownApi.md +2 -2
  128. package/models/admin-agents-generate-token-request.ts +7 -1
  129. package/models/admin-agents-generate-token-response-data.ts +12 -0
  130. package/models/admin-clients-get-branding-response-data.ts +36 -0
  131. package/models/admin-clients-get-branding-response.ts +33 -0
  132. package/models/attest-response.ts +2 -1
  133. package/models/authorization-server-metadata.ts +0 -6
  134. package/models/authorize-mcp-request.ts +1 -1
  135. package/models/get-protected-resource-metadata-root-response1-resources-item.ts +1 -1
  136. package/models/index.ts +8 -0
  137. package/models/mcp-server-tool-authorize-request-subject.ts +46 -0
  138. package/models/mcp-server-tool-authorize-request.ts +39 -0
  139. package/models/mcp-server-tool-authorize-response.ts +42 -0
  140. package/models/mcp-server.ts +18 -0
  141. package/models/open-id-configuration.ts +7 -7
  142. package/models/patch-admin-clients-update-branding-response.ts +36 -0
  143. package/models/protected-resource-metadata.ts +1 -1
  144. package/models/put-admin-clients-update-branding-request.ts +36 -0
  145. package/models/put-admin-clients-update-branding-response.ts +36 -0
  146. package/models/single-server-metadata.ts +1 -1
  147. package/package.json +1 -1
@@ -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
@@ -22,7 +22,7 @@ import type { OpenIdConfiguration } from '../models';
22
22
  */
23
23
  export declare const WellKnownApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
25
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
26
26
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
27
27
  * @param {string} orgId
28
28
  * @param {*} [options] Override http request option.
@@ -38,7 +38,7 @@ export declare const WellKnownApiAxiosParamCreator: (configuration?: Configurati
38
38
  */
39
39
  getJwks: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
40
40
  /**
41
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
41
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
42
42
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
43
43
  * @param {string} orgId
44
44
  * @param {*} [options] Override http request option.
@@ -60,7 +60,7 @@ export declare const WellKnownApiAxiosParamCreator: (configuration?: Configurati
60
60
  */
61
61
  export declare const WellKnownApiFp: (configuration?: Configuration) => {
62
62
  /**
63
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
63
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
64
64
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
65
65
  * @param {string} orgId
66
66
  * @param {*} [options] Override http request option.
@@ -76,7 +76,7 @@ export declare const WellKnownApiFp: (configuration?: Configuration) => {
76
76
  */
77
77
  getJwks(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonWebKeySet>>;
78
78
  /**
79
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
79
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
80
80
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
81
81
  * @param {string} orgId
82
82
  * @param {*} [options] Override http request option.
@@ -98,7 +98,7 @@ export declare const WellKnownApiFp: (configuration?: Configuration) => {
98
98
  */
99
99
  export declare const WellKnownApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
100
100
  /**
101
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
101
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
102
102
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
103
103
  * @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
104
104
  * @param {*} [options] Override http request option.
@@ -114,7 +114,7 @@ export declare const WellKnownApiFactory: (configuration?: Configuration, basePa
114
114
  */
115
115
  getJwks(requestParameters: WellKnownApiGetJwksRequest, options?: RawAxiosRequestConfig): AxiosPromise<JsonWebKeySet>;
116
116
  /**
117
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
117
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
118
118
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
119
119
  * @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
120
120
  * @param {*} [options] Override http request option.
@@ -137,7 +137,7 @@ export declare const WellKnownApiFactory: (configuration?: Configuration, basePa
137
137
  */
138
138
  export interface WellKnownApiInterface {
139
139
  /**
140
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
140
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
141
141
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
142
142
  * @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
143
143
  * @param {*} [options] Override http request option.
@@ -155,7 +155,7 @@ export interface WellKnownApiInterface {
155
155
  */
156
156
  getJwks(requestParameters: WellKnownApiGetJwksRequest, options?: RawAxiosRequestConfig): AxiosPromise<JsonWebKeySet>;
157
157
  /**
158
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
158
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
159
159
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
160
160
  * @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
161
161
  * @param {*} [options] Override http request option.
@@ -233,7 +233,7 @@ export interface WellKnownApiGetSsfConfigurationRequest {
233
233
  */
234
234
  export declare class WellKnownApi extends BaseAPI implements WellKnownApiInterface {
235
235
  /**
236
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
236
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
237
237
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
238
238
  * @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
239
239
  * @param {*} [options] Override http request option.
@@ -251,7 +251,7 @@ export declare class WellKnownApi extends BaseAPI implements WellKnownApiInterfa
251
251
  */
252
252
  getJwks(requestParameters: WellKnownApiGetJwksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonWebKeySet, any, {}>>;
253
253
  /**
254
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
254
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
255
255
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
256
256
  * @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
257
257
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const base_1 = require("../base");
36
36
  const WellKnownApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
39
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
40
40
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
41
41
  * @param {string} orgId
42
42
  * @param {*} [options] Override http request option.
@@ -94,7 +94,7 @@ const WellKnownApiAxiosParamCreator = function (configuration) {
94
94
  };
95
95
  }),
96
96
  /**
97
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
97
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
98
98
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
99
99
  * @param {string} orgId
100
100
  * @param {*} [options] Override http request option.
@@ -162,7 +162,7 @@ const WellKnownApiFp = function (configuration) {
162
162
  const localVarAxiosParamCreator = (0, exports.WellKnownApiAxiosParamCreator)(configuration);
163
163
  return {
164
164
  /**
165
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
165
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
166
166
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
167
167
  * @param {string} orgId
168
168
  * @param {*} [options] Override http request option.
@@ -194,7 +194,7 @@ const WellKnownApiFp = function (configuration) {
194
194
  });
195
195
  },
196
196
  /**
197
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
197
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
198
198
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
199
199
  * @param {string} orgId
200
200
  * @param {*} [options] Override http request option.
@@ -236,7 +236,7 @@ const WellKnownApiFactory = function (configuration, basePath, axios) {
236
236
  const localVarFp = (0, exports.WellKnownApiFp)(configuration);
237
237
  return {
238
238
  /**
239
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
239
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
240
240
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
241
241
  * @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
242
242
  * @param {*} [options] Override http request option.
@@ -256,7 +256,7 @@ const WellKnownApiFactory = function (configuration, basePath, axios) {
256
256
  return localVarFp.getJwks(requestParameters.orgId, options).then((request) => request(axios, basePath));
257
257
  },
258
258
  /**
259
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
259
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
260
260
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
261
261
  * @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
262
262
  * @param {*} [options] Override http request option.
@@ -286,7 +286,7 @@ exports.WellKnownApiFactory = WellKnownApiFactory;
286
286
  */
287
287
  class WellKnownApi extends base_1.BaseAPI {
288
288
  /**
289
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
289
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
290
290
  * @summary OAuth 2.0 authorization server metadata (RFC 8414)
291
291
  * @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
292
292
  * @param {*} [options] Override http request option.
@@ -308,7 +308,7 @@ class WellKnownApi extends base_1.BaseAPI {
308
308
  return (0, exports.WellKnownApiFp)(this.configuration).getJwks(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
309
309
  }
310
310
  /**
311
- * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
311
+ * Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
312
312
  * @summary OpenID Provider configuration (OIDC Discovery 1.0)
313
313
  * @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
314
314
  * @param {*} [options] Override http request option.
@@ -110,7 +110,7 @@ export declare const AAuthApiAxiosParamCreator: (configuration?: Configuration)
110
110
  */
111
111
  getResourceMetadataById: (orgId: string, resourceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
112
112
  /**
113
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
113
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
114
114
  * @summary Agent Token Endpoint
115
115
  * @param {string} orgId
116
116
  * @param {IssueAgentTokenRequest} issueAgentTokenRequest
@@ -254,7 +254,7 @@ export declare const AAuthApiFp: (configuration?: Configuration) => {
254
254
  */
255
255
  getResourceMetadataById(orgId: string, resourceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
256
256
  /**
257
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
257
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
258
258
  * @summary Agent Token Endpoint
259
259
  * @param {string} orgId
260
260
  * @param {IssueAgentTokenRequest} issueAgentTokenRequest
@@ -394,7 +394,7 @@ export declare const AAuthApiFactory: (configuration?: Configuration, basePath?:
394
394
  */
395
395
  getResourceMetadataById(requestParameters: AAuthApiGetResourceMetadataByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
396
396
  /**
397
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
397
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
398
398
  * @summary Agent Token Endpoint
399
399
  * @param {AAuthApiIssueAgentTokenRequest} requestParameters Request parameters.
400
400
  * @param {*} [options] Override http request option.
@@ -537,7 +537,7 @@ export interface AAuthApiInterface {
537
537
  */
538
538
  getResourceMetadataById(requestParameters: AAuthApiGetResourceMetadataByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
539
539
  /**
540
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
540
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
541
541
  * @summary Agent Token Endpoint
542
542
  * @param {AAuthApiIssueAgentTokenRequest} requestParameters Request parameters.
543
543
  * @param {*} [options] Override http request option.
@@ -962,7 +962,7 @@ export declare class AAuthApi extends BaseAPI implements AAuthApiInterface {
962
962
  */
963
963
  getResourceMetadataById(requestParameters: AAuthApiGetResourceMetadataByIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
964
964
  /**
965
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
965
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
966
966
  * @summary Agent Token Endpoint
967
967
  * @param {AAuthApiIssueAgentTokenRequest} requestParameters Request parameters.
968
968
  * @param {*} [options] Override http request option.
@@ -313,7 +313,7 @@ export const AAuthApiAxiosParamCreator = function (configuration) {
313
313
  };
314
314
  }),
315
315
  /**
316
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
316
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
317
317
  * @summary Agent Token Endpoint
318
318
  * @param {string} orgId
319
319
  * @param {IssueAgentTokenRequest} issueAgentTokenRequest
@@ -728,7 +728,7 @@ export const AAuthApiFp = function (configuration) {
728
728
  });
729
729
  },
730
730
  /**
731
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
731
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
732
732
  * @summary Agent Token Endpoint
733
733
  * @param {string} orgId
734
734
  * @param {IssueAgentTokenRequest} issueAgentTokenRequest
@@ -945,7 +945,7 @@ export const AAuthApiFactory = function (configuration, basePath, axios) {
945
945
  return localVarFp.getResourceMetadataById(requestParameters.orgId, requestParameters.resourceId, options).then((request) => request(axios, basePath));
946
946
  },
947
947
  /**
948
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
948
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
949
949
  * @summary Agent Token Endpoint
950
950
  * @param {AAuthApiIssueAgentTokenRequest} requestParameters Request parameters.
951
951
  * @param {*} [options] Override http request option.
@@ -1122,7 +1122,7 @@ export class AAuthApi extends BaseAPI {
1122
1122
  return AAuthApiFp(this.configuration).getResourceMetadataById(requestParameters.orgId, requestParameters.resourceId, options).then((request) => request(this.axios, this.basePath));
1123
1123
  }
1124
1124
  /**
1125
- * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @target-uri, content-type, content-digest, authorization
1125
+ * Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
1126
1126
  * @summary Agent Token Endpoint
1127
1127
  * @param {AAuthApiIssueAgentTokenRequest} requestParameters Request parameters.
1128
1128
  * @param {*} [options] Override http request option.
@@ -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.