agentbase-web-sdk 2.6.0-fix1
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/LICENSE +0 -0
- package/README.md +41 -0
- package/dist/cjs/sdk.js +13833 -0
- package/dist/cjs/sdk.js.map +1 -0
- package/dist/esm/sdk.js +13805 -0
- package/dist/esm/sdk.js.map +1 -0
- package/dist/iife/sdk.js +17632 -0
- package/package.json +50 -0
- package/types/channel.d.ts +79 -0
- package/types/client.d.ts +289 -0
- package/types/enums/authentication-factor.d.ts +6 -0
- package/types/enums/authenticator-type.d.ts +3 -0
- package/types/enums/browser-permission.d.ts +22 -0
- package/types/enums/browser.d.ts +16 -0
- package/types/enums/credit-card.d.ts +19 -0
- package/types/enums/distillation-message-role.d.ts +6 -0
- package/types/enums/distillation-mode.d.ts +4 -0
- package/types/enums/distillation-tool-status.d.ts +4 -0
- package/types/enums/execution-method.d.ts +9 -0
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/export-job-mode.d.ts +4 -0
- package/types/enums/export-mode.d.ts +3 -0
- package/types/enums/feedback-type.d.ts +5 -0
- package/types/enums/flag.d.ts +197 -0
- package/types/enums/format.d.ts +4 -0
- package/types/enums/image-format.d.ts +9 -0
- package/types/enums/image-gravity.d.ts +11 -0
- package/types/enums/kind.d.ts +6 -0
- package/types/enums/kinds.d.ts +6 -0
- package/types/enums/knowledge-base-data-source-document-import-result-status.d.ts +5 -0
- package/types/enums/memory-access-mode.d.ts +4 -0
- package/types/enums/memory-batch-operation.d.ts +5 -0
- package/types/enums/memory-bulk-delete-item-status.d.ts +4 -0
- package/types/enums/memory-bulk-delete-response-status.d.ts +4 -0
- package/types/enums/memory-handling-policy.d.ts +5 -0
- package/types/enums/memory-message-role.d.ts +5 -0
- package/types/enums/memory-record-kind.d.ts +5 -0
- package/types/enums/memory-record-sensitivity.d.ts +5 -0
- package/types/enums/memory-scope.d.ts +7 -0
- package/types/enums/memory-sensitivity.d.ts +6 -0
- package/types/enums/memory-share-subject-type.d.ts +4 -0
- package/types/enums/o-auth-provider.d.ts +45 -0
- package/types/enums/organization-project-deletion-deletion-status.d.ts +5 -0
- package/types/enums/organization-role.d.ts +8 -0
- package/types/enums/organization-usage-range.d.ts +5 -0
- package/types/enums/outcome.d.ts +6 -0
- package/types/enums/profile-extraction-mode.d.ts +4 -0
- package/types/enums/profile-type.d.ts +4 -0
- package/types/enums/project-deletion-restore-status.d.ts +3 -0
- package/types/enums/project-deletion-result-deletion-status.d.ts +5 -0
- package/types/enums/project-deletion-result-status.d.ts +5 -0
- package/types/enums/record-kind.d.ts +5 -0
- package/types/enums/retention-policy.d.ts +3 -0
- package/types/enums/scope.d.ts +5 -0
- package/types/enums/source-type.d.ts +6 -0
- package/types/enums/status.d.ts +17 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +422 -0
- package/types/enums/transaction-action.d.ts +12 -0
- package/types/enums/validation-status.d.ts +6 -0
- package/types/enums/verification-source.d.ts +5 -0
- package/types/id.d.ts +20 -0
- package/types/index.d.ts +87 -0
- package/types/models.d.ts +2537 -0
- package/types/operator.d.ts +180 -0
- package/types/permission.d.ts +43 -0
- package/types/query.d.ts +442 -0
- package/types/role.d.ts +70 -0
- package/types/service.d.ts +11 -0
- package/types/services/account.d.ts +1267 -0
- package/types/services/ai-gateway.d.ts +738 -0
- package/types/services/avatars.d.ts +320 -0
- package/types/services/databases.d.ts +437 -0
- package/types/services/documents-db.d.ts +405 -0
- package/types/services/functions.d.ts +91 -0
- package/types/services/graphql.d.ts +43 -0
- package/types/services/knowledge-bases.d.ts +117 -0
- package/types/services/llm-gateway.d.ts +282 -0
- package/types/services/locale.d.ts +64 -0
- package/types/services/memory.d.ts +1765 -0
- package/types/services/messaging.d.ts +53 -0
- package/types/services/projects.d.ts +129 -0
- package/types/services/realtime.d.ts +197 -0
- package/types/services/self-hosted-organizations.d.ts +495 -0
- package/types/services/storage.d.ts +259 -0
- package/types/services/tables-db.d.ts +434 -0
- package/types/services/teams.d.ts +341 -0
- package/types/services/vectors-db.d.ts +297 -0
|
@@ -0,0 +1,282 @@
|
|
|
1
|
+
import { Client, type SseStream } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
export declare class LlmGateway {
|
|
4
|
+
client: Client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* Create a chat completion through the LLM Gateway using an OpenAI Chat Completions compatible request. The gateway routes the request by model ID to an active provider, supports optional Server-Sent Events streaming, and records project, model, and Gateway Key usage metrics.
|
|
8
|
+
*
|
|
9
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* @param {string} params.model - Model ID to use for the completion.
|
|
13
|
+
* @param {object[]} params.messages - Provider-native conversation messages. Message fields are forwarded unchanged so text, multimodal, and tool-calling payloads remain supported.
|
|
14
|
+
* @param {number} params.temperature - Sampling temperature (0–2).
|
|
15
|
+
* @param {number} params.maxTokens - Maximum number of tokens to generate.
|
|
16
|
+
* @param {boolean} params.stream - Enable Server-Sent Events (SSE) streaming.
|
|
17
|
+
* @param {object[]} params.tools - OpenAI-compatible tool definitions forwarded to the provider.
|
|
18
|
+
* @param {object|string} params.toolChoice - OpenAI-compatible tool selection policy or forced function selection.
|
|
19
|
+
* @throws {AgentbaseException}
|
|
20
|
+
* @returns {Promise<{}>}
|
|
21
|
+
*/
|
|
22
|
+
createChatCompletion(params: {
|
|
23
|
+
model: string;
|
|
24
|
+
messages: object[];
|
|
25
|
+
temperature?: number;
|
|
26
|
+
maxTokens?: number;
|
|
27
|
+
stream: true;
|
|
28
|
+
tools?: object[];
|
|
29
|
+
toolChoice?: object | 'none' | 'auto' | 'required';
|
|
30
|
+
}): Promise<SseStream>;
|
|
31
|
+
createChatCompletion(params: {
|
|
32
|
+
model: string;
|
|
33
|
+
messages: object[];
|
|
34
|
+
temperature?: number;
|
|
35
|
+
maxTokens?: number;
|
|
36
|
+
stream?: boolean;
|
|
37
|
+
tools?: object[];
|
|
38
|
+
toolChoice?: object | 'none' | 'auto' | 'required';
|
|
39
|
+
}): Promise<{}>;
|
|
40
|
+
/**
|
|
41
|
+
* Create a chat completion through the LLM Gateway using an OpenAI Chat Completions compatible request. The gateway routes the request by model ID to an active provider, supports optional Server-Sent Events streaming, and records project, model, and Gateway Key usage metrics.
|
|
42
|
+
*
|
|
43
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* @param {string} model - Model ID to use for the completion.
|
|
47
|
+
* @param {object[]} messages - Provider-native conversation messages. Message fields are forwarded unchanged so text, multimodal, and tool-calling payloads remain supported.
|
|
48
|
+
* @param {number} temperature - Sampling temperature (0–2).
|
|
49
|
+
* @param {number} maxTokens - Maximum number of tokens to generate.
|
|
50
|
+
* @param {boolean} stream - Enable Server-Sent Events (SSE) streaming.
|
|
51
|
+
* @param {object[]} tools - OpenAI-compatible tool definitions forwarded to the provider.
|
|
52
|
+
* @param {object|string} toolChoice - OpenAI-compatible tool selection policy or forced function selection.
|
|
53
|
+
* @throws {AgentbaseException}
|
|
54
|
+
* @returns {Promise<{}>}
|
|
55
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
56
|
+
*/
|
|
57
|
+
createChatCompletion(model: string, messages: object[], temperature: number | undefined, maxTokens: number | undefined, stream: true, tools?: object[], toolChoice?: object | 'none' | 'auto' | 'required'): Promise<SseStream>;
|
|
58
|
+
createChatCompletion(model: string, messages: object[], temperature?: number, maxTokens?: number, stream?: boolean, tools?: object[], toolChoice?: object | 'none' | 'auto' | 'required'): Promise<{}>;
|
|
59
|
+
/**
|
|
60
|
+
* Generate embeddings for one or more input texts through the LLM Gateway. The request is routed by embedding model ID to an active provider and returns an OpenAI-compatible embeddings response with token usage. Streaming is not supported.
|
|
61
|
+
*
|
|
62
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
63
|
+
*
|
|
64
|
+
*
|
|
65
|
+
* @param {string} params.model - Model ID to use for generating embeddings.
|
|
66
|
+
* @param {string[]} params.input - Array of input texts to embed.
|
|
67
|
+
* @throws {AgentbaseException}
|
|
68
|
+
* @returns {Promise<Models.LlmGatewayEmbeddingResponse>}
|
|
69
|
+
*/
|
|
70
|
+
createEmbeddings(params: {
|
|
71
|
+
model: string;
|
|
72
|
+
input: string[];
|
|
73
|
+
}): Promise<Models.LlmGatewayEmbeddingResponse>;
|
|
74
|
+
/**
|
|
75
|
+
* Generate embeddings for one or more input texts through the LLM Gateway. The request is routed by embedding model ID to an active provider and returns an OpenAI-compatible embeddings response with token usage. Streaming is not supported.
|
|
76
|
+
*
|
|
77
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @param {string} model - Model ID to use for generating embeddings.
|
|
81
|
+
* @param {string[]} input - Array of input texts to embed.
|
|
82
|
+
* @throws {AgentbaseException}
|
|
83
|
+
* @returns {Promise<Models.LlmGatewayEmbeddingResponse>}
|
|
84
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
85
|
+
*/
|
|
86
|
+
createEmbeddings(model: string, input: string[]): Promise<Models.LlmGatewayEmbeddingResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* Create a message through the LLM Gateway using an Anthropic Messages compatible request. Anthropic-format requests prefer Anthropic providers during routing, support optional Server-Sent Events streaming, and fall back to the general model route when needed.
|
|
89
|
+
*
|
|
90
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @param {string} params.model - Model ID to use.
|
|
94
|
+
* @param {object[]} params.messages - Provider-native conversation messages. Message fields are forwarded unchanged so text, multimodal, and tool-calling payloads remain supported.
|
|
95
|
+
* @param {number} params.maxTokens - Maximum number of tokens to generate. Defaults to 1024.
|
|
96
|
+
* @param {string} params.system - System prompt. Prepended as a system-role message.
|
|
97
|
+
* @param {number} params.temperature - Sampling temperature (0–1).
|
|
98
|
+
* @param {boolean} params.stream - Enable OpenAI-compatible Server-Sent Events (SSE) streaming.
|
|
99
|
+
* @throws {AgentbaseException}
|
|
100
|
+
* @returns {Promise<{}>}
|
|
101
|
+
*/
|
|
102
|
+
createMessage(params: {
|
|
103
|
+
model: string;
|
|
104
|
+
messages: object[];
|
|
105
|
+
maxTokens: number;
|
|
106
|
+
system?: string;
|
|
107
|
+
temperature?: number;
|
|
108
|
+
stream: true;
|
|
109
|
+
}): Promise<SseStream>;
|
|
110
|
+
createMessage(params: {
|
|
111
|
+
model: string;
|
|
112
|
+
messages: object[];
|
|
113
|
+
maxTokens: number;
|
|
114
|
+
system?: string;
|
|
115
|
+
temperature?: number;
|
|
116
|
+
stream?: boolean;
|
|
117
|
+
}): Promise<{}>;
|
|
118
|
+
/**
|
|
119
|
+
* Create a message through the LLM Gateway using an Anthropic Messages compatible request. Anthropic-format requests prefer Anthropic providers during routing, support optional Server-Sent Events streaming, and fall back to the general model route when needed.
|
|
120
|
+
*
|
|
121
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
122
|
+
*
|
|
123
|
+
*
|
|
124
|
+
* @param {string} model - Model ID to use.
|
|
125
|
+
* @param {object[]} messages - Provider-native conversation messages. Message fields are forwarded unchanged so text, multimodal, and tool-calling payloads remain supported.
|
|
126
|
+
* @param {number} maxTokens - Maximum number of tokens to generate. Defaults to 1024.
|
|
127
|
+
* @param {string} system - System prompt. Prepended as a system-role message.
|
|
128
|
+
* @param {number} temperature - Sampling temperature (0–1).
|
|
129
|
+
* @param {boolean} stream - Enable OpenAI-compatible Server-Sent Events (SSE) streaming.
|
|
130
|
+
* @throws {AgentbaseException}
|
|
131
|
+
* @returns {Promise<{}>}
|
|
132
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
133
|
+
*/
|
|
134
|
+
createMessage(model: string, messages: object[], maxTokens: number, system: string | undefined, temperature: number | undefined, stream: true): Promise<SseStream>;
|
|
135
|
+
createMessage(model: string, messages: object[], maxTokens: number, system?: string, temperature?: number, stream?: boolean): Promise<{}>;
|
|
136
|
+
/**
|
|
137
|
+
* Get a list of models available through the configured and active LLM Gateway providers. The response deduplicates configured model IDs and includes provider ownership, capabilities, and active status.
|
|
138
|
+
*
|
|
139
|
+
*
|
|
140
|
+
* @throws {AgentbaseException}
|
|
141
|
+
* @returns {Promise<Models.LlmGatewayModelList>}
|
|
142
|
+
*/
|
|
143
|
+
listModels(): Promise<Models.LlmGatewayModelList>;
|
|
144
|
+
/**
|
|
145
|
+
* Get details for a specific model available through the LLM Gateway. The model must be declared by an active provider, either as an exact supported model ID or through a wildcard provider route.
|
|
146
|
+
*
|
|
147
|
+
*
|
|
148
|
+
* @param {string} params.modelId - Model ID.
|
|
149
|
+
* @throws {AgentbaseException}
|
|
150
|
+
* @returns {Promise<Models.LlmGatewayModel>}
|
|
151
|
+
*/
|
|
152
|
+
getModel(params: {
|
|
153
|
+
modelId: string;
|
|
154
|
+
}): Promise<Models.LlmGatewayModel>;
|
|
155
|
+
/**
|
|
156
|
+
* Get details for a specific model available through the LLM Gateway. The model must be declared by an active provider, either as an exact supported model ID or through a wildcard provider route.
|
|
157
|
+
*
|
|
158
|
+
*
|
|
159
|
+
* @param {string} modelId - Model ID.
|
|
160
|
+
* @throws {AgentbaseException}
|
|
161
|
+
* @returns {Promise<Models.LlmGatewayModel>}
|
|
162
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
163
|
+
*/
|
|
164
|
+
getModel(modelId: string): Promise<Models.LlmGatewayModel>;
|
|
165
|
+
/**
|
|
166
|
+
* Rerank documents by relevance to a query through the LLM Gateway. The response returns ranked document indexes, relevance scores, optional document text, and token usage for the rerank request. Streaming is not supported.
|
|
167
|
+
*
|
|
168
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
169
|
+
*
|
|
170
|
+
*
|
|
171
|
+
* @param {string} params.model - Rerank model ID.
|
|
172
|
+
* @param {string} params.query - Query text to rank documents against.
|
|
173
|
+
* @param {string[]} params.documents - Documents to rerank.
|
|
174
|
+
* @param {number} params.topN - Return only the top N results.
|
|
175
|
+
* @param {boolean} params.returnDocuments - Include document text in the response.
|
|
176
|
+
* @throws {AgentbaseException}
|
|
177
|
+
* @returns {Promise<Models.LlmGatewayRerankResponse>}
|
|
178
|
+
*/
|
|
179
|
+
createRerank(params: {
|
|
180
|
+
model: string;
|
|
181
|
+
query: string;
|
|
182
|
+
documents: string[];
|
|
183
|
+
topN?: number;
|
|
184
|
+
returnDocuments?: boolean;
|
|
185
|
+
}): Promise<Models.LlmGatewayRerankResponse>;
|
|
186
|
+
/**
|
|
187
|
+
* Rerank documents by relevance to a query through the LLM Gateway. The response returns ranked document indexes, relevance scores, optional document text, and token usage for the rerank request. Streaming is not supported.
|
|
188
|
+
*
|
|
189
|
+
* Pass an `x-provider-key` header to bring your own upstream API key (BYOK) instead of the provider's stored key. If the request is authenticated with a Gateway Key whose `allowedModels` doesn't include the requested model, the endpoint returns a 403 `GENERAL_ACCESS_FORBIDDEN` error.
|
|
190
|
+
*
|
|
191
|
+
*
|
|
192
|
+
* @param {string} model - Rerank model ID.
|
|
193
|
+
* @param {string} query - Query text to rank documents against.
|
|
194
|
+
* @param {string[]} documents - Documents to rerank.
|
|
195
|
+
* @param {number} topN - Return only the top N results.
|
|
196
|
+
* @param {boolean} returnDocuments - Include document text in the response.
|
|
197
|
+
* @throws {AgentbaseException}
|
|
198
|
+
* @returns {Promise<Models.LlmGatewayRerankResponse>}
|
|
199
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
200
|
+
*/
|
|
201
|
+
createRerank(model: string, query: string, documents: string[], topN?: number, returnDocuments?: boolean): Promise<Models.LlmGatewayRerankResponse>;
|
|
202
|
+
/**
|
|
203
|
+
*
|
|
204
|
+
* @throws {AgentbaseException}
|
|
205
|
+
* @returns {Promise<{}>}
|
|
206
|
+
*/
|
|
207
|
+
listTrialProviderBindings(): Promise<{}>;
|
|
208
|
+
/**
|
|
209
|
+
*
|
|
210
|
+
* @param {string} params.providerId - Platform provider ID.
|
|
211
|
+
* @throws {AgentbaseException}
|
|
212
|
+
* @returns {Promise<{}>}
|
|
213
|
+
*/
|
|
214
|
+
createTrialProviderBinding(params: {
|
|
215
|
+
providerId: string;
|
|
216
|
+
}): Promise<{}>;
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @param {string} providerId - Platform provider ID.
|
|
220
|
+
* @throws {AgentbaseException}
|
|
221
|
+
* @returns {Promise<{}>}
|
|
222
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
223
|
+
*/
|
|
224
|
+
createTrialProviderBinding(providerId: string): Promise<{}>;
|
|
225
|
+
/**
|
|
226
|
+
*
|
|
227
|
+
* @param {string} params.bindingId - Trial provider binding ID.
|
|
228
|
+
* @throws {AgentbaseException}
|
|
229
|
+
* @returns {Promise<{}>}
|
|
230
|
+
*/
|
|
231
|
+
getTrialProviderBinding(params: {
|
|
232
|
+
bindingId: string;
|
|
233
|
+
}): Promise<{}>;
|
|
234
|
+
/**
|
|
235
|
+
*
|
|
236
|
+
* @param {string} bindingId - Trial provider binding ID.
|
|
237
|
+
* @throws {AgentbaseException}
|
|
238
|
+
* @returns {Promise<{}>}
|
|
239
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
240
|
+
*/
|
|
241
|
+
getTrialProviderBinding(bindingId: string): Promise<{}>;
|
|
242
|
+
/**
|
|
243
|
+
*
|
|
244
|
+
* @param {string} params.bindingId - Trial provider binding ID.
|
|
245
|
+
* @throws {AgentbaseException}
|
|
246
|
+
* @returns {Promise<{}>}
|
|
247
|
+
*/
|
|
248
|
+
deleteTrialProviderBinding(params: {
|
|
249
|
+
bindingId: string;
|
|
250
|
+
}): Promise<{}>;
|
|
251
|
+
/**
|
|
252
|
+
*
|
|
253
|
+
* @param {string} bindingId - Trial provider binding ID.
|
|
254
|
+
* @throws {AgentbaseException}
|
|
255
|
+
* @returns {Promise<{}>}
|
|
256
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
257
|
+
*/
|
|
258
|
+
deleteTrialProviderBinding(bindingId: string): Promise<{}>;
|
|
259
|
+
/**
|
|
260
|
+
*
|
|
261
|
+
* @param {string} params.bindingId - Trial provider binding ID.
|
|
262
|
+
* @throws {AgentbaseException}
|
|
263
|
+
* @returns {Promise<{}>}
|
|
264
|
+
*/
|
|
265
|
+
createTrialProviderBindingHealthCheck(params: {
|
|
266
|
+
bindingId: string;
|
|
267
|
+
}): Promise<{}>;
|
|
268
|
+
/**
|
|
269
|
+
*
|
|
270
|
+
* @param {string} bindingId - Trial provider binding ID.
|
|
271
|
+
* @throws {AgentbaseException}
|
|
272
|
+
* @returns {Promise<{}>}
|
|
273
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
274
|
+
*/
|
|
275
|
+
createTrialProviderBindingHealthCheck(bindingId: string): Promise<{}>;
|
|
276
|
+
/**
|
|
277
|
+
*
|
|
278
|
+
* @throws {AgentbaseException}
|
|
279
|
+
* @returns {Promise<{}>}
|
|
280
|
+
*/
|
|
281
|
+
listTrialProviders(): Promise<{}>;
|
|
282
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
export declare class Locale {
|
|
4
|
+
client: Client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.
|
|
8
|
+
*
|
|
9
|
+
* ([IP Geolocation by DB-IP](https://db-ip.com))
|
|
10
|
+
*
|
|
11
|
+
* @throws {AgentbaseException}
|
|
12
|
+
* @returns {Promise<Models.Locale>}
|
|
13
|
+
*/
|
|
14
|
+
get(): Promise<Models.Locale>;
|
|
15
|
+
/**
|
|
16
|
+
* List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
|
|
17
|
+
*
|
|
18
|
+
* @throws {AgentbaseException}
|
|
19
|
+
* @returns {Promise<Models.LocaleCodeList>}
|
|
20
|
+
*/
|
|
21
|
+
listCodes(): Promise<Models.LocaleCodeList>;
|
|
22
|
+
/**
|
|
23
|
+
* List of all continents. You can use the locale header to get the data in a supported language.
|
|
24
|
+
*
|
|
25
|
+
* @throws {AgentbaseException}
|
|
26
|
+
* @returns {Promise<Models.ContinentList>}
|
|
27
|
+
*/
|
|
28
|
+
listContinents(): Promise<Models.ContinentList>;
|
|
29
|
+
/**
|
|
30
|
+
* List of all countries. You can use the locale header to get the data in a supported language.
|
|
31
|
+
*
|
|
32
|
+
* @throws {AgentbaseException}
|
|
33
|
+
* @returns {Promise<Models.CountryList>}
|
|
34
|
+
*/
|
|
35
|
+
listCountries(): Promise<Models.CountryList>;
|
|
36
|
+
/**
|
|
37
|
+
* List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
|
|
38
|
+
*
|
|
39
|
+
* @throws {AgentbaseException}
|
|
40
|
+
* @returns {Promise<Models.CountryList>}
|
|
41
|
+
*/
|
|
42
|
+
listCountriesEU(): Promise<Models.CountryList>;
|
|
43
|
+
/**
|
|
44
|
+
* List of all countries phone codes. You can use the locale header to get the data in a supported language.
|
|
45
|
+
*
|
|
46
|
+
* @throws {AgentbaseException}
|
|
47
|
+
* @returns {Promise<Models.PhoneList>}
|
|
48
|
+
*/
|
|
49
|
+
listCountriesPhones(): Promise<Models.PhoneList>;
|
|
50
|
+
/**
|
|
51
|
+
* List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.
|
|
52
|
+
*
|
|
53
|
+
* @throws {AgentbaseException}
|
|
54
|
+
* @returns {Promise<Models.CurrencyList>}
|
|
55
|
+
*/
|
|
56
|
+
listCurrencies(): Promise<Models.CurrencyList>;
|
|
57
|
+
/**
|
|
58
|
+
* List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
|
|
59
|
+
*
|
|
60
|
+
* @throws {AgentbaseException}
|
|
61
|
+
* @returns {Promise<Models.LanguageList>}
|
|
62
|
+
*/
|
|
63
|
+
listLanguages(): Promise<Models.LanguageList>;
|
|
64
|
+
}
|