agentphone 1.0.10 → 1.0.12
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/README.md +10 -10
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +3 -3
- package/dist/cjs/Client.js +21 -21
- package/dist/cjs/api/resources/agents/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/agents/client/Client.js +1 -1
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.d.ts +75 -0
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.js +66 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +75 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.js +66 -0
- package/dist/cjs/api/resources/calls/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/calls/client/Client.js +4 -4
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +39 -1
- package/dist/cjs/api/resources/conversations/client/Client.js +114 -1
- package/dist/cjs/api/resources/conversations/client/requests/RemoveChatBackgroundV1ConversationsConversationIdBackgroundDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/conversations/client/requests/SetBackgroundRequest.d.ts +12 -0
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.d.ts +2 -2
- package/dist/cjs/api/resources/index.js +3 -3
- package/dist/cjs/api/resources/messages/client/requests/SendMessageRequest.d.ts +2 -0
- package/dist/cjs/api/resources/messages/client/requests/SendReactionRequest.d.ts +2 -14
- package/dist/cjs/api/resources/messages/client/requests/SendReactionRequest.js +0 -13
- package/dist/cjs/api/resources/messages/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/client/requests/index.js +1 -3
- package/dist/cjs/api/resources/registration/client/Client.d.ts +61 -0
- package/dist/cjs/api/resources/{agentSignup → registration}/client/Client.js +44 -69
- package/dist/cjs/api/resources/registration/client/requests/RegistrationRequest.d.ts +61 -0
- package/dist/cjs/api/resources/registration/client/requests/RegistrationRequest.js +3 -0
- package/dist/cjs/api/resources/registration/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/AgentResponse.d.ts +8 -0
- package/dist/cjs/api/{resources/agentSignup/client/requests → types}/AgentSignUpRequest.d.ts +0 -6
- package/dist/cjs/api/types/AgentSignUpRequest.js +3 -0
- package/dist/cjs/api/types/AgentVerifyRequest.d.ts +4 -0
- package/dist/cjs/api/types/AgentVerifyRequest.js +3 -0
- package/dist/cjs/api/types/FieldWarning.d.ts +6 -0
- package/dist/cjs/api/types/FieldWarning.js +3 -0
- package/dist/cjs/api/types/RegistrationResponse.d.ts +8 -0
- package/dist/cjs/api/types/RegistrationResponse.js +3 -0
- package/dist/cjs/api/types/SendMessageResponse.d.ts +2 -0
- package/dist/cjs/api/types/SetBackgroundResponse.d.ts +8 -0
- package/dist/cjs/api/types/SetBackgroundResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +5 -0
- package/dist/cjs/api/types/index.js +5 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +3 -3
- package/dist/esm/Client.mjs +5 -5
- package/dist/esm/api/resources/agents/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/agents/client/Client.mjs +1 -1
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.d.mts +75 -0
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.mjs +66 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +75 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.mjs +66 -0
- package/dist/esm/api/resources/calls/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/calls/client/Client.mjs +4 -4
- package/dist/esm/api/resources/conversations/client/Client.d.mts +39 -1
- package/dist/esm/api/resources/conversations/client/Client.mjs +114 -1
- package/dist/esm/api/resources/conversations/client/requests/RemoveChatBackgroundV1ConversationsConversationIdBackgroundDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/conversations/client/requests/SetBackgroundRequest.d.mts +12 -0
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/index.d.mts +2 -2
- package/dist/esm/api/resources/index.mjs +2 -2
- package/dist/esm/api/resources/messages/client/requests/SendMessageRequest.d.mts +2 -0
- package/dist/esm/api/resources/messages/client/requests/SendReactionRequest.d.mts +2 -14
- package/dist/esm/api/resources/messages/client/requests/SendReactionRequest.mjs +1 -12
- package/dist/esm/api/resources/messages/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/registration/client/Client.d.mts +61 -0
- package/dist/esm/api/resources/registration/client/Client.mjs +108 -0
- package/dist/esm/api/resources/registration/client/requests/RegistrationRequest.d.mts +61 -0
- package/dist/esm/api/resources/registration/client/requests/RegistrationRequest.mjs +2 -0
- package/dist/esm/api/resources/registration/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/AgentResponse.d.mts +8 -0
- package/dist/esm/api/{resources/agentSignup/client/requests → types}/AgentSignUpRequest.d.mts +0 -6
- package/dist/esm/api/types/AgentSignUpRequest.mjs +2 -0
- package/dist/esm/api/types/AgentVerifyRequest.d.mts +4 -0
- package/dist/esm/api/types/AgentVerifyRequest.mjs +2 -0
- package/dist/esm/api/types/FieldWarning.d.mts +6 -0
- package/dist/esm/api/types/FieldWarning.mjs +2 -0
- package/dist/esm/api/types/RegistrationResponse.d.mts +8 -0
- package/dist/esm/api/types/RegistrationResponse.mjs +2 -0
- package/dist/esm/api/types/SendMessageResponse.d.mts +2 -0
- package/dist/esm/api/types/SetBackgroundResponse.d.mts +8 -0
- package/dist/esm/api/types/SetBackgroundResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +5 -0
- package/dist/esm/api/types/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +243 -144
- package/dist/cjs/api/resources/agentSignup/client/Client.d.ts +0 -50
- package/dist/cjs/api/resources/agentSignup/client/requests/AgentVerifyRequest.d.ts +0 -11
- package/dist/cjs/api/resources/agentSignup/client/requests/index.d.ts +0 -2
- package/dist/esm/api/resources/agentSignup/client/Client.d.mts +0 -50
- package/dist/esm/api/resources/agentSignup/client/Client.mjs +0 -133
- package/dist/esm/api/resources/agentSignup/client/requests/AgentVerifyRequest.d.mts +0 -11
- package/dist/esm/api/resources/agentSignup/client/requests/index.d.mts +0 -2
- /package/dist/cjs/api/resources/{agentSignup/client/requests/AgentSignUpRequest.js → conversations/client/requests/RemoveChatBackgroundV1ConversationsConversationIdBackgroundDeleteRequest.js} +0 -0
- /package/dist/cjs/api/resources/{agentSignup/client/requests/AgentVerifyRequest.js → conversations/client/requests/SetBackgroundRequest.js} +0 -0
- /package/dist/cjs/api/resources/{agentSignup → registration}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{agentSignup → registration}/client/index.js +0 -0
- /package/dist/cjs/api/resources/{agentSignup → registration}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/{agentSignup → registration}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{agentSignup → registration}/index.js +0 -0
- /package/dist/esm/api/resources/{agentSignup/client/requests/AgentSignUpRequest.mjs → conversations/client/requests/RemoveChatBackgroundV1ConversationsConversationIdBackgroundDeleteRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{agentSignup/client/requests/AgentVerifyRequest.mjs → conversations/client/requests/SetBackgroundRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{agentSignup → registration}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/{agentSignup → registration}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/{agentSignup → registration}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/{agentSignup → registration}/index.d.mts +0 -0
- /package/dist/esm/api/resources/{agentSignup → registration}/index.mjs +0 -0
package/README.md
CHANGED
|
@@ -41,8 +41,8 @@ Instantiate and use the client with the following:
|
|
|
41
41
|
import { AgentPhoneClient } from "agentphone";
|
|
42
42
|
|
|
43
43
|
const client = new AgentPhoneClient({ token: "YOUR_TOKEN" });
|
|
44
|
-
await client.
|
|
45
|
-
|
|
44
|
+
await client.agents.createAgent({
|
|
45
|
+
name: "name"
|
|
46
46
|
});
|
|
47
47
|
```
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ following namespace:
|
|
|
54
54
|
```typescript
|
|
55
55
|
import { AgentPhone } from "agentphone";
|
|
56
56
|
|
|
57
|
-
const request: AgentPhone.
|
|
57
|
+
const request: AgentPhone.ListAgentsV1AgentsGetRequest = {
|
|
58
58
|
...
|
|
59
59
|
};
|
|
60
60
|
```
|
|
@@ -68,7 +68,7 @@ will be thrown.
|
|
|
68
68
|
import { AgentPhoneError } from "agentphone";
|
|
69
69
|
|
|
70
70
|
try {
|
|
71
|
-
await client.
|
|
71
|
+
await client.agents.createAgent(...);
|
|
72
72
|
} catch (err) {
|
|
73
73
|
if (err instanceof AgentPhoneError) {
|
|
74
74
|
console.log(err.statusCode);
|
|
@@ -95,7 +95,7 @@ const client = new AgentPhoneClient({
|
|
|
95
95
|
}
|
|
96
96
|
});
|
|
97
97
|
|
|
98
|
-
const response = await client.
|
|
98
|
+
const response = await client.agents.createAgent(..., {
|
|
99
99
|
headers: {
|
|
100
100
|
'X-Custom-Header': 'custom value'
|
|
101
101
|
}
|
|
@@ -107,7 +107,7 @@ const response = await client.agentSignup.agentSignUp(..., {
|
|
|
107
107
|
If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
|
|
108
108
|
|
|
109
109
|
```typescript
|
|
110
|
-
const response = await client.
|
|
110
|
+
const response = await client.agents.createAgent(..., {
|
|
111
111
|
queryParams: {
|
|
112
112
|
'customQueryParamKey': 'custom query param value'
|
|
113
113
|
}
|
|
@@ -129,7 +129,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
|
|
|
129
129
|
Use the `maxRetries` request option to configure this behavior.
|
|
130
130
|
|
|
131
131
|
```typescript
|
|
132
|
-
const response = await client.
|
|
132
|
+
const response = await client.agents.createAgent(..., {
|
|
133
133
|
maxRetries: 0 // override maxRetries at the request level
|
|
134
134
|
});
|
|
135
135
|
```
|
|
@@ -139,7 +139,7 @@ const response = await client.agentSignup.agentSignUp(..., {
|
|
|
139
139
|
The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
|
|
140
140
|
|
|
141
141
|
```typescript
|
|
142
|
-
const response = await client.
|
|
142
|
+
const response = await client.agents.createAgent(..., {
|
|
143
143
|
timeoutInSeconds: 30 // override timeout to 30s
|
|
144
144
|
});
|
|
145
145
|
```
|
|
@@ -150,7 +150,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
|
|
|
150
150
|
|
|
151
151
|
```typescript
|
|
152
152
|
const controller = new AbortController();
|
|
153
|
-
const response = await client.
|
|
153
|
+
const response = await client.agents.createAgent(..., {
|
|
154
154
|
abortSignal: controller.signal
|
|
155
155
|
});
|
|
156
156
|
controller.abort(); // aborts the request
|
|
@@ -162,7 +162,7 @@ The SDK provides access to raw response data, including headers, through the `.w
|
|
|
162
162
|
The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
|
|
163
163
|
|
|
164
164
|
```typescript
|
|
165
|
-
const { data, rawResponse } = await client.
|
|
165
|
+
const { data, rawResponse } = await client.agents.createAgent(...).withRawResponse();
|
|
166
166
|
|
|
167
167
|
console.log(data);
|
|
168
168
|
console.log(rawResponse.headers['X-My-Header']);
|
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "agentphone",
|
|
46
|
-
"X-Fern-SDK-Version": "1.0.
|
|
47
|
-
"User-Agent": "agentphone/1.0.
|
|
46
|
+
"X-Fern-SDK-Version": "1.0.12",
|
|
47
|
+
"User-Agent": "agentphone/1.0.12",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { AgentSignupClient } from "./api/resources/agentSignup/client/Client.js";
|
|
2
1
|
import { AgentsClient } from "./api/resources/agents/client/Client.js";
|
|
3
2
|
import { AgentWebhooksClient } from "./api/resources/agentWebhooks/client/Client.js";
|
|
4
3
|
import { CallsClient } from "./api/resources/calls/client/Client.js";
|
|
@@ -7,6 +6,7 @@ import { ContactsClient } from "./api/resources/contacts/client/Client.js";
|
|
|
7
6
|
import { ConversationsClient } from "./api/resources/conversations/client/Client.js";
|
|
8
7
|
import { MessagesClient } from "./api/resources/messages/client/Client.js";
|
|
9
8
|
import { NumbersClient } from "./api/resources/numbers/client/Client.js";
|
|
9
|
+
import { RegistrationClient } from "./api/resources/registration/client/Client.js";
|
|
10
10
|
import { UsageClient } from "./api/resources/usage/client/Client.js";
|
|
11
11
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
|
|
12
12
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
|
|
@@ -18,7 +18,6 @@ export declare namespace AgentPhoneClient {
|
|
|
18
18
|
}
|
|
19
19
|
export declare class AgentPhoneClient {
|
|
20
20
|
protected readonly _options: NormalizedClientOptionsWithAuth<AgentPhoneClient.Options>;
|
|
21
|
-
protected _agentSignup: AgentSignupClient | undefined;
|
|
22
21
|
protected _agents: AgentsClient | undefined;
|
|
23
22
|
protected _numbers: NumbersClient | undefined;
|
|
24
23
|
protected _webhooks: WebhooksClient | undefined;
|
|
@@ -29,8 +28,8 @@ export declare class AgentPhoneClient {
|
|
|
29
28
|
protected _usage: UsageClient | undefined;
|
|
30
29
|
protected _messages: MessagesClient | undefined;
|
|
31
30
|
protected _contactCards: ContactCardsClient | undefined;
|
|
31
|
+
protected _registration: RegistrationClient | undefined;
|
|
32
32
|
constructor(options?: AgentPhoneClient.Options);
|
|
33
|
-
get agentSignup(): AgentSignupClient;
|
|
34
33
|
get agents(): AgentsClient;
|
|
35
34
|
get numbers(): NumbersClient;
|
|
36
35
|
get webhooks(): WebhooksClient;
|
|
@@ -41,4 +40,5 @@ export declare class AgentPhoneClient {
|
|
|
41
40
|
get usage(): UsageClient;
|
|
42
41
|
get messages(): MessagesClient;
|
|
43
42
|
get contactCards(): ContactCardsClient;
|
|
43
|
+
get registration(): RegistrationClient;
|
|
44
44
|
}
|
package/dist/cjs/Client.js
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.AgentPhoneClient = void 0;
|
|
5
|
-
const Client_js_1 = require("./api/resources/
|
|
6
|
-
const Client_js_2 = require("./api/resources/
|
|
7
|
-
const Client_js_3 = require("./api/resources/
|
|
8
|
-
const Client_js_4 = require("./api/resources/
|
|
9
|
-
const Client_js_5 = require("./api/resources/
|
|
10
|
-
const Client_js_6 = require("./api/resources/
|
|
11
|
-
const Client_js_7 = require("./api/resources/
|
|
12
|
-
const Client_js_8 = require("./api/resources/
|
|
13
|
-
const Client_js_9 = require("./api/resources/
|
|
5
|
+
const Client_js_1 = require("./api/resources/agents/client/Client.js");
|
|
6
|
+
const Client_js_2 = require("./api/resources/agentWebhooks/client/Client.js");
|
|
7
|
+
const Client_js_3 = require("./api/resources/calls/client/Client.js");
|
|
8
|
+
const Client_js_4 = require("./api/resources/contactCards/client/Client.js");
|
|
9
|
+
const Client_js_5 = require("./api/resources/contacts/client/Client.js");
|
|
10
|
+
const Client_js_6 = require("./api/resources/conversations/client/Client.js");
|
|
11
|
+
const Client_js_7 = require("./api/resources/messages/client/Client.js");
|
|
12
|
+
const Client_js_8 = require("./api/resources/numbers/client/Client.js");
|
|
13
|
+
const Client_js_9 = require("./api/resources/registration/client/Client.js");
|
|
14
14
|
const Client_js_10 = require("./api/resources/usage/client/Client.js");
|
|
15
15
|
const Client_js_11 = require("./api/resources/webhooks/client/Client.js");
|
|
16
16
|
const BaseClient_js_1 = require("./BaseClient.js");
|
|
@@ -18,17 +18,13 @@ class AgentPhoneClient {
|
|
|
18
18
|
constructor(options = {}) {
|
|
19
19
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
20
20
|
}
|
|
21
|
-
get agentSignup() {
|
|
22
|
-
var _a;
|
|
23
|
-
return ((_a = this._agentSignup) !== null && _a !== void 0 ? _a : (this._agentSignup = new Client_js_1.AgentSignupClient(this._options)));
|
|
24
|
-
}
|
|
25
21
|
get agents() {
|
|
26
22
|
var _a;
|
|
27
|
-
return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new
|
|
23
|
+
return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_js_1.AgentsClient(this._options)));
|
|
28
24
|
}
|
|
29
25
|
get numbers() {
|
|
30
26
|
var _a;
|
|
31
|
-
return ((_a = this._numbers) !== null && _a !== void 0 ? _a : (this._numbers = new
|
|
27
|
+
return ((_a = this._numbers) !== null && _a !== void 0 ? _a : (this._numbers = new Client_js_8.NumbersClient(this._options)));
|
|
32
28
|
}
|
|
33
29
|
get webhooks() {
|
|
34
30
|
var _a;
|
|
@@ -36,19 +32,19 @@ class AgentPhoneClient {
|
|
|
36
32
|
}
|
|
37
33
|
get agentWebhooks() {
|
|
38
34
|
var _a;
|
|
39
|
-
return ((_a = this._agentWebhooks) !== null && _a !== void 0 ? _a : (this._agentWebhooks = new
|
|
35
|
+
return ((_a = this._agentWebhooks) !== null && _a !== void 0 ? _a : (this._agentWebhooks = new Client_js_2.AgentWebhooksClient(this._options)));
|
|
40
36
|
}
|
|
41
37
|
get contacts() {
|
|
42
38
|
var _a;
|
|
43
|
-
return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new
|
|
39
|
+
return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_5.ContactsClient(this._options)));
|
|
44
40
|
}
|
|
45
41
|
get conversations() {
|
|
46
42
|
var _a;
|
|
47
|
-
return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new
|
|
43
|
+
return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Client_js_6.ConversationsClient(this._options)));
|
|
48
44
|
}
|
|
49
45
|
get calls() {
|
|
50
46
|
var _a;
|
|
51
|
-
return ((_a = this._calls) !== null && _a !== void 0 ? _a : (this._calls = new
|
|
47
|
+
return ((_a = this._calls) !== null && _a !== void 0 ? _a : (this._calls = new Client_js_3.CallsClient(this._options)));
|
|
52
48
|
}
|
|
53
49
|
get usage() {
|
|
54
50
|
var _a;
|
|
@@ -56,11 +52,15 @@ class AgentPhoneClient {
|
|
|
56
52
|
}
|
|
57
53
|
get messages() {
|
|
58
54
|
var _a;
|
|
59
|
-
return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new
|
|
55
|
+
return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_7.MessagesClient(this._options)));
|
|
60
56
|
}
|
|
61
57
|
get contactCards() {
|
|
62
58
|
var _a;
|
|
63
|
-
return ((_a = this._contactCards) !== null && _a !== void 0 ? _a : (this._contactCards = new
|
|
59
|
+
return ((_a = this._contactCards) !== null && _a !== void 0 ? _a : (this._contactCards = new Client_js_4.ContactCardsClient(this._options)));
|
|
60
|
+
}
|
|
61
|
+
get registration() {
|
|
62
|
+
var _a;
|
|
63
|
+
return ((_a = this._registration) !== null && _a !== void 0 ? _a : (this._registration = new Client_js_9.RegistrationClient(this._options)));
|
|
64
64
|
}
|
|
65
65
|
}
|
|
66
66
|
exports.AgentPhoneClient = AgentPhoneClient;
|
|
@@ -11,7 +11,7 @@ export declare class AgentsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<AgentsClient.Options>;
|
|
12
12
|
constructor(options?: AgentsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Return available voices from the
|
|
14
|
+
* Return available voices from the configured voice provider.
|
|
15
15
|
*
|
|
16
16
|
* @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
17
17
|
*
|
|
@@ -67,7 +67,7 @@ class AgentsClient {
|
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* Return available voices from the
|
|
70
|
+
* Return available voices from the configured voice provider.
|
|
71
71
|
*
|
|
72
72
|
* @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
73
73
|
*
|
|
@@ -24,6 +24,14 @@ export interface CreateAgentRequest {
|
|
|
24
24
|
denoisingMode?: CreateAgentRequest.DenoisingMode;
|
|
25
25
|
/** Hang up the call after this many milliseconds of caller silence. Default 600000 (10 min). Raise for IVR/hold-music workflows; lower to fail fast on dead lines. Range 10000 (10s) to 3600000 (1 hour). */
|
|
26
26
|
maxSilenceMs?: number | null;
|
|
27
|
+
/** Voice speed multiplier. 1.0 is normal pace; lower values slow speech (0.5 is half speed), higher values speed it up (2.0 is double). Range 0.5 to 2.0. */
|
|
28
|
+
voiceSpeed?: number | null;
|
|
29
|
+
/** How easily callers can interrupt the agent. 0 means the agent is never interrupted, 1 means the agent stops at the first sound. Default 0.8. Range 0.0 to 1.0. */
|
|
30
|
+
interruptionSensitivity?: number | null;
|
|
31
|
+
/** When true, the agent interjects short filler words like 'uh-huh' or 'mhmm' during longer caller utterances. Set false to keep the agent silent while the caller is speaking. Defaults to true. */
|
|
32
|
+
enableBackchannel?: boolean | null;
|
|
33
|
+
/** BCP-47 locale that drives the agent's speech recognition and pronunciation. Defaults to 'en-US'. See the enum for the full set of supported codes. */
|
|
34
|
+
language?: CreateAgentRequest.Language;
|
|
27
35
|
}
|
|
28
36
|
export declare namespace CreateAgentRequest {
|
|
29
37
|
const VoiceMode: {
|
|
@@ -57,4 +65,71 @@ export declare namespace CreateAgentRequest {
|
|
|
57
65
|
readonly NoiseAndBackgroundSpeechCancellation: "noise-and-background-speech-cancellation";
|
|
58
66
|
};
|
|
59
67
|
type DenoisingMode = (typeof DenoisingMode)[keyof typeof DenoisingMode];
|
|
68
|
+
/** BCP-47 locale that drives the agent's speech recognition and pronunciation. Defaults to 'en-US'. See the enum for the full set of supported codes. */
|
|
69
|
+
const Language: {
|
|
70
|
+
readonly AfZa: "af-ZA";
|
|
71
|
+
readonly ArSa: "ar-SA";
|
|
72
|
+
readonly AzAz: "az-AZ";
|
|
73
|
+
readonly BgBg: "bg-BG";
|
|
74
|
+
readonly BsBa: "bs-BA";
|
|
75
|
+
readonly CaEs: "ca-ES";
|
|
76
|
+
readonly CsCz: "cs-CZ";
|
|
77
|
+
readonly CyGb: "cy-GB";
|
|
78
|
+
readonly DaDk: "da-DK";
|
|
79
|
+
readonly DeDe: "de-DE";
|
|
80
|
+
readonly ElGr: "el-GR";
|
|
81
|
+
readonly EnAu: "en-AU";
|
|
82
|
+
readonly EnGb: "en-GB";
|
|
83
|
+
readonly EnIn: "en-IN";
|
|
84
|
+
readonly EnNz: "en-NZ";
|
|
85
|
+
readonly EnUs: "en-US";
|
|
86
|
+
readonly Es419: "es-419";
|
|
87
|
+
readonly EsEs: "es-ES";
|
|
88
|
+
readonly FaIr: "fa-IR";
|
|
89
|
+
readonly FiFi: "fi-FI";
|
|
90
|
+
readonly FilPh: "fil-PH";
|
|
91
|
+
readonly FrCa: "fr-CA";
|
|
92
|
+
readonly FrFr: "fr-FR";
|
|
93
|
+
readonly GlEs: "gl-ES";
|
|
94
|
+
readonly HeIl: "he-IL";
|
|
95
|
+
readonly HiIn: "hi-IN";
|
|
96
|
+
readonly HrHr: "hr-HR";
|
|
97
|
+
readonly HuHu: "hu-HU";
|
|
98
|
+
readonly HyAm: "hy-AM";
|
|
99
|
+
readonly IdId: "id-ID";
|
|
100
|
+
readonly IsIs: "is-IS";
|
|
101
|
+
readonly ItIt: "it-IT";
|
|
102
|
+
readonly JaJp: "ja-JP";
|
|
103
|
+
readonly KkKz: "kk-KZ";
|
|
104
|
+
readonly KnIn: "kn-IN";
|
|
105
|
+
readonly KoKr: "ko-KR";
|
|
106
|
+
readonly LtLt: "lt-LT";
|
|
107
|
+
readonly LvLv: "lv-LV";
|
|
108
|
+
readonly MkMk: "mk-MK";
|
|
109
|
+
readonly MrIn: "mr-IN";
|
|
110
|
+
readonly MsMy: "ms-MY";
|
|
111
|
+
readonly NeNp: "ne-NP";
|
|
112
|
+
readonly NlBe: "nl-BE";
|
|
113
|
+
readonly NlNl: "nl-NL";
|
|
114
|
+
readonly NoNo: "no-NO";
|
|
115
|
+
readonly PlPl: "pl-PL";
|
|
116
|
+
readonly PtBr: "pt-BR";
|
|
117
|
+
readonly PtPt: "pt-PT";
|
|
118
|
+
readonly RoRo: "ro-RO";
|
|
119
|
+
readonly RuRu: "ru-RU";
|
|
120
|
+
readonly SkSk: "sk-SK";
|
|
121
|
+
readonly SlSi: "sl-SI";
|
|
122
|
+
readonly SrRs: "sr-RS";
|
|
123
|
+
readonly SvSe: "sv-SE";
|
|
124
|
+
readonly SwKe: "sw-KE";
|
|
125
|
+
readonly TaIn: "ta-IN";
|
|
126
|
+
readonly ThTh: "th-TH";
|
|
127
|
+
readonly TrTr: "tr-TR";
|
|
128
|
+
readonly UkUa: "uk-UA";
|
|
129
|
+
readonly UrIn: "ur-IN";
|
|
130
|
+
readonly ViVn: "vi-VN";
|
|
131
|
+
readonly YueCn: "yue-CN";
|
|
132
|
+
readonly ZhCn: "zh-CN";
|
|
133
|
+
};
|
|
134
|
+
type Language = (typeof Language)[keyof typeof Language];
|
|
60
135
|
}
|
|
@@ -30,4 +30,70 @@ var CreateAgentRequest;
|
|
|
30
30
|
NoiseCancellation: "noise-cancellation",
|
|
31
31
|
NoiseAndBackgroundSpeechCancellation: "noise-and-background-speech-cancellation",
|
|
32
32
|
};
|
|
33
|
+
/** BCP-47 locale that drives the agent's speech recognition and pronunciation. Defaults to 'en-US'. See the enum for the full set of supported codes. */
|
|
34
|
+
CreateAgentRequest.Language = {
|
|
35
|
+
AfZa: "af-ZA",
|
|
36
|
+
ArSa: "ar-SA",
|
|
37
|
+
AzAz: "az-AZ",
|
|
38
|
+
BgBg: "bg-BG",
|
|
39
|
+
BsBa: "bs-BA",
|
|
40
|
+
CaEs: "ca-ES",
|
|
41
|
+
CsCz: "cs-CZ",
|
|
42
|
+
CyGb: "cy-GB",
|
|
43
|
+
DaDk: "da-DK",
|
|
44
|
+
DeDe: "de-DE",
|
|
45
|
+
ElGr: "el-GR",
|
|
46
|
+
EnAu: "en-AU",
|
|
47
|
+
EnGb: "en-GB",
|
|
48
|
+
EnIn: "en-IN",
|
|
49
|
+
EnNz: "en-NZ",
|
|
50
|
+
EnUs: "en-US",
|
|
51
|
+
Es419: "es-419",
|
|
52
|
+
EsEs: "es-ES",
|
|
53
|
+
FaIr: "fa-IR",
|
|
54
|
+
FiFi: "fi-FI",
|
|
55
|
+
FilPh: "fil-PH",
|
|
56
|
+
FrCa: "fr-CA",
|
|
57
|
+
FrFr: "fr-FR",
|
|
58
|
+
GlEs: "gl-ES",
|
|
59
|
+
HeIl: "he-IL",
|
|
60
|
+
HiIn: "hi-IN",
|
|
61
|
+
HrHr: "hr-HR",
|
|
62
|
+
HuHu: "hu-HU",
|
|
63
|
+
HyAm: "hy-AM",
|
|
64
|
+
IdId: "id-ID",
|
|
65
|
+
IsIs: "is-IS",
|
|
66
|
+
ItIt: "it-IT",
|
|
67
|
+
JaJp: "ja-JP",
|
|
68
|
+
KkKz: "kk-KZ",
|
|
69
|
+
KnIn: "kn-IN",
|
|
70
|
+
KoKr: "ko-KR",
|
|
71
|
+
LtLt: "lt-LT",
|
|
72
|
+
LvLv: "lv-LV",
|
|
73
|
+
MkMk: "mk-MK",
|
|
74
|
+
MrIn: "mr-IN",
|
|
75
|
+
MsMy: "ms-MY",
|
|
76
|
+
NeNp: "ne-NP",
|
|
77
|
+
NlBe: "nl-BE",
|
|
78
|
+
NlNl: "nl-NL",
|
|
79
|
+
NoNo: "no-NO",
|
|
80
|
+
PlPl: "pl-PL",
|
|
81
|
+
PtBr: "pt-BR",
|
|
82
|
+
PtPt: "pt-PT",
|
|
83
|
+
RoRo: "ro-RO",
|
|
84
|
+
RuRu: "ru-RU",
|
|
85
|
+
SkSk: "sk-SK",
|
|
86
|
+
SlSi: "sl-SI",
|
|
87
|
+
SrRs: "sr-RS",
|
|
88
|
+
SvSe: "sv-SE",
|
|
89
|
+
SwKe: "sw-KE",
|
|
90
|
+
TaIn: "ta-IN",
|
|
91
|
+
ThTh: "th-TH",
|
|
92
|
+
TrTr: "tr-TR",
|
|
93
|
+
UkUa: "uk-UA",
|
|
94
|
+
UrIn: "ur-IN",
|
|
95
|
+
ViVn: "vi-VN",
|
|
96
|
+
YueCn: "yue-CN",
|
|
97
|
+
ZhCn: "zh-CN",
|
|
98
|
+
};
|
|
33
99
|
})(CreateAgentRequest || (exports.CreateAgentRequest = CreateAgentRequest = {}));
|
|
@@ -25,6 +25,14 @@ export interface UpdateAgentRequest {
|
|
|
25
25
|
denoisingMode?: UpdateAgentRequest.DenoisingMode;
|
|
26
26
|
/** Hang up the call after this many milliseconds of caller silence. Default 600000 (10 min). Raise for IVR/hold-music workflows; lower to fail fast on dead lines. Range 10000 (10s) to 3600000 (1 hour). */
|
|
27
27
|
maxSilenceMs?: number | null;
|
|
28
|
+
/** Voice speed multiplier. 1.0 is normal pace; lower slows speech (0.5 is half speed), higher speeds it up (2.0 is double). Range 0.5 to 2.0. */
|
|
29
|
+
voiceSpeed?: number | null;
|
|
30
|
+
/** How easily callers can interrupt the agent. 0 means the agent is never interrupted, 1 means the agent stops at the first sound. Default 0.8. Range 0.0 to 1.0. */
|
|
31
|
+
interruptionSensitivity?: number | null;
|
|
32
|
+
/** When true, the agent interjects short filler words like 'uh-huh' or 'mhmm' during longer caller utterances. Set false to keep the agent silent while the caller is speaking. */
|
|
33
|
+
enableBackchannel?: boolean | null;
|
|
34
|
+
/** BCP-47 locale that drives the agent's speech recognition and pronunciation. See the enum for the full set of supported codes. */
|
|
35
|
+
language?: UpdateAgentRequest.Language;
|
|
28
36
|
}
|
|
29
37
|
export declare namespace UpdateAgentRequest {
|
|
30
38
|
const VoiceMode: {
|
|
@@ -58,4 +66,71 @@ export declare namespace UpdateAgentRequest {
|
|
|
58
66
|
readonly NoiseAndBackgroundSpeechCancellation: "noise-and-background-speech-cancellation";
|
|
59
67
|
};
|
|
60
68
|
type DenoisingMode = (typeof DenoisingMode)[keyof typeof DenoisingMode];
|
|
69
|
+
/** BCP-47 locale that drives the agent's speech recognition and pronunciation. See the enum for the full set of supported codes. */
|
|
70
|
+
const Language: {
|
|
71
|
+
readonly AfZa: "af-ZA";
|
|
72
|
+
readonly ArSa: "ar-SA";
|
|
73
|
+
readonly AzAz: "az-AZ";
|
|
74
|
+
readonly BgBg: "bg-BG";
|
|
75
|
+
readonly BsBa: "bs-BA";
|
|
76
|
+
readonly CaEs: "ca-ES";
|
|
77
|
+
readonly CsCz: "cs-CZ";
|
|
78
|
+
readonly CyGb: "cy-GB";
|
|
79
|
+
readonly DaDk: "da-DK";
|
|
80
|
+
readonly DeDe: "de-DE";
|
|
81
|
+
readonly ElGr: "el-GR";
|
|
82
|
+
readonly EnAu: "en-AU";
|
|
83
|
+
readonly EnGb: "en-GB";
|
|
84
|
+
readonly EnIn: "en-IN";
|
|
85
|
+
readonly EnNz: "en-NZ";
|
|
86
|
+
readonly EnUs: "en-US";
|
|
87
|
+
readonly Es419: "es-419";
|
|
88
|
+
readonly EsEs: "es-ES";
|
|
89
|
+
readonly FaIr: "fa-IR";
|
|
90
|
+
readonly FiFi: "fi-FI";
|
|
91
|
+
readonly FilPh: "fil-PH";
|
|
92
|
+
readonly FrCa: "fr-CA";
|
|
93
|
+
readonly FrFr: "fr-FR";
|
|
94
|
+
readonly GlEs: "gl-ES";
|
|
95
|
+
readonly HeIl: "he-IL";
|
|
96
|
+
readonly HiIn: "hi-IN";
|
|
97
|
+
readonly HrHr: "hr-HR";
|
|
98
|
+
readonly HuHu: "hu-HU";
|
|
99
|
+
readonly HyAm: "hy-AM";
|
|
100
|
+
readonly IdId: "id-ID";
|
|
101
|
+
readonly IsIs: "is-IS";
|
|
102
|
+
readonly ItIt: "it-IT";
|
|
103
|
+
readonly JaJp: "ja-JP";
|
|
104
|
+
readonly KkKz: "kk-KZ";
|
|
105
|
+
readonly KnIn: "kn-IN";
|
|
106
|
+
readonly KoKr: "ko-KR";
|
|
107
|
+
readonly LtLt: "lt-LT";
|
|
108
|
+
readonly LvLv: "lv-LV";
|
|
109
|
+
readonly MkMk: "mk-MK";
|
|
110
|
+
readonly MrIn: "mr-IN";
|
|
111
|
+
readonly MsMy: "ms-MY";
|
|
112
|
+
readonly NeNp: "ne-NP";
|
|
113
|
+
readonly NlBe: "nl-BE";
|
|
114
|
+
readonly NlNl: "nl-NL";
|
|
115
|
+
readonly NoNo: "no-NO";
|
|
116
|
+
readonly PlPl: "pl-PL";
|
|
117
|
+
readonly PtBr: "pt-BR";
|
|
118
|
+
readonly PtPt: "pt-PT";
|
|
119
|
+
readonly RoRo: "ro-RO";
|
|
120
|
+
readonly RuRu: "ru-RU";
|
|
121
|
+
readonly SkSk: "sk-SK";
|
|
122
|
+
readonly SlSi: "sl-SI";
|
|
123
|
+
readonly SrRs: "sr-RS";
|
|
124
|
+
readonly SvSe: "sv-SE";
|
|
125
|
+
readonly SwKe: "sw-KE";
|
|
126
|
+
readonly TaIn: "ta-IN";
|
|
127
|
+
readonly ThTh: "th-TH";
|
|
128
|
+
readonly TrTr: "tr-TR";
|
|
129
|
+
readonly UkUa: "uk-UA";
|
|
130
|
+
readonly UrIn: "ur-IN";
|
|
131
|
+
readonly ViVn: "vi-VN";
|
|
132
|
+
readonly YueCn: "yue-CN";
|
|
133
|
+
readonly ZhCn: "zh-CN";
|
|
134
|
+
};
|
|
135
|
+
type Language = (typeof Language)[keyof typeof Language];
|
|
61
136
|
}
|
|
@@ -30,4 +30,70 @@ var UpdateAgentRequest;
|
|
|
30
30
|
NoiseCancellation: "noise-cancellation",
|
|
31
31
|
NoiseAndBackgroundSpeechCancellation: "noise-and-background-speech-cancellation",
|
|
32
32
|
};
|
|
33
|
+
/** BCP-47 locale that drives the agent's speech recognition and pronunciation. See the enum for the full set of supported codes. */
|
|
34
|
+
UpdateAgentRequest.Language = {
|
|
35
|
+
AfZa: "af-ZA",
|
|
36
|
+
ArSa: "ar-SA",
|
|
37
|
+
AzAz: "az-AZ",
|
|
38
|
+
BgBg: "bg-BG",
|
|
39
|
+
BsBa: "bs-BA",
|
|
40
|
+
CaEs: "ca-ES",
|
|
41
|
+
CsCz: "cs-CZ",
|
|
42
|
+
CyGb: "cy-GB",
|
|
43
|
+
DaDk: "da-DK",
|
|
44
|
+
DeDe: "de-DE",
|
|
45
|
+
ElGr: "el-GR",
|
|
46
|
+
EnAu: "en-AU",
|
|
47
|
+
EnGb: "en-GB",
|
|
48
|
+
EnIn: "en-IN",
|
|
49
|
+
EnNz: "en-NZ",
|
|
50
|
+
EnUs: "en-US",
|
|
51
|
+
Es419: "es-419",
|
|
52
|
+
EsEs: "es-ES",
|
|
53
|
+
FaIr: "fa-IR",
|
|
54
|
+
FiFi: "fi-FI",
|
|
55
|
+
FilPh: "fil-PH",
|
|
56
|
+
FrCa: "fr-CA",
|
|
57
|
+
FrFr: "fr-FR",
|
|
58
|
+
GlEs: "gl-ES",
|
|
59
|
+
HeIl: "he-IL",
|
|
60
|
+
HiIn: "hi-IN",
|
|
61
|
+
HrHr: "hr-HR",
|
|
62
|
+
HuHu: "hu-HU",
|
|
63
|
+
HyAm: "hy-AM",
|
|
64
|
+
IdId: "id-ID",
|
|
65
|
+
IsIs: "is-IS",
|
|
66
|
+
ItIt: "it-IT",
|
|
67
|
+
JaJp: "ja-JP",
|
|
68
|
+
KkKz: "kk-KZ",
|
|
69
|
+
KnIn: "kn-IN",
|
|
70
|
+
KoKr: "ko-KR",
|
|
71
|
+
LtLt: "lt-LT",
|
|
72
|
+
LvLv: "lv-LV",
|
|
73
|
+
MkMk: "mk-MK",
|
|
74
|
+
MrIn: "mr-IN",
|
|
75
|
+
MsMy: "ms-MY",
|
|
76
|
+
NeNp: "ne-NP",
|
|
77
|
+
NlBe: "nl-BE",
|
|
78
|
+
NlNl: "nl-NL",
|
|
79
|
+
NoNo: "no-NO",
|
|
80
|
+
PlPl: "pl-PL",
|
|
81
|
+
PtBr: "pt-BR",
|
|
82
|
+
PtPt: "pt-PT",
|
|
83
|
+
RoRo: "ro-RO",
|
|
84
|
+
RuRu: "ru-RU",
|
|
85
|
+
SkSk: "sk-SK",
|
|
86
|
+
SlSi: "sl-SI",
|
|
87
|
+
SrRs: "sr-RS",
|
|
88
|
+
SvSe: "sv-SE",
|
|
89
|
+
SwKe: "sw-KE",
|
|
90
|
+
TaIn: "ta-IN",
|
|
91
|
+
ThTh: "th-TH",
|
|
92
|
+
TrTr: "tr-TR",
|
|
93
|
+
UkUa: "uk-UA",
|
|
94
|
+
UrIn: "ur-IN",
|
|
95
|
+
ViVn: "vi-VN",
|
|
96
|
+
YueCn: "yue-CN",
|
|
97
|
+
ZhCn: "zh-CN",
|
|
98
|
+
};
|
|
33
99
|
})(UpdateAgentRequest || (exports.UpdateAgentRequest = UpdateAgentRequest = {}));
|
|
@@ -93,10 +93,10 @@ export declare class CallsClient {
|
|
|
93
93
|
/**
|
|
94
94
|
* Terminate an ongoing call.
|
|
95
95
|
*
|
|
96
|
-
* Works for both hosted-mode and webhook-mode calls.
|
|
97
|
-
* webhook from
|
|
98
|
-
* endpoint returns the current call as soon as the stop request
|
|
99
|
-
* accepted
|
|
96
|
+
* Works for both hosted-mode and webhook-mode calls. The call_ended
|
|
97
|
+
* webhook from the voice provider updates status/endedAt asynchronously,
|
|
98
|
+
* so this endpoint returns the current call as soon as the stop request
|
|
99
|
+
* is accepted upstream.
|
|
100
100
|
*
|
|
101
101
|
* @param {AgentPhone.EndCallV1CallsCallIdEndPostRequest} request
|
|
102
102
|
* @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -294,10 +294,10 @@ class CallsClient {
|
|
|
294
294
|
/**
|
|
295
295
|
* Terminate an ongoing call.
|
|
296
296
|
*
|
|
297
|
-
* Works for both hosted-mode and webhook-mode calls.
|
|
298
|
-
* webhook from
|
|
299
|
-
* endpoint returns the current call as soon as the stop request
|
|
300
|
-
* accepted
|
|
297
|
+
* Works for both hosted-mode and webhook-mode calls. The call_ended
|
|
298
|
+
* webhook from the voice provider updates status/endedAt asynchronously,
|
|
299
|
+
* so this endpoint returns the current call as soon as the stop request
|
|
300
|
+
* is accepted upstream.
|
|
301
301
|
*
|
|
302
302
|
* @param {AgentPhone.EndCallV1CallsCallIdEndPostRequest} request
|
|
303
303
|
* @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -14,7 +14,7 @@ export declare class ConversationsClient {
|
|
|
14
14
|
* List all conversations for this account.
|
|
15
15
|
*
|
|
16
16
|
* Sorted by most recent activity (lastMessageAt desc).
|
|
17
|
-
*
|
|
17
|
+
* Sorted by most recent activity.
|
|
18
18
|
*
|
|
19
19
|
* @param {AgentPhone.ListConversationsV1ConversationsGetRequest} request
|
|
20
20
|
* @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -99,4 +99,42 @@ export declare class ConversationsClient {
|
|
|
99
99
|
*/
|
|
100
100
|
sendTypingIndicator(request: AgentPhone.SendTypingIndicatorV1ConversationsConversationIdTypingPostRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<AgentPhone.SendTypingResponse>;
|
|
101
101
|
private __sendTypingIndicator;
|
|
102
|
+
/**
|
|
103
|
+
* Set a custom wallpaper for the chat (iMessage only).
|
|
104
|
+
*
|
|
105
|
+
* Customer sends `image_url`; we fetch (≤10MB, JPEG/PNG/GIF/WebP/HEIC),
|
|
106
|
+
* validate, and forward as multipart to the iMessage provider. Idempotent —
|
|
107
|
+
* re-setting replaces. Recipients on iOS < 18 fall back to the default
|
|
108
|
+
* silently.
|
|
109
|
+
*
|
|
110
|
+
* @param {AgentPhone.SetBackgroundRequest} request
|
|
111
|
+
* @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link AgentPhone.UnprocessableEntityError}
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* await client.conversations.setChatBackground({
|
|
117
|
+
* conversation_id: "conversation_id",
|
|
118
|
+
* image_url: "https://example.com/wallpaper.jpg"
|
|
119
|
+
* })
|
|
120
|
+
*/
|
|
121
|
+
setChatBackground(request: AgentPhone.SetBackgroundRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<AgentPhone.SetBackgroundResponse>;
|
|
122
|
+
private __setChatBackground;
|
|
123
|
+
/**
|
|
124
|
+
* Clear the custom wallpaper for the chat (iMessage only).
|
|
125
|
+
*
|
|
126
|
+
* Idempotent: deleting a default-background chat returns 204 (no-op).
|
|
127
|
+
*
|
|
128
|
+
* @param {AgentPhone.RemoveChatBackgroundV1ConversationsConversationIdBackgroundDeleteRequest} request
|
|
129
|
+
* @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link AgentPhone.UnprocessableEntityError}
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* await client.conversations.removeChatBackground({
|
|
135
|
+
* conversation_id: "conversation_id"
|
|
136
|
+
* })
|
|
137
|
+
*/
|
|
138
|
+
removeChatBackground(request: AgentPhone.RemoveChatBackgroundV1ConversationsConversationIdBackgroundDeleteRequest, requestOptions?: ConversationsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
139
|
+
private __removeChatBackground;
|
|
102
140
|
}
|