@zavudev/sdk 0.51.0 → 0.52.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/CHANGELOG.md +19 -0
- package/package.json +1 -1
- package/resources/functions/functions.d.mts +22 -8
- package/resources/functions/functions.d.mts.map +1 -1
- package/resources/functions/functions.d.ts +22 -8
- package/resources/functions/functions.d.ts.map +1 -1
- package/resources/functions/functions.js +6 -4
- package/resources/functions/functions.js.map +1 -1
- package/resources/functions/functions.mjs +6 -4
- package/resources/functions/functions.mjs.map +1 -1
- package/resources/invitations.d.mts +85 -15
- package/resources/invitations.d.mts.map +1 -1
- package/resources/invitations.d.ts +85 -15
- package/resources/invitations.d.ts.map +1 -1
- package/resources/invitations.js +14 -4
- package/resources/invitations.js.map +1 -1
- package/resources/invitations.mjs +14 -4
- package/resources/invitations.mjs.map +1 -1
- package/resources/messages.d.mts +41 -4
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +41 -4
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +12 -3
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +12 -3
- package/resources/messages.mjs.map +1 -1
- package/resources/number-10dlc/brands.d.mts +5 -1
- package/resources/number-10dlc/brands.d.mts.map +1 -1
- package/resources/number-10dlc/brands.d.ts +5 -1
- package/resources/number-10dlc/brands.d.ts.map +1 -1
- package/resources/number-10dlc/brands.js +5 -1
- package/resources/number-10dlc/brands.js.map +1 -1
- package/resources/number-10dlc/brands.mjs +5 -1
- package/resources/number-10dlc/brands.mjs.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.d.mts +6 -1
- package/resources/number-10dlc/campaigns/campaigns.d.mts.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.d.ts +6 -1
- package/resources/number-10dlc/campaigns/campaigns.d.ts.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.js +6 -1
- package/resources/number-10dlc/campaigns/campaigns.js.map +1 -1
- package/resources/number-10dlc/campaigns/campaigns.mjs +6 -1
- package/resources/number-10dlc/campaigns/campaigns.mjs.map +1 -1
- package/resources/phone-numbers.d.mts +5 -0
- package/resources/phone-numbers.d.mts.map +1 -1
- package/resources/phone-numbers.d.ts +5 -0
- package/resources/phone-numbers.d.ts.map +1 -1
- package/resources/senders/agent/agent.d.mts +307 -0
- package/resources/senders/agent/agent.d.mts.map +1 -1
- package/resources/senders/agent/agent.d.ts +307 -0
- package/resources/senders/agent/agent.d.ts.map +1 -1
- package/resources/senders/agent/agent.js +6 -0
- package/resources/senders/agent/agent.js.map +1 -1
- package/resources/senders/agent/agent.mjs +6 -0
- package/resources/senders/agent/agent.mjs.map +1 -1
- package/resources/senders/agent/executions.d.mts +5 -0
- package/resources/senders/agent/executions.d.mts.map +1 -1
- package/resources/senders/agent/executions.d.ts +5 -0
- package/resources/senders/agent/executions.d.ts.map +1 -1
- package/resources/senders/agent/executions.js +5 -0
- package/resources/senders/agent/executions.js.map +1 -1
- package/resources/senders/agent/executions.mjs +5 -0
- package/resources/senders/agent/executions.mjs.map +1 -1
- package/resources/senders/senders.d.mts +51 -4
- package/resources/senders/senders.d.mts.map +1 -1
- package/resources/senders/senders.d.ts +51 -4
- package/resources/senders/senders.d.ts.map +1 -1
- package/resources/senders/senders.js.map +1 -1
- package/resources/senders/senders.mjs.map +1 -1
- package/resources/templates.d.mts +12 -3
- package/resources/templates.d.mts.map +1 -1
- package/resources/templates.d.ts +12 -3
- package/resources/templates.d.ts.map +1 -1
- package/src/resources/functions/functions.ts +23 -8
- package/src/resources/invitations.ts +91 -15
- package/src/resources/messages.ts +42 -3
- package/src/resources/number-10dlc/brands.ts +5 -1
- package/src/resources/number-10dlc/campaigns/campaigns.ts +6 -1
- package/src/resources/phone-numbers.ts +6 -0
- package/src/resources/senders/agent/agent.ts +357 -0
- package/src/resources/senders/agent/executions.ts +5 -0
- package/src/resources/senders/senders.ts +58 -3
- package/src/resources/templates.ts +13 -4
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -4,12 +4,22 @@ import { Cursor, type CursorParams, PagePromise } from "../core/pagination.js";
|
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
5
|
export declare class Invitations extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Create a partner invitation link for a client to connect
|
|
8
|
-
* opens the returned `url` and
|
|
9
|
-
*
|
|
10
|
-
* project when the client completes the flow, and the invitation transitions to
|
|
7
|
+
* Create a partner invitation link for a client to connect a Meta channel. The
|
|
8
|
+
* client opens the returned `url` and authorizes with Meta; the resulting sender
|
|
9
|
+
* is created in your project when they finish, and the invitation transitions to
|
|
11
10
|
* `completed`.
|
|
12
11
|
*
|
|
12
|
+
* `connectionType` picks the channel:
|
|
13
|
+
*
|
|
14
|
+
* - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
|
|
15
|
+
* Business Account.
|
|
16
|
+
* - `messenger`: the client picks a Facebook Page they administer; its Messenger
|
|
17
|
+
* inbox (including Marketplace chats) is routed to Zavu.
|
|
18
|
+
*
|
|
19
|
+
* One invitation connects one channel — create one per channel to onboard a client
|
|
20
|
+
* on several. `phoneNumberId` and `allowedPhoneCountries` apply to `whatsapp_waba`
|
|
21
|
+
* only.
|
|
22
|
+
*
|
|
13
23
|
* @example
|
|
14
24
|
* ```ts
|
|
15
25
|
* const invitation = await client.invitations.create({
|
|
@@ -65,8 +75,13 @@ export interface Invitation {
|
|
|
65
75
|
expiresAt: string;
|
|
66
76
|
/**
|
|
67
77
|
* Current status of the partner invitation.
|
|
78
|
+
*
|
|
79
|
+
* `failed` means the client started the connection and it did not finish (they
|
|
80
|
+
* cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed
|
|
81
|
+
* invitation is still usable: the same link can be retried, and it moves back to
|
|
82
|
+
* `in_progress` when the client tries again.
|
|
68
83
|
*/
|
|
69
|
-
status: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled';
|
|
84
|
+
status: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled' | 'failed';
|
|
70
85
|
updatedAt: string;
|
|
71
86
|
/**
|
|
72
87
|
* Full URL to share with the client.
|
|
@@ -77,12 +92,29 @@ export interface Invitation {
|
|
|
77
92
|
clientPhone?: string | null;
|
|
78
93
|
completedAt?: string | null;
|
|
79
94
|
/**
|
|
80
|
-
*
|
|
81
|
-
*
|
|
95
|
+
* The account the client linked, populated once the invitation is `completed`.
|
|
96
|
+
* Null before that. Use it to show the partner what was connected without fetching
|
|
97
|
+
* the sender.
|
|
98
|
+
*/
|
|
99
|
+
connectedAccount?: Invitation.ConnectedAccount | null;
|
|
100
|
+
/**
|
|
101
|
+
* Which Meta channel the client connects: `whatsapp_waba` (official WhatsApp Cloud
|
|
102
|
+
* API via embedded signup) or `messenger` (a Facebook Page's Messenger inbox,
|
|
103
|
+
* including Marketplace chats).
|
|
82
104
|
*/
|
|
83
|
-
connectionType?: 'whatsapp_waba';
|
|
105
|
+
connectionType?: 'whatsapp_waba' | 'messenger';
|
|
106
|
+
failedAt?: string | null;
|
|
84
107
|
/**
|
|
85
|
-
*
|
|
108
|
+
* Stable code for why the last attempt failed, present when `status` is `failed`.
|
|
109
|
+
* Values include `fb_cancelled` (client closed Meta's dialog), `fb_not_authorized`
|
|
110
|
+
* (permission denied), `signup_abandoned` (started but never finished),
|
|
111
|
+
* `meta_no_pages` (the client administers no Facebook Page), and `internal_error`.
|
|
112
|
+
* Treat unknown codes as a generic failure.
|
|
113
|
+
*/
|
|
114
|
+
failureReason?: string | null;
|
|
115
|
+
/**
|
|
116
|
+
* ID of a pre-assigned Zavu phone number for WhatsApp registration. Always null
|
|
117
|
+
* for `messenger` invitations.
|
|
86
118
|
*/
|
|
87
119
|
phoneNumberId?: string | null;
|
|
88
120
|
/**
|
|
@@ -92,6 +124,25 @@ export interface Invitation {
|
|
|
92
124
|
startedAt?: string | null;
|
|
93
125
|
viewedAt?: string | null;
|
|
94
126
|
}
|
|
127
|
+
export declare namespace Invitation {
|
|
128
|
+
/**
|
|
129
|
+
* The account the client linked, populated once the invitation is `completed`.
|
|
130
|
+
* Null before that. Use it to show the partner what was connected without fetching
|
|
131
|
+
* the sender.
|
|
132
|
+
*/
|
|
133
|
+
interface ConnectedAccount {
|
|
134
|
+
/**
|
|
135
|
+
* Provider-side identifier: the WhatsApp phone number ID, or the Facebook Page ID.
|
|
136
|
+
*/
|
|
137
|
+
id: string;
|
|
138
|
+
channel: 'whatsapp' | 'messenger';
|
|
139
|
+
/**
|
|
140
|
+
* Display name of the connected account: the WhatsApp verified name, or the
|
|
141
|
+
* Facebook Page name.
|
|
142
|
+
*/
|
|
143
|
+
name?: string | null;
|
|
144
|
+
}
|
|
145
|
+
}
|
|
95
146
|
export interface InvitationCreateResponse {
|
|
96
147
|
invitation: Invitation;
|
|
97
148
|
}
|
|
@@ -103,7 +154,8 @@ export interface InvitationCancelResponse {
|
|
|
103
154
|
}
|
|
104
155
|
export interface InvitationCreateParams {
|
|
105
156
|
/**
|
|
106
|
-
* ISO country codes for allowed phone numbers.
|
|
157
|
+
* ISO country codes for allowed phone numbers. Only valid when `connectionType` is
|
|
158
|
+
* `whatsapp_waba` — sending it with `messenger` returns 400.
|
|
107
159
|
*/
|
|
108
160
|
allowedPhoneCountries?: Array<string>;
|
|
109
161
|
/**
|
|
@@ -119,25 +171,43 @@ export interface InvitationCreateParams {
|
|
|
119
171
|
*/
|
|
120
172
|
clientPhone?: string;
|
|
121
173
|
/**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
174
|
+
* Which Meta channel the client connects, and how.
|
|
175
|
+
*
|
|
176
|
+
* - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
|
|
177
|
+
* Business Account. Accepts `phoneNumberId` and `allowedPhoneCountries`.
|
|
178
|
+
* - `messenger`: the client authorizes with Facebook and picks a Facebook Page
|
|
179
|
+
* they administer. The Page's Messenger inbox — including Marketplace chats — is
|
|
180
|
+
* routed to Zavu. They must be an admin of at least one Page. A Page can only be
|
|
181
|
+
* connected to one Zavu project at a time: if the client picks a Page that
|
|
182
|
+
* another project already connected, the newer connection wins and the older one
|
|
183
|
+
* is disconnected.
|
|
184
|
+
*
|
|
185
|
+
* One invitation connects one channel. To onboard a client on several channels,
|
|
186
|
+
* create one invitation per channel; each completes into its own sender.
|
|
124
187
|
*/
|
|
125
|
-
connectionType?: 'whatsapp_waba';
|
|
188
|
+
connectionType?: 'whatsapp_waba' | 'messenger';
|
|
126
189
|
/**
|
|
127
190
|
* Number of days until the invitation expires.
|
|
128
191
|
*/
|
|
129
192
|
expiresInDays?: number;
|
|
130
193
|
/**
|
|
131
194
|
* ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
|
|
132
|
-
* the client will use this number instead of their own.
|
|
195
|
+
* the client will use this number instead of their own. Only valid when
|
|
196
|
+
* `connectionType` is `whatsapp_waba` — sending it with `messenger` returns 400,
|
|
197
|
+
* since a Facebook Page has no phone number.
|
|
133
198
|
*/
|
|
134
199
|
phoneNumberId?: string;
|
|
135
200
|
}
|
|
136
201
|
export interface InvitationListParams extends CursorParams {
|
|
137
202
|
/**
|
|
138
203
|
* Current status of the partner invitation.
|
|
204
|
+
*
|
|
205
|
+
* `failed` means the client started the connection and it did not finish (they
|
|
206
|
+
* cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed
|
|
207
|
+
* invitation is still usable: the same link can be retried, and it moves back to
|
|
208
|
+
* `in_progress` when the client tries again.
|
|
139
209
|
*/
|
|
140
|
-
status?: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled';
|
|
210
|
+
status?: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled' | 'failed';
|
|
141
211
|
}
|
|
142
212
|
export declare namespace Invitations {
|
|
143
213
|
export { type Invitation as Invitation, type InvitationCreateResponse as InvitationCreateResponse, type InvitationRetrieveResponse as InvitationRetrieveResponse, type InvitationCancelResponse as InvitationCancelResponse, type InvitationsCursor as InvitationsCursor, type InvitationCreateParams as InvitationCreateParams, type InvitationListParams as InvitationListParams, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invitations.d.ts","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,8BAA2B;AAC5E,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"invitations.d.ts","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,8BAA2B;AAC5E,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,UAAU,CAAC;IAI7C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;AAEnD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAErF,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,cAAc,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAE/C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,UAAU,CAAC;IAC1B;;;;OAIG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,UAAU,GAAG,WAAW,CAAC;QAElC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAE/C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;CACvF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
package/resources/invitations.js
CHANGED
|
@@ -7,12 +7,22 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class Invitations extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Create a partner invitation link for a client to connect
|
|
11
|
-
* opens the returned `url` and
|
|
12
|
-
*
|
|
13
|
-
* project when the client completes the flow, and the invitation transitions to
|
|
10
|
+
* Create a partner invitation link for a client to connect a Meta channel. The
|
|
11
|
+
* client opens the returned `url` and authorizes with Meta; the resulting sender
|
|
12
|
+
* is created in your project when they finish, and the invitation transitions to
|
|
14
13
|
* `completed`.
|
|
15
14
|
*
|
|
15
|
+
* `connectionType` picks the channel:
|
|
16
|
+
*
|
|
17
|
+
* - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
|
|
18
|
+
* Business Account.
|
|
19
|
+
* - `messenger`: the client picks a Facebook Page they administer; its Messenger
|
|
20
|
+
* inbox (including Marketplace chats) is routed to Zavu.
|
|
21
|
+
*
|
|
22
|
+
* One invitation connects one channel — create one per channel to onboard a client
|
|
23
|
+
* on several. `phoneNumberId` and `allowedPhoneCountries` apply to `whatsapp_waba`
|
|
24
|
+
* only.
|
|
25
|
+
*
|
|
16
26
|
* @example
|
|
17
27
|
* ```ts
|
|
18
28
|
* const invitation = await client.invitations.create({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invitations.js","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAE5E,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"invitations.js","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAE5E,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,mBAAkB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,YAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,mBAAmB,YAAY,SAAS,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF;AA9ED,kCA8EC"}
|
|
@@ -4,12 +4,22 @@ import { Cursor } from "../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
5
|
export class Invitations extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Create a partner invitation link for a client to connect
|
|
8
|
-
* opens the returned `url` and
|
|
9
|
-
*
|
|
10
|
-
* project when the client completes the flow, and the invitation transitions to
|
|
7
|
+
* Create a partner invitation link for a client to connect a Meta channel. The
|
|
8
|
+
* client opens the returned `url` and authorizes with Meta; the resulting sender
|
|
9
|
+
* is created in your project when they finish, and the invitation transitions to
|
|
11
10
|
* `completed`.
|
|
12
11
|
*
|
|
12
|
+
* `connectionType` picks the channel:
|
|
13
|
+
*
|
|
14
|
+
* - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
|
|
15
|
+
* Business Account.
|
|
16
|
+
* - `messenger`: the client picks a Facebook Page they administer; its Messenger
|
|
17
|
+
* inbox (including Marketplace chats) is routed to Zavu.
|
|
18
|
+
*
|
|
19
|
+
* One invitation connects one channel — create one per channel to onboard a client
|
|
20
|
+
* on several. `phoneNumberId` and `allowedPhoneCountries` apply to `whatsapp_waba`
|
|
21
|
+
* only.
|
|
22
|
+
*
|
|
13
23
|
* @example
|
|
14
24
|
* ```ts
|
|
15
25
|
* const invitation = await client.invitations.create({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invitations.mjs","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,MAAM,EAAkC,+BAA2B;AAE5E,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"invitations.mjs","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,MAAM,EAAkC,+BAA2B;AAE5E,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,MAAkB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,YAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,mBAAmB,YAAY,SAAS,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF"}
|
package/resources/messages.d.mts
CHANGED
|
@@ -53,10 +53,19 @@ export declare class Messages extends APIResource {
|
|
|
53
53
|
* - Window opens when the user messages you first
|
|
54
54
|
* - Use template messages to initiate conversations outside the window
|
|
55
55
|
*
|
|
56
|
-
* **
|
|
56
|
+
* **Plan allowances and email billing:**
|
|
57
57
|
*
|
|
58
|
-
* -
|
|
59
|
-
*
|
|
58
|
+
* - WhatsApp, Telegram, Instagram and Messenger share an allowance of 2,000
|
|
59
|
+
* messages per month on Free. Over it, sends return 429 with code
|
|
60
|
+
* `a2p_limit_exceeded` and upgrade details; the counter resets on the 1st of
|
|
61
|
+
* each month. Paid plans have no message caps
|
|
62
|
+
* - Email is billed from your prepaid balance in 1,000-message blocks: $0.40 per
|
|
63
|
+
* 1,000 transactional emails, $0.80 per 1,000 marketing (broadcast) emails. A
|
|
64
|
+
* block is charged when your monthly count crosses each 1,000 boundary, and at
|
|
65
|
+
* zero balance email sends return 402 with code `insufficient_balance`. Free
|
|
66
|
+
* teams start with $2 of credit and additionally cap at 3,000 emails/month and
|
|
67
|
+
* 100/day. Teams on earlier plans keep their original email quotas instead
|
|
68
|
+
* - SMS and voice are billed per message from your balance on every plan
|
|
60
69
|
*
|
|
61
70
|
* **Email recipient pre-flight:** Email messages are validated automatically
|
|
62
71
|
* before dispatch. Sends that would be a guaranteed hard bounce are failed instead
|
|
@@ -109,6 +118,20 @@ export interface Message {
|
|
|
109
118
|
/**
|
|
110
119
|
* Type of message. Non-text types are supported by WhatsApp and Telegram (varies
|
|
111
120
|
* by type).
|
|
121
|
+
*
|
|
122
|
+
* `location_request` asks the recipient to share their location and is
|
|
123
|
+
* WhatsApp-only. It takes no `content` object — the prompt goes in `text` (max
|
|
124
|
+
* 1024 characters) and the button label is fixed by WhatsApp. The recipient's
|
|
125
|
+
* answer arrives as an inbound `location` message whose `content.replyToMessageId`
|
|
126
|
+
* is the ID of the request.
|
|
127
|
+
*
|
|
128
|
+
* `request_contact_info` asks the recipient to share their phone number and is
|
|
129
|
+
* WhatsApp-only. Like `location_request` it takes no `content` object — the prompt
|
|
130
|
+
* goes in `text` (max 1024 characters) and WhatsApp renders a fixed **Share
|
|
131
|
+
* Contact Info** button. The answer arrives as an inbound `contact` message. Use
|
|
132
|
+
* it to recover the phone number of a contact who adopted a WhatsApp username and
|
|
133
|
+
* is only known by their business-scoped user ID (BSUID); when they share it, Zavu
|
|
134
|
+
* automatically links the phone number to that contact.
|
|
112
135
|
*/
|
|
113
136
|
messageType: MessageType;
|
|
114
137
|
status: MessageStatus;
|
|
@@ -337,8 +360,22 @@ export type MessageStatus = 'queued' | 'sending' | 'sent' | 'delivered' | 'read'
|
|
|
337
360
|
/**
|
|
338
361
|
* Type of message. Non-text types are supported by WhatsApp and Telegram (varies
|
|
339
362
|
* by type).
|
|
363
|
+
*
|
|
364
|
+
* `location_request` asks the recipient to share their location and is
|
|
365
|
+
* WhatsApp-only. It takes no `content` object — the prompt goes in `text` (max
|
|
366
|
+
* 1024 characters) and the button label is fixed by WhatsApp. The recipient's
|
|
367
|
+
* answer arrives as an inbound `location` message whose `content.replyToMessageId`
|
|
368
|
+
* is the ID of the request.
|
|
369
|
+
*
|
|
370
|
+
* `request_contact_info` asks the recipient to share their phone number and is
|
|
371
|
+
* WhatsApp-only. Like `location_request` it takes no `content` object — the prompt
|
|
372
|
+
* goes in `text` (max 1024 characters) and WhatsApp renders a fixed **Share
|
|
373
|
+
* Contact Info** button. The answer arrives as an inbound `contact` message. Use
|
|
374
|
+
* it to recover the phone number of a contact who adopted a WhatsApp username and
|
|
375
|
+
* is only known by their business-scoped user ID (BSUID); when they share it, Zavu
|
|
376
|
+
* automatically links the phone number to that contact.
|
|
340
377
|
*/
|
|
341
|
-
export type MessageType = 'text' | 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'location' | 'contact' | 'buttons' | 'list' | 'cta_url' | 'reaction' | 'template';
|
|
378
|
+
export type MessageType = 'text' | 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'location' | 'contact' | 'buttons' | 'list' | 'cta_url' | 'request_contact_info' | 'location_request' | 'reaction' | 'template';
|
|
342
379
|
export interface MessageShowTypingResponse {
|
|
343
380
|
success: boolean;
|
|
344
381
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,+BAA2B;AAE5E,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;IAIvC;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAY9B
|
|
1
|
+
{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,+BAA2B;AAE5E,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;IAIvC;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAY9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAYtF;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAUzC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,OAAO,GACf,MAAM,GACN,KAAK,GACL,YAAY,GACZ,UAAU,GACV,UAAU,GACV,OAAO,GACP,WAAW,GACX,WAAW,GACX,OAAO,CAAC;AAEZ,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB,MAAM,EAAE,aAAa,CAAC;IAEtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;IAExD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzC;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpD;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,OAAO;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACxB;IAED,UAAiB,OAAO;QACtB,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEzB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,GAAG;YAClB,EAAE,EAAE,MAAM,CAAC;YAEX,KAAK,EAAE,MAAM,CAAC;YAEd,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,SAAS,GACT,MAAM,GACN,WAAW,GACX,MAAM,GACN,QAAQ,GACR,UAAU,GACV,0BAA0B,CAAC;AAE/B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,UAAU,GACV,SAAS,GACT,UAAU,GACV,SAAS,GACT,SAAS,GACT,MAAM,GACN,SAAS,GACT,sBAAsB,GACtB,kBAAkB,GAClB,UAAU,GACV,UAAU,CAAC;AAEf,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,YAAY,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;IAEzG;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;IAE7E,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAElD;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
package/resources/messages.d.ts
CHANGED
|
@@ -53,10 +53,19 @@ export declare class Messages extends APIResource {
|
|
|
53
53
|
* - Window opens when the user messages you first
|
|
54
54
|
* - Use template messages to initiate conversations outside the window
|
|
55
55
|
*
|
|
56
|
-
* **
|
|
56
|
+
* **Plan allowances and email billing:**
|
|
57
57
|
*
|
|
58
|
-
* -
|
|
59
|
-
*
|
|
58
|
+
* - WhatsApp, Telegram, Instagram and Messenger share an allowance of 2,000
|
|
59
|
+
* messages per month on Free. Over it, sends return 429 with code
|
|
60
|
+
* `a2p_limit_exceeded` and upgrade details; the counter resets on the 1st of
|
|
61
|
+
* each month. Paid plans have no message caps
|
|
62
|
+
* - Email is billed from your prepaid balance in 1,000-message blocks: $0.40 per
|
|
63
|
+
* 1,000 transactional emails, $0.80 per 1,000 marketing (broadcast) emails. A
|
|
64
|
+
* block is charged when your monthly count crosses each 1,000 boundary, and at
|
|
65
|
+
* zero balance email sends return 402 with code `insufficient_balance`. Free
|
|
66
|
+
* teams start with $2 of credit and additionally cap at 3,000 emails/month and
|
|
67
|
+
* 100/day. Teams on earlier plans keep their original email quotas instead
|
|
68
|
+
* - SMS and voice are billed per message from your balance on every plan
|
|
60
69
|
*
|
|
61
70
|
* **Email recipient pre-flight:** Email messages are validated automatically
|
|
62
71
|
* before dispatch. Sends that would be a guaranteed hard bounce are failed instead
|
|
@@ -109,6 +118,20 @@ export interface Message {
|
|
|
109
118
|
/**
|
|
110
119
|
* Type of message. Non-text types are supported by WhatsApp and Telegram (varies
|
|
111
120
|
* by type).
|
|
121
|
+
*
|
|
122
|
+
* `location_request` asks the recipient to share their location and is
|
|
123
|
+
* WhatsApp-only. It takes no `content` object — the prompt goes in `text` (max
|
|
124
|
+
* 1024 characters) and the button label is fixed by WhatsApp. The recipient's
|
|
125
|
+
* answer arrives as an inbound `location` message whose `content.replyToMessageId`
|
|
126
|
+
* is the ID of the request.
|
|
127
|
+
*
|
|
128
|
+
* `request_contact_info` asks the recipient to share their phone number and is
|
|
129
|
+
* WhatsApp-only. Like `location_request` it takes no `content` object — the prompt
|
|
130
|
+
* goes in `text` (max 1024 characters) and WhatsApp renders a fixed **Share
|
|
131
|
+
* Contact Info** button. The answer arrives as an inbound `contact` message. Use
|
|
132
|
+
* it to recover the phone number of a contact who adopted a WhatsApp username and
|
|
133
|
+
* is only known by their business-scoped user ID (BSUID); when they share it, Zavu
|
|
134
|
+
* automatically links the phone number to that contact.
|
|
112
135
|
*/
|
|
113
136
|
messageType: MessageType;
|
|
114
137
|
status: MessageStatus;
|
|
@@ -337,8 +360,22 @@ export type MessageStatus = 'queued' | 'sending' | 'sent' | 'delivered' | 'read'
|
|
|
337
360
|
/**
|
|
338
361
|
* Type of message. Non-text types are supported by WhatsApp and Telegram (varies
|
|
339
362
|
* by type).
|
|
363
|
+
*
|
|
364
|
+
* `location_request` asks the recipient to share their location and is
|
|
365
|
+
* WhatsApp-only. It takes no `content` object — the prompt goes in `text` (max
|
|
366
|
+
* 1024 characters) and the button label is fixed by WhatsApp. The recipient's
|
|
367
|
+
* answer arrives as an inbound `location` message whose `content.replyToMessageId`
|
|
368
|
+
* is the ID of the request.
|
|
369
|
+
*
|
|
370
|
+
* `request_contact_info` asks the recipient to share their phone number and is
|
|
371
|
+
* WhatsApp-only. Like `location_request` it takes no `content` object — the prompt
|
|
372
|
+
* goes in `text` (max 1024 characters) and WhatsApp renders a fixed **Share
|
|
373
|
+
* Contact Info** button. The answer arrives as an inbound `contact` message. Use
|
|
374
|
+
* it to recover the phone number of a contact who adopted a WhatsApp username and
|
|
375
|
+
* is only known by their business-scoped user ID (BSUID); when they share it, Zavu
|
|
376
|
+
* automatically links the phone number to that contact.
|
|
340
377
|
*/
|
|
341
|
-
export type MessageType = 'text' | 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'location' | 'contact' | 'buttons' | 'list' | 'cta_url' | 'reaction' | 'template';
|
|
378
|
+
export type MessageType = 'text' | 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'location' | 'contact' | 'buttons' | 'list' | 'cta_url' | 'request_contact_info' | 'location_request' | 'reaction' | 'template';
|
|
342
379
|
export interface MessageShowTypingResponse {
|
|
343
380
|
success: boolean;
|
|
344
381
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,8BAA2B;AAE5E,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;IAIvC;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAY9B
|
|
1
|
+
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,8BAA2B;AAE5E,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;IAIvC;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAY9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAYtF;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAUzC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,OAAO,GACf,MAAM,GACN,KAAK,GACL,YAAY,GACZ,UAAU,GACV,UAAU,GACV,OAAO,GACP,WAAW,GACX,WAAW,GACX,OAAO,CAAC;AAEZ,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB,MAAM,EAAE,aAAa,CAAC;IAEtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;IAExD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzC;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpD;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,OAAO;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACxB;IAED,UAAiB,OAAO;QACtB,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEzB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,GAAG;YAClB,EAAE,EAAE,MAAM,CAAC;YAEX,KAAK,EAAE,MAAM,CAAC;YAEd,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,SAAS,GACT,MAAM,GACN,WAAW,GACX,MAAM,GACN,QAAQ,GACR,UAAU,GACV,0BAA0B,CAAC;AAE/B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,UAAU,GACV,SAAS,GACT,UAAU,GACV,SAAS,GACT,SAAS,GACT,MAAM,GACN,SAAS,GACT,sBAAsB,GACtB,kBAAkB,GAClB,UAAU,GACV,UAAU,CAAC;AAEf,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,YAAY,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;IAEzG;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;IAE7E,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAElD;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
package/resources/messages.js
CHANGED
|
@@ -71,10 +71,19 @@ class Messages extends resource_1.APIResource {
|
|
|
71
71
|
* - Window opens when the user messages you first
|
|
72
72
|
* - Use template messages to initiate conversations outside the window
|
|
73
73
|
*
|
|
74
|
-
* **
|
|
74
|
+
* **Plan allowances and email billing:**
|
|
75
75
|
*
|
|
76
|
-
* -
|
|
77
|
-
*
|
|
76
|
+
* - WhatsApp, Telegram, Instagram and Messenger share an allowance of 2,000
|
|
77
|
+
* messages per month on Free. Over it, sends return 429 with code
|
|
78
|
+
* `a2p_limit_exceeded` and upgrade details; the counter resets on the 1st of
|
|
79
|
+
* each month. Paid plans have no message caps
|
|
80
|
+
* - Email is billed from your prepaid balance in 1,000-message blocks: $0.40 per
|
|
81
|
+
* 1,000 transactional emails, $0.80 per 1,000 marketing (broadcast) emails. A
|
|
82
|
+
* block is charged when your monthly count crosses each 1,000 boundary, and at
|
|
83
|
+
* zero balance email sends return 402 with code `insufficient_balance`. Free
|
|
84
|
+
* teams start with $2 of credit and additionally cap at 3,000 emails/month and
|
|
85
|
+
* 100/day. Teams on earlier plans keep their original email quotas instead
|
|
86
|
+
* - SMS and voice are billed per message from your balance on every plan
|
|
78
87
|
*
|
|
79
88
|
* **Email recipient pre-flight:** Email messages are validated automatically
|
|
80
89
|
* before dispatch. Sends that would be a guaranteed hard bounce are failed instead
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAC5E,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,mBAAe,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAiB,EACjB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,YAAY,EAAE;YAClE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAC5E,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,mBAAe,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAiB,EACjB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,YAAY,EAAE;YAClE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAiB,EACjB,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,SAAS,EAAE;YAC/D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AApJD,4BAoJC"}
|
package/resources/messages.mjs
CHANGED
|
@@ -68,10 +68,19 @@ export class Messages extends APIResource {
|
|
|
68
68
|
* - Window opens when the user messages you first
|
|
69
69
|
* - Use template messages to initiate conversations outside the window
|
|
70
70
|
*
|
|
71
|
-
* **
|
|
71
|
+
* **Plan allowances and email billing:**
|
|
72
72
|
*
|
|
73
|
-
* -
|
|
74
|
-
*
|
|
73
|
+
* - WhatsApp, Telegram, Instagram and Messenger share an allowance of 2,000
|
|
74
|
+
* messages per month on Free. Over it, sends return 429 with code
|
|
75
|
+
* `a2p_limit_exceeded` and upgrade details; the counter resets on the 1st of
|
|
76
|
+
* each month. Paid plans have no message caps
|
|
77
|
+
* - Email is billed from your prepaid balance in 1,000-message blocks: $0.40 per
|
|
78
|
+
* 1,000 transactional emails, $0.80 per 1,000 marketing (broadcast) emails. A
|
|
79
|
+
* block is charged when your monthly count crosses each 1,000 boundary, and at
|
|
80
|
+
* zero balance email sends return 402 with code `insufficient_balance`. Free
|
|
81
|
+
* teams start with $2 of credit and additionally cap at 3,000 emails/month and
|
|
82
|
+
* 100/day. Teams on earlier plans keep their original email quotas instead
|
|
83
|
+
* - SMS and voice are billed per message from your balance on every plan
|
|
75
84
|
*
|
|
76
85
|
* **Email recipient pre-flight:** Email messages are validated automatically
|
|
77
86
|
* before dispatch. Sends that would be a guaranteed hard bounce are failed instead
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,MAAM,EAAkC,+BAA2B;AAC5E,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,MAAe,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAiB,EACjB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,YAAY,EAAE;YAClE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,MAAM,EAAkC,+BAA2B;AAC5E,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,MAAe,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CACH,SAAiB,EACjB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,YAAY,EAAE;YAClE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAiB,EACjB,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE;YAC/D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -82,7 +82,11 @@ export declare class Brands extends APIResource {
|
|
|
82
82
|
listUseCases(options?: RequestOptions): APIPromise<BrandListUseCasesResponse>;
|
|
83
83
|
/**
|
|
84
84
|
* Submit a draft brand to The Campaign Registry (TCR) for vetting. The brand must
|
|
85
|
-
* be in draft status.
|
|
85
|
+
* be in draft status. TCR's one-time $4 brand registration fee is charged from
|
|
86
|
+
* your balance at submission (passed through at cost) and refunded if the carrier
|
|
87
|
+
* rejects the registration. A team that already paid this fee through the
|
|
88
|
+
* compliance flow is not charged again. Campaign registration is billed separately
|
|
89
|
+
* when a campaign is submitted.
|
|
86
90
|
*
|
|
87
91
|
* @example
|
|
88
92
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"brands.d.mts","sourceRoot":"","sources":["../../src/resources/number-10dlc/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,kCAA8B;AAE/E,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI1F;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;;;OASG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAI/C;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI7E
|
|
1
|
+
{"version":3,"file":"brands.d.mts","sourceRoot":"","sources":["../../src/resources/number-10dlc/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,kCAA8B;AAE/E,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI1F;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;;;OASG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAI/C;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI7E;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG3F;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAErD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,CAAC;IAEjG;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;CACpD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,CAAC;IAEjG;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,CAAC;IAElG,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAAG;AAExD,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
|
|
@@ -82,7 +82,11 @@ export declare class Brands extends APIResource {
|
|
|
82
82
|
listUseCases(options?: RequestOptions): APIPromise<BrandListUseCasesResponse>;
|
|
83
83
|
/**
|
|
84
84
|
* Submit a draft brand to The Campaign Registry (TCR) for vetting. The brand must
|
|
85
|
-
* be in draft status.
|
|
85
|
+
* be in draft status. TCR's one-time $4 brand registration fee is charged from
|
|
86
|
+
* your balance at submission (passed through at cost) and refunded if the carrier
|
|
87
|
+
* rejects the registration. A team that already paid this fee through the
|
|
88
|
+
* compliance flow is not charged again. Campaign registration is billed separately
|
|
89
|
+
* when a campaign is submitted.
|
|
86
90
|
*
|
|
87
91
|
* @example
|
|
88
92
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../../src/resources/number-10dlc/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,iCAA8B;AAE/E,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI1F;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;;;OASG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAI/C;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI7E
|
|
1
|
+
{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../../src/resources/number-10dlc/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,iCAA8B;AAE/E,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI1F;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItF;;;;;;;;;OASG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAI/C;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI7E;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG3F;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAErD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,CAAC;IAEjG;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;CACpD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,CAAC;IAEjG;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,CAAC;IAElG,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAAG;AAExD,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
|
|
@@ -101,7 +101,11 @@ class Brands extends resource_1.APIResource {
|
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
103
|
* Submit a draft brand to The Campaign Registry (TCR) for vetting. The brand must
|
|
104
|
-
* be in draft status.
|
|
104
|
+
* be in draft status. TCR's one-time $4 brand registration fee is charged from
|
|
105
|
+
* your balance at submission (passed through at cost) and refunded if the carrier
|
|
106
|
+
* rejects the registration. A team that already paid this fee through the
|
|
107
|
+
* compliance flow is not charged again. Campaign registration is billed separately
|
|
108
|
+
* when a campaign is submitted.
|
|
105
109
|
*
|
|
106
110
|
* @example
|
|
107
111
|
* ```ts
|