@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
package/.openapi-generator/FILES
CHANGED
|
@@ -64,6 +64,10 @@ docs/AdminAgentsGenerateTokenResponseData.md
|
|
|
64
64
|
docs/AdminAgentsGetResponse.md
|
|
65
65
|
docs/AdminAgentsGetScopesResponse.md
|
|
66
66
|
docs/AdminAgentsListResponse.md
|
|
67
|
+
docs/AdminAgentsReportUsageRequest.md
|
|
68
|
+
docs/AdminAgentsReportUsageResponse.md
|
|
69
|
+
docs/AdminAgentsReportUsageResponseData.md
|
|
70
|
+
docs/AdminAgentsReportUsageResponseDataRecorded.md
|
|
67
71
|
docs/AdminAgentsRevokeKeyResponse.md
|
|
68
72
|
docs/AdminAgentsRotateCredentialsResponse.md
|
|
69
73
|
docs/AdminAgentsSetScopesRequest.md
|
|
@@ -96,6 +100,8 @@ docs/AdminAuditLogsStatsResponseDataPeriod.md
|
|
|
96
100
|
docs/AdminClientTokensRevokeAllResponse.md
|
|
97
101
|
docs/AdminClientsCimdCheckRequest.md
|
|
98
102
|
docs/AdminClientsCimdCheckResponse.md
|
|
103
|
+
docs/AdminClientsGetBrandingResponse.md
|
|
104
|
+
docs/AdminClientsGetBrandingResponseData.md
|
|
99
105
|
docs/AdminEmailApi.md
|
|
100
106
|
docs/AdminEmailTemplatesListResponse.md
|
|
101
107
|
docs/AdminEmailTemplatesPreviewResponse.md
|
|
@@ -375,6 +381,7 @@ docs/OrganizationRole.md
|
|
|
375
381
|
docs/PaginationMeta.md
|
|
376
382
|
docs/ParResponse.md
|
|
377
383
|
docs/PasskeyEnrollmentStarted.md
|
|
384
|
+
docs/PatchAdminClientsUpdateBrandingResponse.md
|
|
378
385
|
docs/Permission.md
|
|
379
386
|
docs/ProtectedResourceList.md
|
|
380
387
|
docs/ProtectedResourceMetadata.md
|
|
@@ -383,6 +390,8 @@ docs/PutAbacAttributesUpdateResponse.md
|
|
|
383
390
|
docs/PutAbacPoliciesUpdateResponse.md
|
|
384
391
|
docs/PutAdminAgentsUpdateRequest.md
|
|
385
392
|
docs/PutAdminAgentsUpdateResponse.md
|
|
393
|
+
docs/PutAdminClientsUpdateBrandingRequest.md
|
|
394
|
+
docs/PutAdminClientsUpdateBrandingResponse.md
|
|
386
395
|
docs/PutAdminOrgMembersUpdateResponse.md
|
|
387
396
|
docs/PutAdminSettingsAuthenticationUpdateResponse.md
|
|
388
397
|
docs/PutAdminSettingsBrandingUpdateResponse.md
|
|
@@ -400,6 +409,7 @@ docs/RegisteredClientMetadata.md
|
|
|
400
409
|
docs/RemoveUserGroupResponse.md
|
|
401
410
|
docs/RemoveUserPermissionResponse.md
|
|
402
411
|
docs/RemoveUserRoleResponse.md
|
|
412
|
+
docs/ReportAgentUsageResponse.md
|
|
403
413
|
docs/RequestPermissionRequest.md
|
|
404
414
|
docs/RequestPermissionResponse.md
|
|
405
415
|
docs/RevokeAgentTokenRequest.md
|
|
@@ -486,6 +496,10 @@ models/admin-agents-generate-token-response.ts
|
|
|
486
496
|
models/admin-agents-get-response.ts
|
|
487
497
|
models/admin-agents-get-scopes-response.ts
|
|
488
498
|
models/admin-agents-list-response.ts
|
|
499
|
+
models/admin-agents-report-usage-request.ts
|
|
500
|
+
models/admin-agents-report-usage-response-data-recorded.ts
|
|
501
|
+
models/admin-agents-report-usage-response-data.ts
|
|
502
|
+
models/admin-agents-report-usage-response.ts
|
|
489
503
|
models/admin-agents-revoke-key-response.ts
|
|
490
504
|
models/admin-agents-rotate-credentials-response.ts
|
|
491
505
|
models/admin-agents-set-scopes-request.ts
|
|
@@ -517,6 +531,8 @@ models/admin-audit-logs-stats-response.ts
|
|
|
517
531
|
models/admin-client-tokens-revoke-all-response.ts
|
|
518
532
|
models/admin-clients-cimd-check-request.ts
|
|
519
533
|
models/admin-clients-cimd-check-response.ts
|
|
534
|
+
models/admin-clients-get-branding-response-data.ts
|
|
535
|
+
models/admin-clients-get-branding-response.ts
|
|
520
536
|
models/admin-email-templates-list-response.ts
|
|
521
537
|
models/admin-email-templates-preview-response.ts
|
|
522
538
|
models/admin-email-templates-variables-response.ts
|
|
@@ -775,6 +791,7 @@ models/organization.ts
|
|
|
775
791
|
models/pagination-meta.ts
|
|
776
792
|
models/par-response.ts
|
|
777
793
|
models/passkey-enrollment-started.ts
|
|
794
|
+
models/patch-admin-clients-update-branding-response.ts
|
|
778
795
|
models/permission.ts
|
|
779
796
|
models/protected-resource-list.ts
|
|
780
797
|
models/protected-resource-metadata.ts
|
|
@@ -783,6 +800,8 @@ models/put-abac-attributes-update-response.ts
|
|
|
783
800
|
models/put-abac-policies-update-response.ts
|
|
784
801
|
models/put-admin-agents-update-request.ts
|
|
785
802
|
models/put-admin-agents-update-response.ts
|
|
803
|
+
models/put-admin-clients-update-branding-request.ts
|
|
804
|
+
models/put-admin-clients-update-branding-response.ts
|
|
786
805
|
models/put-admin-org-members-update-response.ts
|
|
787
806
|
models/put-admin-settings-authentication-update-response.ts
|
|
788
807
|
models/put-admin-settings-branding-update-response.ts
|
|
@@ -800,6 +819,7 @@ models/registered-client-metadata.ts
|
|
|
800
819
|
models/remove-user-group-response.ts
|
|
801
820
|
models/remove-user-permission-response.ts
|
|
802
821
|
models/remove-user-role-response.ts
|
|
822
|
+
models/report-agent-usage-response.ts
|
|
803
823
|
models/request-permission-request.ts
|
|
804
824
|
models/request-permission-response.ts
|
|
805
825
|
models/revoke-agent-token-request.ts
|
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
> `github.com/lumoauth/lumo-auth-go`), prefer it.
|
|
8
8
|
> Do not edit by hand: changes are overwritten on the next regeneration.
|
|
9
9
|
|
|
10
|
-
## @lumoauth/api-client@1.
|
|
10
|
+
## @lumoauth/api-client@1.4.0
|
|
11
11
|
|
|
12
12
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
13
13
|
|
|
@@ -45,7 +45,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
45
45
|
_published:_
|
|
46
46
|
|
|
47
47
|
```
|
|
48
|
-
npm install @lumoauth/api-client@1.
|
|
48
|
+
npm install @lumoauth/api-client@1.4.0 --save
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
_unPublished (not recommended):_
|
|
@@ -100,6 +100,7 @@ Class | Method | HTTP request | Description
|
|
|
100
100
|
*AdminAgentsApi* | [**adminAgentsGet**](docs/AdminAgentsApi.md#adminagentsget) | **GET** /orgs/{orgId}/api/v1/admin/agents/{agentId} | Get a single agent by ID or agentId
|
|
101
101
|
*AdminAgentsApi* | [**adminAgentsGetScopes**](docs/AdminAgentsApi.md#adminagentsgetscopes) | **GET** /orgs/{orgId}/api/v1/admin/agents/{agentId}/scopes | Get agent scopes/capabilities
|
|
102
102
|
*AdminAgentsApi* | [**adminAgentsList**](docs/AdminAgentsApi.md#adminagentslist) | **GET** /orgs/{orgId}/api/v1/admin/agents | List all agents in the tenant
|
|
103
|
+
*AdminAgentsApi* | [**adminAgentsReportUsage**](docs/AdminAgentsApi.md#adminagentsreportusage) | **POST** /orgs/{orgId}/api/v1/admin/agents/{agentId}/usage | Report model tokens and cost for an agent
|
|
103
104
|
*AdminAgentsApi* | [**adminAgentsRevokeKey**](docs/AdminAgentsApi.md#adminagentsrevokekey) | **POST** /orgs/{orgId}/api/v1/admin/agents/{agentId}/revoke-key | Revoke agent API key (nullify it so it can no longer authenticate)
|
|
104
105
|
*AdminAgentsApi* | [**adminAgentsRotateCredentials**](docs/AdminAgentsApi.md#adminagentsrotatecredentials) | **POST** /orgs/{orgId}/api/v1/admin/agents/{agentId}/rotate-credentials | Rotate agent credentials
|
|
105
106
|
*AdminAgentsApi* | [**adminAgentsSetScopes**](docs/AdminAgentsApi.md#adminagentssetscopes) | **PUT** /orgs/{orgId}/api/v1/admin/agents/{agentId}/scopes | Update agent scopes/capabilities
|
|
@@ -154,6 +155,7 @@ Class | Method | HTTP request | Description
|
|
|
154
155
|
*AdminMfaApi* | [**listUserAuthenticators**](docs/AdminMfaApi.md#listuserauthenticators) | **GET** /orgs/{orgId}/api/v1/admin/users/{userId}/authenticators | List a user\'s authenticators
|
|
155
156
|
*AdminMfaApi* | [**updateMfaPolicy**](docs/AdminMfaApi.md#updatemfapolicy) | **PUT** /orgs/{orgId}/api/v1/admin/policies/mfa | Update the MFA policy
|
|
156
157
|
*AdminOAuthClientsApi* | [**adminClientsCimdCheck**](docs/AdminOAuthClientsApi.md#adminclientscimdcheck) | **POST** /orgs/{orgId}/api/v1/admin/clients/cimd/check | Check a Client ID Metadata Document
|
|
158
|
+
*AdminOAuthClientsApi* | [**adminClientsGetBranding**](docs/AdminOAuthClientsApi.md#adminclientsgetbranding) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Get an OAuth client\'s login and consent page branding
|
|
157
159
|
*AdminOAuthClientsApi* | [**createClient**](docs/AdminOAuthClientsApi.md#createclient) | **POST** /orgs/{orgId}/api/v1/admin/clients | Create an OAuth client
|
|
158
160
|
*AdminOAuthClientsApi* | [**deleteClient**](docs/AdminOAuthClientsApi.md#deleteclient) | **DELETE** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Delete an OAuth client
|
|
159
161
|
*AdminOAuthClientsApi* | [**disableClient**](docs/AdminOAuthClientsApi.md#disableclient) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/disable | Disable an OAuth client
|
|
@@ -161,7 +163,9 @@ Class | Method | HTTP request | Description
|
|
|
161
163
|
*AdminOAuthClientsApi* | [**getClient**](docs/AdminOAuthClientsApi.md#getclient) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Get an OAuth client
|
|
162
164
|
*AdminOAuthClientsApi* | [**listClientScopes**](docs/AdminOAuthClientsApi.md#listclientscopes) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | List the scopes granted to an OAuth client
|
|
163
165
|
*AdminOAuthClientsApi* | [**listClients**](docs/AdminOAuthClientsApi.md#listclients) | **GET** /orgs/{orgId}/api/v1/admin/clients | List OAuth clients
|
|
166
|
+
*AdminOAuthClientsApi* | [**patchAdminClientsUpdateBranding**](docs/AdminOAuthClientsApi.md#patchadminclientsupdatebranding) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Change keys of an OAuth client\'s login and/or consent page branding
|
|
164
167
|
*AdminOAuthClientsApi* | [**patchClient**](docs/AdminOAuthClientsApi.md#patchclient) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client
|
|
168
|
+
*AdminOAuthClientsApi* | [**putAdminClientsUpdateBranding**](docs/AdminOAuthClientsApi.md#putadminclientsupdatebranding) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Replace an OAuth client\'s login and/or consent page branding
|
|
165
169
|
*AdminOAuthClientsApi* | [**rotateClientSecret**](docs/AdminOAuthClientsApi.md#rotateclientsecret) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret
|
|
166
170
|
*AdminOAuthClientsApi* | [**setClientScopes**](docs/AdminOAuthClientsApi.md#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client
|
|
167
171
|
*AdminOAuthClientsApi* | [**updateClient**](docs/AdminOAuthClientsApi.md#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Replace an OAuth client
|
|
@@ -310,6 +314,7 @@ Class | Method | HTTP request | Description
|
|
|
310
314
|
*AgentsApi* | [**getApprovalStatus**](docs/AgentsApi.md#getapprovalstatus) | **GET** /orgs/{orgId}/api/v1/agents/me/approvals/{token}/status |
|
|
311
315
|
*AgentsApi* | [**getCurrentAgent**](docs/AgentsApi.md#getcurrentagent) | **GET** /orgs/{orgId}/api/v1/agents/me | Get details about the currently authenticated agent
|
|
312
316
|
*AgentsApi* | [**registerAgent**](docs/AgentsApi.md#registeragent) | **POST** /orgs/{orgId}/api/v1/agents/register | Register (or re-register) an agent
|
|
317
|
+
*AgentsApi* | [**reportAgentUsage**](docs/AgentsApi.md#reportagentusage) | **POST** /orgs/{orgId}/api/v1/agents/me/usage | Report the model tokens and cost that the agent used
|
|
313
318
|
*AgentsApi* | [**verifyAgentCard**](docs/AgentsApi.md#verifyagentcard) | **POST** /orgs/{orgId}/api/v1/agents/agent-card/verify | Verify a signed A2A agent card
|
|
314
319
|
*AuthorizationApi* | [**checkAbac**](docs/AuthorizationApi.md#checkabac) | **POST** /orgs/{orgId}/api/v1/abac/check | Evaluate an ABAC policy decision for the caller
|
|
315
320
|
*AuthorizationApi* | [**checkAbacBulk**](docs/AuthorizationApi.md#checkabacbulk) | **POST** /orgs/{orgId}/api/v1/abac/check-bulk | Evaluate up to 100 ABAC checks for the caller in one call
|
|
@@ -366,7 +371,6 @@ Class | Method | HTTP request | Description
|
|
|
366
371
|
*OAuthApi* | [**getOrgSelection**](docs/OAuthApi.md#getorgselection) | **GET** /orgs/{orgId}/api/v1/oauth/org-select | Organization selector page
|
|
367
372
|
*OAuthApi* | [**introspect**](docs/OAuthApi.md#introspect) | **POST** /orgs/{orgId}/api/v1/oauth/introspect | Token introspection (RFC 7662)
|
|
368
373
|
*OAuthApi* | [**par**](docs/OAuthApi.md#par) | **POST** /orgs/{orgId}/api/v1/oauth/par | Pushed authorization request (RFC 9126)
|
|
369
|
-
*OAuthApi* | [**passkeyLogin**](docs/OAuthApi.md#passkeylogin) | **GET** /orgs/{orgId}/api/v1/oauth/passkey-login | Passkey login entry point
|
|
370
374
|
*OAuthApi* | [**registerClient**](docs/OAuthApi.md#registerclient) | **POST** /orgs/{orgId}/api/v1/connect/register | Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
371
375
|
*OAuthApi* | [**revoke**](docs/OAuthApi.md#revoke) | **POST** /orgs/{orgId}/api/v1/oauth/revoke | Token revocation (RFC 7009)
|
|
372
376
|
*OAuthApi* | [**socialCallback**](docs/OAuthApi.md#socialcallback) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback
|
|
@@ -374,7 +378,6 @@ Class | Method | HTTP request | Description
|
|
|
374
378
|
*OAuthApi* | [**socialLogin**](docs/OAuthApi.md#sociallogin) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider} | Start social / enterprise identity-provider login
|
|
375
379
|
*OAuthApi* | [**submitAuthorization**](docs/OAuthApi.md#submitauthorization) | **POST** /orgs/{orgId}/api/v1/oauth/authorize | OAuth 2.1 / OIDC authorization endpoint (form submission)
|
|
376
380
|
*OAuthApi* | [**submitDeviceVerification**](docs/OAuthApi.md#submitdeviceverification) | **POST** /orgs/{orgId}/api/v1/oauth/device | Submit device verification
|
|
377
|
-
*OAuthApi* | [**submitLogin**](docs/OAuthApi.md#submitlogin) | **POST** /orgs/{orgId}/api/v1/oauth/login/submit | Hosted login form submission
|
|
378
381
|
*OAuthApi* | [**submitLoginJson**](docs/OAuthApi.md#submitloginjson) | **POST** /orgs/{orgId}/api/v1/oauth/login/json | Programmatic (JSON) login for the authorization flow
|
|
379
382
|
*OAuthApi* | [**submitOrgSelection**](docs/OAuthApi.md#submitorgselection) | **POST** /orgs/{orgId}/api/v1/oauth/org-select | Submit organization selection
|
|
380
383
|
*OAuthApi* | [**token**](docs/OAuthApi.md#token) | **POST** /orgs/{orgId}/api/v1/oauth/token | OAuth 2.1 token endpoint
|
|
@@ -424,6 +427,10 @@ Class | Method | HTTP request | Description
|
|
|
424
427
|
- [AdminAgentsGetResponse](docs/AdminAgentsGetResponse.md)
|
|
425
428
|
- [AdminAgentsGetScopesResponse](docs/AdminAgentsGetScopesResponse.md)
|
|
426
429
|
- [AdminAgentsListResponse](docs/AdminAgentsListResponse.md)
|
|
430
|
+
- [AdminAgentsReportUsageRequest](docs/AdminAgentsReportUsageRequest.md)
|
|
431
|
+
- [AdminAgentsReportUsageResponse](docs/AdminAgentsReportUsageResponse.md)
|
|
432
|
+
- [AdminAgentsReportUsageResponseData](docs/AdminAgentsReportUsageResponseData.md)
|
|
433
|
+
- [AdminAgentsReportUsageResponseDataRecorded](docs/AdminAgentsReportUsageResponseDataRecorded.md)
|
|
427
434
|
- [AdminAgentsRevokeKeyResponse](docs/AdminAgentsRevokeKeyResponse.md)
|
|
428
435
|
- [AdminAgentsRotateCredentialsResponse](docs/AdminAgentsRotateCredentialsResponse.md)
|
|
429
436
|
- [AdminAgentsSetScopesRequest](docs/AdminAgentsSetScopesRequest.md)
|
|
@@ -455,6 +462,8 @@ Class | Method | HTTP request | Description
|
|
|
455
462
|
- [AdminClientTokensRevokeAllResponse](docs/AdminClientTokensRevokeAllResponse.md)
|
|
456
463
|
- [AdminClientsCimdCheckRequest](docs/AdminClientsCimdCheckRequest.md)
|
|
457
464
|
- [AdminClientsCimdCheckResponse](docs/AdminClientsCimdCheckResponse.md)
|
|
465
|
+
- [AdminClientsGetBrandingResponse](docs/AdminClientsGetBrandingResponse.md)
|
|
466
|
+
- [AdminClientsGetBrandingResponseData](docs/AdminClientsGetBrandingResponseData.md)
|
|
458
467
|
- [AdminEmailTemplatesListResponse](docs/AdminEmailTemplatesListResponse.md)
|
|
459
468
|
- [AdminEmailTemplatesPreviewResponse](docs/AdminEmailTemplatesPreviewResponse.md)
|
|
460
469
|
- [AdminEmailTemplatesVariablesResponse](docs/AdminEmailTemplatesVariablesResponse.md)
|
|
@@ -712,6 +721,7 @@ Class | Method | HTTP request | Description
|
|
|
712
721
|
- [PaginationMeta](docs/PaginationMeta.md)
|
|
713
722
|
- [ParResponse](docs/ParResponse.md)
|
|
714
723
|
- [PasskeyEnrollmentStarted](docs/PasskeyEnrollmentStarted.md)
|
|
724
|
+
- [PatchAdminClientsUpdateBrandingResponse](docs/PatchAdminClientsUpdateBrandingResponse.md)
|
|
715
725
|
- [Permission](docs/Permission.md)
|
|
716
726
|
- [ProtectedResourceList](docs/ProtectedResourceList.md)
|
|
717
727
|
- [ProtectedResourceMetadata](docs/ProtectedResourceMetadata.md)
|
|
@@ -720,6 +730,8 @@ Class | Method | HTTP request | Description
|
|
|
720
730
|
- [PutAbacPoliciesUpdateResponse](docs/PutAbacPoliciesUpdateResponse.md)
|
|
721
731
|
- [PutAdminAgentsUpdateRequest](docs/PutAdminAgentsUpdateRequest.md)
|
|
722
732
|
- [PutAdminAgentsUpdateResponse](docs/PutAdminAgentsUpdateResponse.md)
|
|
733
|
+
- [PutAdminClientsUpdateBrandingRequest](docs/PutAdminClientsUpdateBrandingRequest.md)
|
|
734
|
+
- [PutAdminClientsUpdateBrandingResponse](docs/PutAdminClientsUpdateBrandingResponse.md)
|
|
723
735
|
- [PutAdminOrgMembersUpdateResponse](docs/PutAdminOrgMembersUpdateResponse.md)
|
|
724
736
|
- [PutAdminSettingsAuthenticationUpdateResponse](docs/PutAdminSettingsAuthenticationUpdateResponse.md)
|
|
725
737
|
- [PutAdminSettingsBrandingUpdateResponse](docs/PutAdminSettingsBrandingUpdateResponse.md)
|
|
@@ -737,6 +749,7 @@ Class | Method | HTTP request | Description
|
|
|
737
749
|
- [RemoveUserGroupResponse](docs/RemoveUserGroupResponse.md)
|
|
738
750
|
- [RemoveUserPermissionResponse](docs/RemoveUserPermissionResponse.md)
|
|
739
751
|
- [RemoveUserRoleResponse](docs/RemoveUserRoleResponse.md)
|
|
752
|
+
- [ReportAgentUsageResponse](docs/ReportAgentUsageResponse.md)
|
|
740
753
|
- [RequestPermissionRequest](docs/RequestPermissionRequest.md)
|
|
741
754
|
- [RequestPermissionResponse](docs/RequestPermissionResponse.md)
|
|
742
755
|
- [RevokeAgentTokenRequest](docs/RevokeAgentTokenRequest.md)
|
package/api/admin-agents-api.ts
CHANGED
|
@@ -48,6 +48,10 @@ import type { AdminAgentsGetScopesResponse } from '../models';
|
|
|
48
48
|
// @ts-ignore
|
|
49
49
|
import type { AdminAgentsListResponse } from '../models';
|
|
50
50
|
// @ts-ignore
|
|
51
|
+
import type { AdminAgentsReportUsageRequest } from '../models';
|
|
52
|
+
// @ts-ignore
|
|
53
|
+
import type { AdminAgentsReportUsageResponse } from '../models';
|
|
54
|
+
// @ts-ignore
|
|
51
55
|
import type { AdminAgentsRevokeKeyResponse } from '../models';
|
|
52
56
|
// @ts-ignore
|
|
53
57
|
import type { AdminAgentsRotateCredentialsResponse } from '../models';
|
|
@@ -562,6 +566,57 @@ export const AdminAgentsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
562
566
|
options: localVarRequestOptions,
|
|
563
567
|
};
|
|
564
568
|
},
|
|
569
|
+
/**
|
|
570
|
+
* 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.
|
|
571
|
+
* @summary Report model tokens and cost for an agent
|
|
572
|
+
* @param {string} orgId
|
|
573
|
+
* @param {string} agentId
|
|
574
|
+
* @param {AdminAgentsReportUsageRequest} adminAgentsReportUsageRequest
|
|
575
|
+
* @param {*} [options] Override http request option.
|
|
576
|
+
* @throws {RequiredError}
|
|
577
|
+
*/
|
|
578
|
+
adminAgentsReportUsage: async (orgId: string, agentId: string, adminAgentsReportUsageRequest: AdminAgentsReportUsageRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
579
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
580
|
+
assertParamExists('adminAgentsReportUsage', 'orgId', orgId)
|
|
581
|
+
// verify required parameter 'agentId' is not null or undefined
|
|
582
|
+
assertParamExists('adminAgentsReportUsage', 'agentId', agentId)
|
|
583
|
+
// verify required parameter 'adminAgentsReportUsageRequest' is not null or undefined
|
|
584
|
+
assertParamExists('adminAgentsReportUsage', 'adminAgentsReportUsageRequest', adminAgentsReportUsageRequest)
|
|
585
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/agents/{agentId}/usage`
|
|
586
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
587
|
+
.replace(`{${"agentId"}}`, encodeURIComponent(String(agentId)));
|
|
588
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
589
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
590
|
+
let baseOptions;
|
|
591
|
+
if (configuration) {
|
|
592
|
+
baseOptions = configuration.baseOptions;
|
|
593
|
+
}
|
|
594
|
+
|
|
595
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
596
|
+
const localVarHeaderParameter = {} as any;
|
|
597
|
+
const localVarQueryParameter = {} as any;
|
|
598
|
+
|
|
599
|
+
// authentication ApiKeyAuth required
|
|
600
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration)
|
|
601
|
+
|
|
602
|
+
// authentication BearerAuth required
|
|
603
|
+
// http bearer authentication required
|
|
604
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
609
|
+
|
|
610
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
611
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
612
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
613
|
+
localVarRequestOptions.data = serializeDataIfNeeded(adminAgentsReportUsageRequest, localVarRequestOptions, configuration)
|
|
614
|
+
|
|
615
|
+
return {
|
|
616
|
+
url: toPathString(localVarUrlObj),
|
|
617
|
+
options: localVarRequestOptions,
|
|
618
|
+
};
|
|
619
|
+
},
|
|
565
620
|
/**
|
|
566
621
|
*
|
|
567
622
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -969,6 +1024,21 @@ export const AdminAgentsApiFp = function(configuration?: Configuration) {
|
|
|
969
1024
|
const localVarOperationServerBasePath = operationServerMap['AdminAgentsApi.adminAgentsList']?.[localVarOperationServerIndex]?.url;
|
|
970
1025
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
971
1026
|
},
|
|
1027
|
+
/**
|
|
1028
|
+
* 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.
|
|
1029
|
+
* @summary Report model tokens and cost for an agent
|
|
1030
|
+
* @param {string} orgId
|
|
1031
|
+
* @param {string} agentId
|
|
1032
|
+
* @param {AdminAgentsReportUsageRequest} adminAgentsReportUsageRequest
|
|
1033
|
+
* @param {*} [options] Override http request option.
|
|
1034
|
+
* @throws {RequiredError}
|
|
1035
|
+
*/
|
|
1036
|
+
async adminAgentsReportUsage(orgId: string, agentId: string, adminAgentsReportUsageRequest: AdminAgentsReportUsageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsReportUsageResponse>> {
|
|
1037
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAgentsReportUsage(orgId, agentId, adminAgentsReportUsageRequest, options);
|
|
1038
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1039
|
+
const localVarOperationServerBasePath = operationServerMap['AdminAgentsApi.adminAgentsReportUsage']?.[localVarOperationServerIndex]?.url;
|
|
1040
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1041
|
+
},
|
|
972
1042
|
/**
|
|
973
1043
|
*
|
|
974
1044
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -1162,6 +1232,16 @@ export const AdminAgentsApiFactory = function (configuration?: Configuration, ba
|
|
|
1162
1232
|
adminAgentsList(requestParameters: AdminAgentsApiAdminAgentsListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsListResponse> {
|
|
1163
1233
|
return localVarFp.adminAgentsList(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1164
1234
|
},
|
|
1235
|
+
/**
|
|
1236
|
+
* 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.
|
|
1237
|
+
* @summary Report model tokens and cost for an agent
|
|
1238
|
+
* @param {AdminAgentsApiAdminAgentsReportUsageRequest} requestParameters Request parameters.
|
|
1239
|
+
* @param {*} [options] Override http request option.
|
|
1240
|
+
* @throws {RequiredError}
|
|
1241
|
+
*/
|
|
1242
|
+
adminAgentsReportUsage(requestParameters: AdminAgentsApiAdminAgentsReportUsageRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsReportUsageResponse> {
|
|
1243
|
+
return localVarFp.adminAgentsReportUsage(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsReportUsageRequest, options).then((request) => request(axios, basePath));
|
|
1244
|
+
},
|
|
1165
1245
|
/**
|
|
1166
1246
|
*
|
|
1167
1247
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -1331,6 +1411,16 @@ export interface AdminAgentsApiInterface {
|
|
|
1331
1411
|
*/
|
|
1332
1412
|
adminAgentsList(requestParameters: AdminAgentsApiAdminAgentsListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsListResponse>;
|
|
1333
1413
|
|
|
1414
|
+
/**
|
|
1415
|
+
* 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.
|
|
1416
|
+
* @summary Report model tokens and cost for an agent
|
|
1417
|
+
* @param {AdminAgentsApiAdminAgentsReportUsageRequest} requestParameters Request parameters.
|
|
1418
|
+
* @param {*} [options] Override http request option.
|
|
1419
|
+
* @throws {RequiredError}
|
|
1420
|
+
* @memberof AdminAgentsApiInterface
|
|
1421
|
+
*/
|
|
1422
|
+
adminAgentsReportUsage(requestParameters: AdminAgentsApiAdminAgentsReportUsageRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsReportUsageResponse>;
|
|
1423
|
+
|
|
1334
1424
|
/**
|
|
1335
1425
|
*
|
|
1336
1426
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
|
@@ -1614,6 +1704,34 @@ export interface AdminAgentsApiAdminAgentsListRequest {
|
|
|
1614
1704
|
readonly orgId: string
|
|
1615
1705
|
}
|
|
1616
1706
|
|
|
1707
|
+
/**
|
|
1708
|
+
* Request parameters for adminAgentsReportUsage operation in AdminAgentsApi.
|
|
1709
|
+
* @export
|
|
1710
|
+
* @interface AdminAgentsApiAdminAgentsReportUsageRequest
|
|
1711
|
+
*/
|
|
1712
|
+
export interface AdminAgentsApiAdminAgentsReportUsageRequest {
|
|
1713
|
+
/**
|
|
1714
|
+
*
|
|
1715
|
+
* @type {string}
|
|
1716
|
+
* @memberof AdminAgentsApiAdminAgentsReportUsage
|
|
1717
|
+
*/
|
|
1718
|
+
readonly orgId: string
|
|
1719
|
+
|
|
1720
|
+
/**
|
|
1721
|
+
*
|
|
1722
|
+
* @type {string}
|
|
1723
|
+
* @memberof AdminAgentsApiAdminAgentsReportUsage
|
|
1724
|
+
*/
|
|
1725
|
+
readonly agentId: string
|
|
1726
|
+
|
|
1727
|
+
/**
|
|
1728
|
+
*
|
|
1729
|
+
* @type {AdminAgentsReportUsageRequest}
|
|
1730
|
+
* @memberof AdminAgentsApiAdminAgentsReportUsage
|
|
1731
|
+
*/
|
|
1732
|
+
readonly adminAgentsReportUsageRequest: AdminAgentsReportUsageRequest
|
|
1733
|
+
}
|
|
1734
|
+
|
|
1617
1735
|
/**
|
|
1618
1736
|
* Request parameters for adminAgentsRevokeKey operation in AdminAgentsApi.
|
|
1619
1737
|
* @export
|
|
@@ -1879,6 +1997,18 @@ export class AdminAgentsApi extends BaseAPI implements AdminAgentsApiInterface {
|
|
|
1879
1997
|
return AdminAgentsApiFp(this.configuration).adminAgentsList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1880
1998
|
}
|
|
1881
1999
|
|
|
2000
|
+
/**
|
|
2001
|
+
* 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.
|
|
2002
|
+
* @summary Report model tokens and cost for an agent
|
|
2003
|
+
* @param {AdminAgentsApiAdminAgentsReportUsageRequest} requestParameters Request parameters.
|
|
2004
|
+
* @param {*} [options] Override http request option.
|
|
2005
|
+
* @throws {RequiredError}
|
|
2006
|
+
* @memberof AdminAgentsApi
|
|
2007
|
+
*/
|
|
2008
|
+
public adminAgentsReportUsage(requestParameters: AdminAgentsApiAdminAgentsReportUsageRequest, options?: RawAxiosRequestConfig) {
|
|
2009
|
+
return AdminAgentsApiFp(this.configuration).adminAgentsReportUsage(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsReportUsageRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2010
|
+
}
|
|
2011
|
+
|
|
1882
2012
|
/**
|
|
1883
2013
|
*
|
|
1884
2014
|
* @summary Revoke agent API key (nullify it so it can no longer authenticate)
|
package/api/admin-email-api.ts
CHANGED
|
@@ -42,10 +42,12 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
|
|
|
42
42
|
* @summary Remove the custom email template so the built-in default is used
|
|
43
43
|
* @param {string} orgId
|
|
44
44
|
* @param {string} type
|
|
45
|
+
* @param {string} [locale]
|
|
46
|
+
* @param {string} [clientId]
|
|
45
47
|
* @param {*} [options] Override http request option.
|
|
46
48
|
* @throws {RequiredError}
|
|
47
49
|
*/
|
|
48
|
-
adminEmailTemplatesDelete: async (orgId: string, type: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50
|
+
adminEmailTemplatesDelete: async (orgId: string, type: string, locale?: string, clientId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
49
51
|
// verify required parameter 'orgId' is not null or undefined
|
|
50
52
|
assertParamExists('adminEmailTemplatesDelete', 'orgId', orgId)
|
|
51
53
|
// verify required parameter 'type' is not null or undefined
|
|
@@ -71,6 +73,14 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
|
|
|
71
73
|
// http bearer authentication required
|
|
72
74
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
73
75
|
|
|
76
|
+
if (locale !== undefined) {
|
|
77
|
+
localVarQueryParameter['locale'] = locale;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
if (clientId !== undefined) {
|
|
81
|
+
localVarQueryParameter['client_id'] = clientId;
|
|
82
|
+
}
|
|
83
|
+
|
|
74
84
|
|
|
75
85
|
|
|
76
86
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -87,10 +97,12 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
|
|
|
87
97
|
* @summary Get an email template (custom or built-in default)
|
|
88
98
|
* @param {string} orgId
|
|
89
99
|
* @param {string} type
|
|
100
|
+
* @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
101
|
+
* @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
|
|
90
102
|
* @param {*} [options] Override http request option.
|
|
91
103
|
* @throws {RequiredError}
|
|
92
104
|
*/
|
|
93
|
-
adminEmailTemplatesGet: async (orgId: string, type: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
105
|
+
adminEmailTemplatesGet: async (orgId: string, type: string, locale?: string, clientId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
94
106
|
// verify required parameter 'orgId' is not null or undefined
|
|
95
107
|
assertParamExists('adminEmailTemplatesGet', 'orgId', orgId)
|
|
96
108
|
// verify required parameter 'type' is not null or undefined
|
|
@@ -116,6 +128,14 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
|
|
|
116
128
|
// http bearer authentication required
|
|
117
129
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
118
130
|
|
|
131
|
+
if (locale !== undefined) {
|
|
132
|
+
localVarQueryParameter['locale'] = locale;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (clientId !== undefined) {
|
|
136
|
+
localVarQueryParameter['client_id'] = clientId;
|
|
137
|
+
}
|
|
138
|
+
|
|
119
139
|
|
|
120
140
|
|
|
121
141
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -214,7 +234,7 @@ export const AdminEmailApiAxiosParamCreator = function (configuration?: Configur
|
|
|
214
234
|
};
|
|
215
235
|
},
|
|
216
236
|
/**
|
|
217
|
-
*
|
|
237
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
218
238
|
* @summary Create or replace the custom email template for a type
|
|
219
239
|
* @param {string} orgId
|
|
220
240
|
* @param {string} type
|
|
@@ -318,11 +338,13 @@ export const AdminEmailApiFp = function(configuration?: Configuration) {
|
|
|
318
338
|
* @summary Remove the custom email template so the built-in default is used
|
|
319
339
|
* @param {string} orgId
|
|
320
340
|
* @param {string} type
|
|
341
|
+
* @param {string} [locale]
|
|
342
|
+
* @param {string} [clientId]
|
|
321
343
|
* @param {*} [options] Override http request option.
|
|
322
344
|
* @throws {RequiredError}
|
|
323
345
|
*/
|
|
324
|
-
async adminEmailTemplatesDelete(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>> {
|
|
325
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, options);
|
|
346
|
+
async adminEmailTemplatesDelete(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>> {
|
|
347
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesDelete(orgId, type, locale, clientId, options);
|
|
326
348
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
327
349
|
const localVarOperationServerBasePath = operationServerMap['AdminEmailApi.adminEmailTemplatesDelete']?.[localVarOperationServerIndex]?.url;
|
|
328
350
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -332,11 +354,13 @@ export const AdminEmailApiFp = function(configuration?: Configuration) {
|
|
|
332
354
|
* @summary Get an email template (custom or built-in default)
|
|
333
355
|
* @param {string} orgId
|
|
334
356
|
* @param {string} type
|
|
357
|
+
* @param {string} [locale] Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
358
|
+
* @param {string} [clientId] Application variant (OAuth client_id); omit for the variant used by every application
|
|
335
359
|
* @param {*} [options] Override http request option.
|
|
336
360
|
* @throws {RequiredError}
|
|
337
361
|
*/
|
|
338
|
-
async adminEmailTemplatesGet(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>> {
|
|
339
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, options);
|
|
362
|
+
async adminEmailTemplatesGet(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>> {
|
|
363
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminEmailTemplatesGet(orgId, type, locale, clientId, options);
|
|
340
364
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
341
365
|
const localVarOperationServerBasePath = operationServerMap['AdminEmailApi.adminEmailTemplatesGet']?.[localVarOperationServerIndex]?.url;
|
|
342
366
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -369,7 +393,7 @@ export const AdminEmailApiFp = function(configuration?: Configuration) {
|
|
|
369
393
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
370
394
|
},
|
|
371
395
|
/**
|
|
372
|
-
*
|
|
396
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
373
397
|
* @summary Create or replace the custom email template for a type
|
|
374
398
|
* @param {string} orgId
|
|
375
399
|
* @param {string} type
|
|
@@ -414,7 +438,7 @@ export const AdminEmailApiFactory = function (configuration?: Configuration, bas
|
|
|
414
438
|
* @throws {RequiredError}
|
|
415
439
|
*/
|
|
416
440
|
adminEmailTemplatesDelete(requestParameters: AdminEmailApiAdminEmailTemplatesDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse> {
|
|
417
|
-
return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
441
|
+
return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
418
442
|
},
|
|
419
443
|
/**
|
|
420
444
|
*
|
|
@@ -424,7 +448,7 @@ export const AdminEmailApiFactory = function (configuration?: Configuration, bas
|
|
|
424
448
|
* @throws {RequiredError}
|
|
425
449
|
*/
|
|
426
450
|
adminEmailTemplatesGet(requestParameters: AdminEmailApiAdminEmailTemplatesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailTemplate> {
|
|
427
|
-
return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
451
|
+
return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
428
452
|
},
|
|
429
453
|
/**
|
|
430
454
|
*
|
|
@@ -447,7 +471,7 @@ export const AdminEmailApiFactory = function (configuration?: Configuration, bas
|
|
|
447
471
|
return localVarFp.adminEmailTemplatesPreview(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
448
472
|
},
|
|
449
473
|
/**
|
|
450
|
-
*
|
|
474
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
451
475
|
* @summary Create or replace the custom email template for a type
|
|
452
476
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
453
477
|
* @param {*} [options] Override http request option.
|
|
@@ -516,7 +540,7 @@ export interface AdminEmailApiInterface {
|
|
|
516
540
|
adminEmailTemplatesPreview(requestParameters: AdminEmailApiAdminEmailTemplatesPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminEmailTemplatesPreviewResponse>;
|
|
517
541
|
|
|
518
542
|
/**
|
|
519
|
-
*
|
|
543
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
520
544
|
* @summary Create or replace the custom email template for a type
|
|
521
545
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
522
546
|
* @param {*} [options] Override http request option.
|
|
@@ -556,6 +580,20 @@ export interface AdminEmailApiAdminEmailTemplatesDeleteRequest {
|
|
|
556
580
|
* @memberof AdminEmailApiAdminEmailTemplatesDelete
|
|
557
581
|
*/
|
|
558
582
|
readonly type: string
|
|
583
|
+
|
|
584
|
+
/**
|
|
585
|
+
*
|
|
586
|
+
* @type {string}
|
|
587
|
+
* @memberof AdminEmailApiAdminEmailTemplatesDelete
|
|
588
|
+
*/
|
|
589
|
+
readonly locale?: string
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @type {string}
|
|
594
|
+
* @memberof AdminEmailApiAdminEmailTemplatesDelete
|
|
595
|
+
*/
|
|
596
|
+
readonly clientId?: string
|
|
559
597
|
}
|
|
560
598
|
|
|
561
599
|
/**
|
|
@@ -577,6 +615,20 @@ export interface AdminEmailApiAdminEmailTemplatesGetRequest {
|
|
|
577
615
|
* @memberof AdminEmailApiAdminEmailTemplatesGet
|
|
578
616
|
*/
|
|
579
617
|
readonly type: string
|
|
618
|
+
|
|
619
|
+
/**
|
|
620
|
+
* Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language
|
|
621
|
+
* @type {string}
|
|
622
|
+
* @memberof AdminEmailApiAdminEmailTemplatesGet
|
|
623
|
+
*/
|
|
624
|
+
readonly locale?: string
|
|
625
|
+
|
|
626
|
+
/**
|
|
627
|
+
* Application variant (OAuth client_id); omit for the variant used by every application
|
|
628
|
+
* @type {string}
|
|
629
|
+
* @memberof AdminEmailApiAdminEmailTemplatesGet
|
|
630
|
+
*/
|
|
631
|
+
readonly clientId?: string
|
|
580
632
|
}
|
|
581
633
|
|
|
582
634
|
/**
|
|
@@ -672,7 +724,7 @@ export class AdminEmailApi extends BaseAPI implements AdminEmailApiInterface {
|
|
|
672
724
|
* @memberof AdminEmailApi
|
|
673
725
|
*/
|
|
674
726
|
public adminEmailTemplatesDelete(requestParameters: AdminEmailApiAdminEmailTemplatesDeleteRequest, options?: RawAxiosRequestConfig) {
|
|
675
|
-
return AdminEmailApiFp(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
727
|
+
return AdminEmailApiFp(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
676
728
|
}
|
|
677
729
|
|
|
678
730
|
/**
|
|
@@ -684,7 +736,7 @@ export class AdminEmailApi extends BaseAPI implements AdminEmailApiInterface {
|
|
|
684
736
|
* @memberof AdminEmailApi
|
|
685
737
|
*/
|
|
686
738
|
public adminEmailTemplatesGet(requestParameters: AdminEmailApiAdminEmailTemplatesGetRequest, options?: RawAxiosRequestConfig) {
|
|
687
|
-
return AdminEmailApiFp(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
739
|
+
return AdminEmailApiFp(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
688
740
|
}
|
|
689
741
|
|
|
690
742
|
/**
|
|
@@ -712,7 +764,7 @@ export class AdminEmailApi extends BaseAPI implements AdminEmailApiInterface {
|
|
|
712
764
|
}
|
|
713
765
|
|
|
714
766
|
/**
|
|
715
|
-
*
|
|
767
|
+
* Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
716
768
|
* @summary Create or replace the custom email template for a type
|
|
717
769
|
* @param {AdminEmailApiAdminEmailTemplatesUpsertRequest} requestParameters Request parameters.
|
|
718
770
|
* @param {*} [options] Override http request option.
|