@lumoauth/api-client 1.2.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +20 -0
- package/README.md +17 -4
- package/api/admin-agents-api.ts +130 -0
- package/api/admin-email-api.ts +67 -15
- package/api/admin-oauth-clients-api.ts +370 -0
- package/api/agents-api.ts +118 -0
- package/api/oauth-api.ts +0 -186
- package/dist/api/admin-agents-api.d.ts +73 -0
- package/dist/api/admin-agents-api.js +82 -0
- package/dist/api/admin-email-api.d.ts +41 -9
- package/dist/api/admin-email-api.js +34 -14
- package/dist/api/admin-oauth-clients-api.d.ts +210 -0
- package/dist/api/admin-oauth-clients-api.js +236 -0
- package/dist/api/agents-api.d.ts +65 -0
- package/dist/api/agents-api.js +77 -0
- package/dist/api/oauth-api.d.ts +0 -110
- package/dist/api/oauth-api.js +0 -132
- package/dist/esm/api/admin-agents-api.d.ts +73 -0
- package/dist/esm/api/admin-agents-api.js +82 -0
- package/dist/esm/api/admin-email-api.d.ts +41 -9
- package/dist/esm/api/admin-email-api.js +34 -14
- package/dist/esm/api/admin-oauth-clients-api.d.ts +210 -0
- package/dist/esm/api/admin-oauth-clients-api.js +236 -0
- package/dist/esm/api/agents-api.d.ts +65 -0
- package/dist/esm/api/agents-api.js +77 -0
- package/dist/esm/api/oauth-api.d.ts +0 -110
- package/dist/esm/api/oauth-api.js +0 -132
- package/dist/esm/models/abac-attribute-definition.d.ts +1 -1
- package/dist/esm/models/abac-resource-attribute.d.ts +1 -1
- package/dist/esm/models/admin-agents-report-usage-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-request.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/esm/models/admin-agents-report-usage-response.js +14 -0
- package/dist/esm/models/admin-clients-get-branding-response-data.d.ts +34 -0
- package/dist/esm/models/admin-clients-get-branding-response-data.js +14 -0
- package/dist/esm/models/admin-clients-get-branding-response.d.ts +25 -0
- package/dist/esm/models/admin-clients-get-branding-response.js +14 -0
- package/dist/esm/models/authorization-server-metadata.d.ts +0 -6
- package/dist/esm/models/index.d.ts +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/esm/models/open-id-configuration.d.ts +6 -6
- package/dist/esm/models/patch-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/esm/models/patch-admin-clients-update-branding-response.js +14 -0
- package/dist/esm/models/put-admin-clients-update-branding-request.d.ts +34 -0
- package/dist/esm/models/put-admin-clients-update-branding-request.js +14 -0
- package/dist/esm/models/put-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/esm/models/put-admin-clients-update-branding-response.js +14 -0
- package/dist/esm/models/report-agent-usage-response.d.ts +33 -0
- package/dist/esm/models/report-agent-usage-response.js +14 -0
- package/dist/esm/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/esm/models/userinfo-response.d.ts +8 -0
- package/dist/models/abac-attribute-definition.d.ts +1 -1
- package/dist/models/abac-resource-attribute.d.ts +1 -1
- package/dist/models/admin-agents-report-usage-request.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-request.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/models/admin-agents-report-usage-response-data.js +15 -0
- package/dist/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/models/admin-agents-report-usage-response.js +15 -0
- package/dist/models/admin-clients-get-branding-response-data.d.ts +34 -0
- package/dist/models/admin-clients-get-branding-response-data.js +15 -0
- package/dist/models/admin-clients-get-branding-response.d.ts +25 -0
- package/dist/models/admin-clients-get-branding-response.js +15 -0
- package/dist/models/authorization-server-metadata.d.ts +0 -6
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/open-id-configuration.d.ts +6 -6
- package/dist/models/patch-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/models/patch-admin-clients-update-branding-response.js +15 -0
- package/dist/models/put-admin-clients-update-branding-request.d.ts +34 -0
- package/dist/models/put-admin-clients-update-branding-request.js +15 -0
- package/dist/models/put-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/models/put-admin-clients-update-branding-response.js +15 -0
- package/dist/models/report-agent-usage-response.d.ts +33 -0
- package/dist/models/report-agent-usage-response.js +15 -0
- package/dist/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/models/userinfo-response.d.ts +8 -0
- package/docs/AdminAgentsApi.md +63 -0
- package/docs/AdminAgentsReportUsageRequest.md +22 -0
- package/docs/AdminAgentsReportUsageResponse.md +20 -0
- package/docs/AdminAgentsReportUsageResponseData.md +22 -0
- package/docs/AdminAgentsReportUsageResponseDataRecorded.md +22 -0
- package/docs/AdminClientsGetBrandingResponse.md +20 -0
- package/docs/AdminClientsGetBrandingResponseData.md +22 -0
- package/docs/AdminEmailApi.md +15 -2
- package/docs/AdminOAuthClientsApi.md +174 -0
- package/docs/AgentsApi.md +59 -0
- package/docs/AuthorizationServerMetadata.md +0 -2
- package/docs/OAuthApi.md +0 -105
- package/docs/OIDCApi.md +2 -2
- package/docs/OpenIdConfiguration.md +2 -2
- package/docs/PatchAdminClientsUpdateBrandingResponse.md +22 -0
- package/docs/PutAdminClientsUpdateBrandingRequest.md +22 -0
- package/docs/PutAdminClientsUpdateBrandingResponse.md +22 -0
- package/docs/ReportAgentUsageResponse.md +22 -0
- package/docs/UserinfoResponse.md +2 -0
- package/models/abac-attribute-definition.ts +1 -1
- package/models/abac-resource-attribute.ts +1 -1
- package/models/admin-agents-report-usage-request.ts +36 -0
- package/models/admin-agents-report-usage-response-data-recorded.ts +36 -0
- package/models/admin-agents-report-usage-response-data.ts +39 -0
- package/models/admin-agents-report-usage-response.ts +33 -0
- package/models/admin-clients-get-branding-response-data.ts +36 -0
- package/models/admin-clients-get-branding-response.ts +33 -0
- package/models/authorization-server-metadata.ts +0 -6
- package/models/index.ts +10 -0
- package/models/open-id-configuration.ts +6 -6
- package/models/patch-admin-clients-update-branding-response.ts +36 -0
- package/models/put-admin-clients-update-branding-request.ts +36 -0
- package/models/put-admin-clients-update-branding-response.ts +36 -0
- package/models/report-agent-usage-response.ts +39 -0
- package/models/set-user-attribute-response-data.ts +1 -1
- package/models/userinfo-response.ts +6 -0
- package/package.json +1 -1
|
@@ -453,6 +453,49 @@ const AdminAgentsApiAxiosParamCreator = function (configuration) {
|
|
|
453
453
|
options: localVarRequestOptions,
|
|
454
454
|
};
|
|
455
455
|
}),
|
|
456
|
+
/**
|
|
457
|
+
* For a trusted component of your organization, such as an AI gateway\'s spend callback or an orchestrator, that sees the agent\'s model calls. Adds the tokens and cost to the agent\'s budget windows (current UTC hour, day and month), exactly like POST /agents/me/usage from the agent itself. The report adds no API call and is accepted even when the budget is spent.
|
|
458
|
+
* @summary Report model tokens and cost for an agent
|
|
459
|
+
* @param {string} orgId
|
|
460
|
+
* @param {string} agentId
|
|
461
|
+
* @param {AdminAgentsReportUsageRequest} adminAgentsReportUsageRequest
|
|
462
|
+
* @param {*} [options] Override http request option.
|
|
463
|
+
* @throws {RequiredError}
|
|
464
|
+
*/
|
|
465
|
+
adminAgentsReportUsage: (orgId_1, agentId_1, adminAgentsReportUsageRequest_1, ...args_1) => __awaiter(this, [orgId_1, agentId_1, adminAgentsReportUsageRequest_1, ...args_1], void 0, function* (orgId, agentId, adminAgentsReportUsageRequest, options = {}) {
|
|
466
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
467
|
+
(0, common_1.assertParamExists)('adminAgentsReportUsage', 'orgId', orgId);
|
|
468
|
+
// verify required parameter 'agentId' is not null or undefined
|
|
469
|
+
(0, common_1.assertParamExists)('adminAgentsReportUsage', 'agentId', agentId);
|
|
470
|
+
// verify required parameter 'adminAgentsReportUsageRequest' is not null or undefined
|
|
471
|
+
(0, common_1.assertParamExists)('adminAgentsReportUsage', 'adminAgentsReportUsageRequest', adminAgentsReportUsageRequest);
|
|
472
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/agents/{agentId}/usage`
|
|
473
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
474
|
+
.replace(`{${"agentId"}}`, encodeURIComponent(String(agentId)));
|
|
475
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
476
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
477
|
+
let baseOptions;
|
|
478
|
+
if (configuration) {
|
|
479
|
+
baseOptions = configuration.baseOptions;
|
|
480
|
+
}
|
|
481
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
482
|
+
const localVarHeaderParameter = {};
|
|
483
|
+
const localVarQueryParameter = {};
|
|
484
|
+
// authentication ApiKeyAuth required
|
|
485
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
|
|
486
|
+
// authentication BearerAuth required
|
|
487
|
+
// http bearer authentication required
|
|
488
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
489
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
490
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
491
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
492
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
493
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(adminAgentsReportUsageRequest, localVarRequestOptions, configuration);
|
|
494
|
+
return {
|
|
495
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
496
|
+
options: localVarRequestOptions,
|
|
497
|
+
};
|
|
498
|
+
}),
|
|
456
499
|
/**
|
|
457
500
|
*
|
|
458
501
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -855,6 +898,24 @@ const AdminAgentsApiFp = function (configuration) {
|
|
|
855
898
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
856
899
|
});
|
|
857
900
|
},
|
|
901
|
+
/**
|
|
902
|
+
* For a trusted component of your organization, such as an AI gateway\'s spend callback or an orchestrator, that sees the agent\'s model calls. Adds the tokens and cost to the agent\'s budget windows (current UTC hour, day and month), exactly like POST /agents/me/usage from the agent itself. The report adds no API call and is accepted even when the budget is spent.
|
|
903
|
+
* @summary Report model tokens and cost for an agent
|
|
904
|
+
* @param {string} orgId
|
|
905
|
+
* @param {string} agentId
|
|
906
|
+
* @param {AdminAgentsReportUsageRequest} adminAgentsReportUsageRequest
|
|
907
|
+
* @param {*} [options] Override http request option.
|
|
908
|
+
* @throws {RequiredError}
|
|
909
|
+
*/
|
|
910
|
+
adminAgentsReportUsage(orgId, agentId, adminAgentsReportUsageRequest, options) {
|
|
911
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
912
|
+
var _a, _b, _c;
|
|
913
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAgentsReportUsage(orgId, agentId, adminAgentsReportUsageRequest, options);
|
|
914
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
915
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminAgentsApi.adminAgentsReportUsage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
916
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
917
|
+
});
|
|
918
|
+
},
|
|
858
919
|
/**
|
|
859
920
|
*
|
|
860
921
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -1063,6 +1124,16 @@ const AdminAgentsApiFactory = function (configuration, basePath, axios) {
|
|
|
1063
1124
|
adminAgentsList(requestParameters, options) {
|
|
1064
1125
|
return localVarFp.adminAgentsList(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1065
1126
|
},
|
|
1127
|
+
/**
|
|
1128
|
+
* For a trusted component of your organization, such as an AI gateway\'s spend callback or an orchestrator, that sees the agent\'s model calls. Adds the tokens and cost to the agent\'s budget windows (current UTC hour, day and month), exactly like POST /agents/me/usage from the agent itself. The report adds no API call and is accepted even when the budget is spent.
|
|
1129
|
+
* @summary Report model tokens and cost for an agent
|
|
1130
|
+
* @param {AdminAgentsApiAdminAgentsReportUsageRequest} requestParameters Request parameters.
|
|
1131
|
+
* @param {*} [options] Override http request option.
|
|
1132
|
+
* @throws {RequiredError}
|
|
1133
|
+
*/
|
|
1134
|
+
adminAgentsReportUsage(requestParameters, options) {
|
|
1135
|
+
return localVarFp.adminAgentsReportUsage(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsReportUsageRequest, options).then((request) => request(axios, basePath));
|
|
1136
|
+
},
|
|
1066
1137
|
/**
|
|
1067
1138
|
*
|
|
1068
1139
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -1244,6 +1315,17 @@ class AdminAgentsApi extends base_1.BaseAPI {
|
|
|
1244
1315
|
adminAgentsList(requestParameters, options) {
|
|
1245
1316
|
return (0, exports.AdminAgentsApiFp)(this.configuration).adminAgentsList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1246
1317
|
}
|
|
1318
|
+
/**
|
|
1319
|
+
* For a trusted component of your organization, such as an AI gateway\'s spend callback or an orchestrator, that sees the agent\'s model calls. Adds the tokens and cost to the agent\'s budget windows (current UTC hour, day and month), exactly like POST /agents/me/usage from the agent itself. The report adds no API call and is accepted even when the budget is spent.
|
|
1320
|
+
* @summary Report model tokens and cost for an agent
|
|
1321
|
+
* @param {AdminAgentsApiAdminAgentsReportUsageRequest} requestParameters Request parameters.
|
|
1322
|
+
* @param {*} [options] Override http request option.
|
|
1323
|
+
* @throws {RequiredError}
|
|
1324
|
+
* @memberof AdminAgentsApi
|
|
1325
|
+
*/
|
|
1326
|
+
adminAgentsReportUsage(requestParameters, options) {
|
|
1327
|
+
return (0, exports.AdminAgentsApiFp)(this.configuration).adminAgentsReportUsage(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsReportUsageRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1328
|
+
}
|
|
1247
1329
|
/**
|
|
1248
1330
|
*
|
|
1249
1331
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -27,19 +27,23 @@ export declare const AdminEmailApiAxiosParamCreator: (configuration?: Configurat
|
|
|
27
27
|
* @summary Remove the custom email template so the built-in default is used
|
|
28
28
|
* @param {string} orgId
|
|
29
29
|
* @param {string} type
|
|
30
|
+
* @param {string} [locale]
|
|
31
|
+
* @param {string} [clientId]
|
|
30
32
|
* @param {*} [options] Override http request option.
|
|
31
33
|
* @throws {RequiredError}
|
|
32
34
|
*/
|
|
33
|
-
adminEmailTemplatesDelete: (orgId: string, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
adminEmailTemplatesDelete: (orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
36
|
/**
|
|
35
37
|
*
|
|
36
38
|
* @summary Get an email template (custom or built-in default)
|
|
37
39
|
* @param {string} orgId
|
|
38
40
|
* @param {string} type
|
|
41
|
+
* @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
42
|
+
* @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
|
|
39
43
|
* @param {*} [options] Override http request option.
|
|
40
44
|
* @throws {RequiredError}
|
|
41
45
|
*/
|
|
42
|
-
adminEmailTemplatesGet: (orgId: string, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
+
adminEmailTemplatesGet: (orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
47
|
/**
|
|
44
48
|
*
|
|
45
49
|
* @summary List every email template type with its current (custom or built-in) template
|
|
@@ -58,7 +62,7 @@ export declare const AdminEmailApiAxiosParamCreator: (configuration?: Configurat
|
|
|
58
62
|
*/
|
|
59
63
|
adminEmailTemplatesPreview: (orgId: string, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
64
|
/**
|
|
61
|
-
*
|
|
65
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
62
66
|
* @summary Create or replace the custom email template for a type
|
|
63
67
|
* @param {string} orgId
|
|
64
68
|
* @param {string} type
|
|
@@ -86,19 +90,23 @@ export declare const AdminEmailApiFp: (configuration?: Configuration) => {
|
|
|
86
90
|
* @summary Remove the custom email template so the built-in default is used
|
|
87
91
|
* @param {string} orgId
|
|
88
92
|
* @param {string} type
|
|
93
|
+
* @param {string} [locale]
|
|
94
|
+
* @param {string} [clientId]
|
|
89
95
|
* @param {*} [options] Override http request option.
|
|
90
96
|
* @throws {RequiredError}
|
|
91
97
|
*/
|
|
92
|
-
adminEmailTemplatesDelete(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
|
|
98
|
+
adminEmailTemplatesDelete(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
|
|
93
99
|
/**
|
|
94
100
|
*
|
|
95
101
|
* @summary Get an email template (custom or built-in default)
|
|
96
102
|
* @param {string} orgId
|
|
97
103
|
* @param {string} type
|
|
104
|
+
* @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
105
|
+
* @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
|
|
98
106
|
* @param {*} [options] Override http request option.
|
|
99
107
|
* @throws {RequiredError}
|
|
100
108
|
*/
|
|
101
|
-
adminEmailTemplatesGet(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>>;
|
|
109
|
+
adminEmailTemplatesGet(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>>;
|
|
102
110
|
/**
|
|
103
111
|
*
|
|
104
112
|
* @summary List every email template type with its current (custom or built-in) template
|
|
@@ -117,7 +125,7 @@ export declare const AdminEmailApiFp: (configuration?: Configuration) => {
|
|
|
117
125
|
*/
|
|
118
126
|
adminEmailTemplatesPreview(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminEmailTemplatesPreviewResponse>>;
|
|
119
127
|
/**
|
|
120
|
-
*
|
|
128
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
121
129
|
* @summary Create or replace the custom email template for a type
|
|
122
130
|
* @param {string} orgId
|
|
123
131
|
* @param {string} type
|
|
@@ -173,7 +181,7 @@ export declare const AdminEmailApiFactory: (configuration?: Configuration, baseP
|
|
|
173
181
|
*/
|
|
174
182
|
adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminEmailTemplatesPreviewResponse>;
|
|
175
183
|
/**
|
|
176
|
-
*
|
|
184
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
177
185
|
* @summary Create or replace the custom email template for a type
|
|
178
186
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
179
187
|
* @param {*} [options] Override http request option.
|
|
@@ -232,7 +240,7 @@ export interface AdminEmailApiInterface {
|
|
|
232
240
|
*/
|
|
233
241
|
adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminEmailTemplatesPreviewResponse>;
|
|
234
242
|
/**
|
|
235
|
-
*
|
|
243
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
236
244
|
* @summary Create or replace the custom email template for a type
|
|
237
245
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
238
246
|
* @param {*} [options] Override http request option.
|
|
@@ -268,6 +276,18 @@ export interface AdminEmailApiAdminEmailTemplatesDeleteRequest {
|
|
|
268
276
|
* @memberof AdminEmailApiAdminEmailTemplatesDelete
|
|
269
277
|
*/
|
|
270
278
|
readonly type: string;
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof AdminEmailApiAdminEmailTemplatesDelete
|
|
283
|
+
*/
|
|
284
|
+
readonly locale?: string;
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof AdminEmailApiAdminEmailTemplatesDelete
|
|
289
|
+
*/
|
|
290
|
+
readonly clientId?: string;
|
|
271
291
|
}
|
|
272
292
|
/**
|
|
273
293
|
* Request parameters for adminEmailTemplatesGet operation in AdminEmailApi.
|
|
@@ -287,6 +307,18 @@ export interface AdminEmailApiAdminEmailTemplatesGetRequest {
|
|
|
287
307
|
* @memberof AdminEmailApiAdminEmailTemplatesGet
|
|
288
308
|
*/
|
|
289
309
|
readonly type: string;
|
|
310
|
+
/**
|
|
311
|
+
* Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
312
|
+
* @type {string}
|
|
313
|
+
* @memberof AdminEmailApiAdminEmailTemplatesGet
|
|
314
|
+
*/
|
|
315
|
+
readonly locale?: string;
|
|
316
|
+
/**
|
|
317
|
+
* Application variant (OAuth client_id); omit for the variant used by every application
|
|
318
|
+
* @type {string}
|
|
319
|
+
* @memberof AdminEmailApiAdminEmailTemplatesGet
|
|
320
|
+
*/
|
|
321
|
+
readonly clientId?: string;
|
|
290
322
|
}
|
|
291
323
|
/**
|
|
292
324
|
* Request parameters for adminEmailTemplatesList operation in AdminEmailApi.
|
|
@@ -402,7 +434,7 @@ export declare class AdminEmailApi extends BaseAPI implements AdminEmailApiInter
|
|
|
402
434
|
*/
|
|
403
435
|
adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminEmailTemplatesPreviewResponse, any, {}>>;
|
|
404
436
|
/**
|
|
405
|
-
*
|
|
437
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
406
438
|
* @summary Create or replace the custom email template for a type
|
|
407
439
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
408
440
|
* @param {*} [options] Override http request option.
|
|
@@ -40,10 +40,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
40
40
|
* @summary Remove the custom email template so the built-in default is used
|
|
41
41
|
* @param {string} orgId
|
|
42
42
|
* @param {string} type
|
|
43
|
+
* @param {string} [locale]
|
|
44
|
+
* @param {string} [clientId]
|
|
43
45
|
* @param {*} [options] Override http request option.
|
|
44
46
|
* @throws {RequiredError}
|
|
45
47
|
*/
|
|
46
|
-
adminEmailTemplatesDelete: (orgId_1, type_1, ...args_1) => __awaiter(this, [orgId_1, type_1, ...args_1], void 0, function* (orgId, type, options = {}) {
|
|
48
|
+
adminEmailTemplatesDelete: (orgId_1, type_1, locale_1, clientId_1, ...args_1) => __awaiter(this, [orgId_1, type_1, locale_1, clientId_1, ...args_1], void 0, function* (orgId, type, locale, clientId, options = {}) {
|
|
47
49
|
// verify required parameter 'orgId' is not null or undefined
|
|
48
50
|
(0, common_1.assertParamExists)('adminEmailTemplatesDelete', 'orgId', orgId);
|
|
49
51
|
// verify required parameter 'type' is not null or undefined
|
|
@@ -65,6 +67,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
65
67
|
// authentication BearerAuth required
|
|
66
68
|
// http bearer authentication required
|
|
67
69
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
70
|
+
if (locale !== undefined) {
|
|
71
|
+
localVarQueryParameter['locale'] = locale;
|
|
72
|
+
}
|
|
73
|
+
if (clientId !== undefined) {
|
|
74
|
+
localVarQueryParameter['client_id'] = clientId;
|
|
75
|
+
}
|
|
68
76
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
69
77
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
70
78
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -78,10 +86,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
78
86
|
* @summary Get an email template (custom or built-in default)
|
|
79
87
|
* @param {string} orgId
|
|
80
88
|
* @param {string} type
|
|
89
|
+
* @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
90
|
+
* @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
|
|
81
91
|
* @param {*} [options] Override http request option.
|
|
82
92
|
* @throws {RequiredError}
|
|
83
93
|
*/
|
|
84
|
-
adminEmailTemplatesGet: (orgId_1, type_1, ...args_1) => __awaiter(this, [orgId_1, type_1, ...args_1], void 0, function* (orgId, type, options = {}) {
|
|
94
|
+
adminEmailTemplatesGet: (orgId_1, type_1, locale_1, clientId_1, ...args_1) => __awaiter(this, [orgId_1, type_1, locale_1, clientId_1, ...args_1], void 0, function* (orgId, type, locale, clientId, options = {}) {
|
|
85
95
|
// verify required parameter 'orgId' is not null or undefined
|
|
86
96
|
(0, common_1.assertParamExists)('adminEmailTemplatesGet', 'orgId', orgId);
|
|
87
97
|
// verify required parameter 'type' is not null or undefined
|
|
@@ -103,6 +113,12 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
103
113
|
// authentication BearerAuth required
|
|
104
114
|
// http bearer authentication required
|
|
105
115
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
116
|
+
if (locale !== undefined) {
|
|
117
|
+
localVarQueryParameter['locale'] = locale;
|
|
118
|
+
}
|
|
119
|
+
if (clientId !== undefined) {
|
|
120
|
+
localVarQueryParameter['client_id'] = clientId;
|
|
121
|
+
}
|
|
106
122
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
107
123
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
108
124
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -184,7 +200,7 @@ const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
184
200
|
};
|
|
185
201
|
}),
|
|
186
202
|
/**
|
|
187
|
-
*
|
|
203
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
188
204
|
* @summary Create or replace the custom email template for a type
|
|
189
205
|
* @param {string} orgId
|
|
190
206
|
* @param {string} type
|
|
@@ -274,13 +290,15 @@ const AdminEmailApiFp = function (configuration) {
|
|
|
274
290
|
* @summary Remove the custom email template so the built-in default is used
|
|
275
291
|
* @param {string} orgId
|
|
276
292
|
* @param {string} type
|
|
293
|
+
* @param {string} [locale]
|
|
294
|
+
* @param {string} [clientId]
|
|
277
295
|
* @param {*} [options] Override http request option.
|
|
278
296
|
* @throws {RequiredError}
|
|
279
297
|
*/
|
|
280
|
-
adminEmailTemplatesDelete(orgId, type, options) {
|
|
298
|
+
adminEmailTemplatesDelete(orgId, type, locale, clientId, options) {
|
|
281
299
|
return __awaiter(this, void 0, void 0, function* () {
|
|
282
300
|
var _a, _b, _c;
|
|
283
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, options);
|
|
301
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, locale, clientId, options);
|
|
284
302
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
285
303
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminEmailApi.adminEmailTemplatesDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
286
304
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -291,13 +309,15 @@ const AdminEmailApiFp = function (configuration) {
|
|
|
291
309
|
* @summary Get an email template (custom or built-in default)
|
|
292
310
|
* @param {string} orgId
|
|
293
311
|
* @param {string} type
|
|
312
|
+
* @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
313
|
+
* @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
|
|
294
314
|
* @param {*} [options] Override http request option.
|
|
295
315
|
* @throws {RequiredError}
|
|
296
316
|
*/
|
|
297
|
-
adminEmailTemplatesGet(orgId, type, options) {
|
|
317
|
+
adminEmailTemplatesGet(orgId, type, locale, clientId, options) {
|
|
298
318
|
return __awaiter(this, void 0, void 0, function* () {
|
|
299
319
|
var _a, _b, _c;
|
|
300
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, options);
|
|
320
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, locale, clientId, options);
|
|
301
321
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
302
322
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminEmailApi.adminEmailTemplatesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
303
323
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -337,7 +357,7 @@ const AdminEmailApiFp = function (configuration) {
|
|
|
337
357
|
});
|
|
338
358
|
},
|
|
339
359
|
/**
|
|
340
|
-
*
|
|
360
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
341
361
|
* @summary Create or replace the custom email template for a type
|
|
342
362
|
* @param {string} orgId
|
|
343
363
|
* @param {string} type
|
|
@@ -388,7 +408,7 @@ const AdminEmailApiFactory = function (configuration, basePath, axios) {
|
|
|
388
408
|
* @throws {RequiredError}
|
|
389
409
|
*/
|
|
390
410
|
adminEmailTemplatesDelete(requestParameters, options) {
|
|
391
|
-
return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
411
|
+
return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
392
412
|
},
|
|
393
413
|
/**
|
|
394
414
|
*
|
|
@@ -398,7 +418,7 @@ const AdminEmailApiFactory = function (configuration, basePath, axios) {
|
|
|
398
418
|
* @throws {RequiredError}
|
|
399
419
|
*/
|
|
400
420
|
adminEmailTemplatesGet(requestParameters, options) {
|
|
401
|
-
return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
421
|
+
return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
402
422
|
},
|
|
403
423
|
/**
|
|
404
424
|
*
|
|
@@ -421,7 +441,7 @@ const AdminEmailApiFactory = function (configuration, basePath, axios) {
|
|
|
421
441
|
return localVarFp.adminEmailTemplatesPreview(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
422
442
|
},
|
|
423
443
|
/**
|
|
424
|
-
*
|
|
444
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
425
445
|
* @summary Create or replace the custom email template for a type
|
|
426
446
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
427
447
|
* @param {*} [options] Override http request option.
|
|
@@ -459,7 +479,7 @@ class AdminEmailApi extends base_1.BaseAPI {
|
|
|
459
479
|
* @memberof AdminEmailApi
|
|
460
480
|
*/
|
|
461
481
|
adminEmailTemplatesDelete(requestParameters, options) {
|
|
462
|
-
return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
482
|
+
return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
463
483
|
}
|
|
464
484
|
/**
|
|
465
485
|
*
|
|
@@ -470,7 +490,7 @@ class AdminEmailApi extends base_1.BaseAPI {
|
|
|
470
490
|
* @memberof AdminEmailApi
|
|
471
491
|
*/
|
|
472
492
|
adminEmailTemplatesGet(requestParameters, options) {
|
|
473
|
-
return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
493
|
+
return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
474
494
|
}
|
|
475
495
|
/**
|
|
476
496
|
*
|
|
@@ -495,7 +515,7 @@ class AdminEmailApi extends base_1.BaseAPI {
|
|
|
495
515
|
return (0, exports.AdminEmailApiFp)(this.configuration).adminEmailTemplatesPreview(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
496
516
|
}
|
|
497
517
|
/**
|
|
498
|
-
*
|
|
518
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
499
519
|
* @summary Create or replace the custom email template for a type
|
|
500
520
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
501
521
|
* @param {*} [options] Override http request option.
|