@surgeapi/node 0.26.0 → 0.27.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 +31 -0
- package/client.d.mts +16 -16
- package/client.d.mts.map +1 -1
- package/client.d.ts +16 -16
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs +2 -2
- package/client.mjs.map +1 -1
- package/internal/to-file.d.mts +1 -1
- package/internal/to-file.d.ts +1 -1
- package/internal/to-file.js +1 -1
- package/internal/to-file.mjs +1 -1
- package/package.json +1 -1
- package/resources/accounts.d.mts +292 -191
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +292 -191
- package/resources/accounts.d.ts.map +1 -1
- package/resources/blasts.d.mts +11 -32
- package/resources/blasts.d.mts.map +1 -1
- package/resources/blasts.d.ts +11 -32
- package/resources/blasts.d.ts.map +1 -1
- package/resources/blasts.js.map +1 -1
- package/resources/blasts.mjs.map +1 -1
- package/resources/campaigns.d.mts +1 -103
- package/resources/campaigns.d.mts.map +1 -1
- package/resources/campaigns.d.ts +1 -103
- package/resources/campaigns.d.ts.map +1 -1
- package/resources/contacts.d.mts +1 -28
- package/resources/contacts.d.mts.map +1 -1
- package/resources/contacts.d.ts +1 -28
- package/resources/contacts.d.ts.map +1 -1
- package/resources/index.d.mts +8 -8
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +8 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/messages.d.mts +49 -81
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +49 -81
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs.map +1 -1
- package/resources/phone-numbers.d.mts +0 -30
- package/resources/phone-numbers.d.mts.map +1 -1
- package/resources/phone-numbers.d.ts +0 -30
- package/resources/phone-numbers.d.ts.map +1 -1
- package/resources/users.d.mts +1 -33
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +1 -33
- package/resources/users.d.ts.map +1 -1
- package/resources/verifications.d.mts +1 -19
- package/resources/verifications.d.mts.map +1 -1
- package/resources/verifications.d.ts +1 -19
- package/resources/verifications.d.ts.map +1 -1
- package/resources/webhooks.d.mts +60 -41
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +60 -41
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +12 -43
- package/src/internal/to-file.ts +1 -1
- package/src/resources/accounts.ts +475 -284
- package/src/resources/blasts.ts +11 -42
- package/src/resources/campaigns.ts +1 -127
- package/src/resources/contacts.ts +0 -31
- package/src/resources/index.ts +8 -23
- package/src/resources/messages.ts +54 -99
- package/src/resources/phone-numbers.ts +0 -34
- package/src/resources/users.ts +0 -37
- package/src/resources/verifications.ts +1 -22
- package/src/resources/webhooks.ts +72 -39
- 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
package/resources/blasts.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
|
-
import * as MessagesAPI from "./messages.mjs";
|
|
3
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
3
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
4
|
export declare class Blasts extends APIResource {
|
|
@@ -45,11 +44,8 @@ export declare namespace Blast {
|
|
|
45
44
|
url?: string;
|
|
46
45
|
}
|
|
47
46
|
}
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
*/
|
|
51
|
-
export interface BlastParams {
|
|
52
|
-
attachments?: Array<MessagesAPI.AttachmentParams>;
|
|
47
|
+
export interface BlastCreateParams {
|
|
48
|
+
attachments?: Array<BlastCreateParams.Attachment>;
|
|
53
49
|
/**
|
|
54
50
|
* The message body.
|
|
55
51
|
*/
|
|
@@ -76,35 +72,18 @@ export interface BlastParams {
|
|
|
76
72
|
*/
|
|
77
73
|
to?: Array<string>;
|
|
78
74
|
}
|
|
79
|
-
export
|
|
80
|
-
attachments?: Array<MessagesAPI.AttachmentParams>;
|
|
81
|
-
/**
|
|
82
|
-
* The message body.
|
|
83
|
-
*/
|
|
84
|
-
body?: string;
|
|
85
|
-
/**
|
|
86
|
-
* @deprecated Deprecated. Use `to` instead.
|
|
87
|
-
*/
|
|
88
|
-
contacts?: Array<string>;
|
|
89
|
-
/**
|
|
90
|
-
* Optional name for the blast.
|
|
91
|
-
*/
|
|
92
|
-
name?: string;
|
|
75
|
+
export declare namespace BlastCreateParams {
|
|
93
76
|
/**
|
|
94
|
-
*
|
|
95
|
-
*/
|
|
96
|
-
segments?: Array<string>;
|
|
97
|
-
/**
|
|
98
|
-
* When to send the blast. If not provided, sends immediately.
|
|
99
|
-
*/
|
|
100
|
-
send_at?: string;
|
|
101
|
-
/**
|
|
102
|
-
* List of recipients to whom the blast should be sent. This can be a combination
|
|
103
|
-
* of contact IDs, segment IDs, and phone numbers.
|
|
77
|
+
* Params for creating an attachment
|
|
104
78
|
*/
|
|
105
|
-
|
|
79
|
+
interface Attachment {
|
|
80
|
+
/**
|
|
81
|
+
* The URL of the attachment.
|
|
82
|
+
*/
|
|
83
|
+
url: string;
|
|
84
|
+
}
|
|
106
85
|
}
|
|
107
86
|
export declare namespace Blasts {
|
|
108
|
-
export { type Blast as Blast, type
|
|
87
|
+
export { type Blast as Blast, type BlastCreateParams as BlastCreateParams };
|
|
109
88
|
}
|
|
110
89
|
//# sourceMappingURL=blasts.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blasts.d.mts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,
|
|
1
|
+
{"version":3,"file":"blasts.d.mts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CAC7E"}
|
package/resources/blasts.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
|
-
import * as MessagesAPI from "./messages.js";
|
|
3
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
4
3
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
4
|
export declare class Blasts extends APIResource {
|
|
@@ -45,11 +44,8 @@ export declare namespace Blast {
|
|
|
45
44
|
url?: string;
|
|
46
45
|
}
|
|
47
46
|
}
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
*/
|
|
51
|
-
export interface BlastParams {
|
|
52
|
-
attachments?: Array<MessagesAPI.AttachmentParams>;
|
|
47
|
+
export interface BlastCreateParams {
|
|
48
|
+
attachments?: Array<BlastCreateParams.Attachment>;
|
|
53
49
|
/**
|
|
54
50
|
* The message body.
|
|
55
51
|
*/
|
|
@@ -76,35 +72,18 @@ export interface BlastParams {
|
|
|
76
72
|
*/
|
|
77
73
|
to?: Array<string>;
|
|
78
74
|
}
|
|
79
|
-
export
|
|
80
|
-
attachments?: Array<MessagesAPI.AttachmentParams>;
|
|
81
|
-
/**
|
|
82
|
-
* The message body.
|
|
83
|
-
*/
|
|
84
|
-
body?: string;
|
|
85
|
-
/**
|
|
86
|
-
* @deprecated Deprecated. Use `to` instead.
|
|
87
|
-
*/
|
|
88
|
-
contacts?: Array<string>;
|
|
89
|
-
/**
|
|
90
|
-
* Optional name for the blast.
|
|
91
|
-
*/
|
|
92
|
-
name?: string;
|
|
75
|
+
export declare namespace BlastCreateParams {
|
|
93
76
|
/**
|
|
94
|
-
*
|
|
95
|
-
*/
|
|
96
|
-
segments?: Array<string>;
|
|
97
|
-
/**
|
|
98
|
-
* When to send the blast. If not provided, sends immediately.
|
|
99
|
-
*/
|
|
100
|
-
send_at?: string;
|
|
101
|
-
/**
|
|
102
|
-
* List of recipients to whom the blast should be sent. This can be a combination
|
|
103
|
-
* of contact IDs, segment IDs, and phone numbers.
|
|
77
|
+
* Params for creating an attachment
|
|
104
78
|
*/
|
|
105
|
-
|
|
79
|
+
interface Attachment {
|
|
80
|
+
/**
|
|
81
|
+
* The URL of the attachment.
|
|
82
|
+
*/
|
|
83
|
+
url: string;
|
|
84
|
+
}
|
|
106
85
|
}
|
|
107
86
|
export declare namespace Blasts {
|
|
108
|
-
export { type Blast as Blast, type
|
|
87
|
+
export { type Blast as Blast, type BlastCreateParams as BlastCreateParams };
|
|
109
88
|
}
|
|
110
89
|
//# sourceMappingURL=blasts.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blasts.d.ts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,
|
|
1
|
+
{"version":3,"file":"blasts.d.ts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CAC7E"}
|
package/resources/blasts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blasts.js","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;
|
|
1
|
+
{"version":3,"file":"blasts.js","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAuB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAdD,wBAcC"}
|
package/resources/blasts.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blasts.mjs","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"blasts.mjs","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAuB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF"}
|
|
@@ -139,108 +139,6 @@ export interface Campaign {
|
|
|
139
139
|
*/
|
|
140
140
|
terms_and_conditions_url?: string;
|
|
141
141
|
}
|
|
142
|
-
/**
|
|
143
|
-
* Parameters for creating a new campaign
|
|
144
|
-
*/
|
|
145
|
-
export interface CampaignParams {
|
|
146
|
-
/**
|
|
147
|
-
* A string explaining the method through which end users will opt in to receive
|
|
148
|
-
* messages from the brand. Typically this should include URLs for opt-in forms or
|
|
149
|
-
* screenshots that might be helpful in explaining the flow to someone unfamiliar
|
|
150
|
-
* with the organization's purpose.
|
|
151
|
-
*/
|
|
152
|
-
consent_flow: string;
|
|
153
|
-
/**
|
|
154
|
-
* An explanation of the organization's purpose and how it will be using text
|
|
155
|
-
* messaging to accomplish that purpose.
|
|
156
|
-
*/
|
|
157
|
-
description: string;
|
|
158
|
-
/**
|
|
159
|
-
* An array of 2-5 strings with examples of the messages that will be sent from
|
|
160
|
-
* this campaign. Typically the first sample should be a compliance message like
|
|
161
|
-
* `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
|
|
162
|
-
* These samples don't necessarily need to be the only templates that will be used
|
|
163
|
-
* for the campaign, but they should reflect the purpose of the messages that will
|
|
164
|
-
* be sent. Any variable content can be reflected by wrapping it in square brackets
|
|
165
|
-
* like `[customer name]`.
|
|
166
|
-
*/
|
|
167
|
-
message_samples: Array<string>;
|
|
168
|
-
/**
|
|
169
|
-
* The URL of the privacy policy for the brand in question. This may be a shared
|
|
170
|
-
* privacy policy if it's the policy that is displayed to end users when they opt
|
|
171
|
-
* in to messaging.
|
|
172
|
-
*/
|
|
173
|
-
privacy_policy_url: string;
|
|
174
|
-
/**
|
|
175
|
-
* A list containing 1-5 types of messages that will be sent with this campaign.
|
|
176
|
-
*
|
|
177
|
-
* The following use cases are typically available to all brands:
|
|
178
|
-
*
|
|
179
|
-
* - `account_notification` - For sending reminders, alerts, and general
|
|
180
|
-
* account-related notifications like booking confirmations or appointment
|
|
181
|
-
* reminders.
|
|
182
|
-
* - `customer_care` - For account support, troubleshooting, and general customer
|
|
183
|
-
* service communication.
|
|
184
|
-
* - `delivery_notification` - For notifying customers about the status of product
|
|
185
|
-
* or service deliveries.
|
|
186
|
-
* - `fraud_alert` - For warning customers about suspicious or potentially
|
|
187
|
-
* fraudulent activity.
|
|
188
|
-
* - `higher_education` - For messaging related to colleges, universities, and
|
|
189
|
-
* school districts outside of K–12.
|
|
190
|
-
* - `marketing` - For promotional or advertising messages intended to market
|
|
191
|
-
* products or services.
|
|
192
|
-
* - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
|
|
193
|
-
* - `public_service_announcement` - For raising awareness about social issues or
|
|
194
|
-
* important public information.
|
|
195
|
-
* - `security_alert` - For alerts related to potential security breaches or
|
|
196
|
-
* compromised systems requiring user action.
|
|
197
|
-
* - `two_factor_authentication` - For sending one-time passwords or verification
|
|
198
|
-
* codes for login or password reset.
|
|
199
|
-
*
|
|
200
|
-
* For access to special use cases not shown here, reach out to support@surge.app.
|
|
201
|
-
*/
|
|
202
|
-
use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
|
|
203
|
-
/**
|
|
204
|
-
* This will be one of the following:
|
|
205
|
-
*
|
|
206
|
-
* - `low` - The campaign will be allowed to send up to 2000 SMS segments to
|
|
207
|
-
* T-Mobile customers each day. In this case your platform will be charged for
|
|
208
|
-
* the setup fee for a low volume number upon receipt of the API request.
|
|
209
|
-
* - `high` - The campaign will be allowed to send up to 200k SMS segments to
|
|
210
|
-
* T-Mobile customers each day, depending on the trust score assigned by The
|
|
211
|
-
* Campaign Registry. Your platform will be charged for the setup fee for a high
|
|
212
|
-
* volume number upon receipt of the API request, and phone numbers will be
|
|
213
|
-
* charged as high volume numbers going forward.
|
|
214
|
-
*/
|
|
215
|
-
volume: 'high' | 'low';
|
|
216
|
-
/**
|
|
217
|
-
* A list of properties that this campaign should include. These properties can be
|
|
218
|
-
* any of the following values:
|
|
219
|
-
*
|
|
220
|
-
* - `links` - whether the campaign might send links in messages
|
|
221
|
-
* - `phone_numbers` - whether the campaign might send phone numbers in messages
|
|
222
|
-
* - `age_gated` - whether the campaign contains age gated content (controlled
|
|
223
|
-
* substances or adult content)
|
|
224
|
-
* - `direct_lending` - whether the campaign contains content related to direct
|
|
225
|
-
* lending or other loan arrangements
|
|
226
|
-
*/
|
|
227
|
-
includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
|
|
228
|
-
/**
|
|
229
|
-
* A sample link that might be sent by this campaign. If links from other domains
|
|
230
|
-
* are sent through this campaign, they are much more likely to be filtered by the
|
|
231
|
-
* carriers. If link shortening is enabled for the account, the link shortener URL
|
|
232
|
-
* will be used instead of what is provided. Reach out to support if you would like
|
|
233
|
-
* to disable automatic link shortening.
|
|
234
|
-
*/
|
|
235
|
-
link_sample?: string;
|
|
236
|
-
/**
|
|
237
|
-
* The URL of the terms and conditions presented to end users when they opt in to
|
|
238
|
-
* messaging. These terms and conditions may be shared among all of a platform's
|
|
239
|
-
* customers if they're the terms that are presented to end users when they opt in
|
|
240
|
-
* to messaging.
|
|
241
|
-
*/
|
|
242
|
-
terms_and_conditions_url?: string;
|
|
243
|
-
}
|
|
244
142
|
export interface CampaignCreateParams {
|
|
245
143
|
/**
|
|
246
144
|
* A string explaining the method through which end users will opt in to receive
|
|
@@ -341,6 +239,6 @@ export interface CampaignCreateParams {
|
|
|
341
239
|
terms_and_conditions_url?: string;
|
|
342
240
|
}
|
|
343
241
|
export declare namespace Campaigns {
|
|
344
|
-
export { type Campaign as Campaign, type
|
|
242
|
+
export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
|
|
345
243
|
}
|
|
346
244
|
//# sourceMappingURL=campaigns.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"campaigns.d.mts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED
|
|
1
|
+
{"version":3,"file":"campaigns.d.mts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACzF"}
|
package/resources/campaigns.d.ts
CHANGED
|
@@ -139,108 +139,6 @@ export interface Campaign {
|
|
|
139
139
|
*/
|
|
140
140
|
terms_and_conditions_url?: string;
|
|
141
141
|
}
|
|
142
|
-
/**
|
|
143
|
-
* Parameters for creating a new campaign
|
|
144
|
-
*/
|
|
145
|
-
export interface CampaignParams {
|
|
146
|
-
/**
|
|
147
|
-
* A string explaining the method through which end users will opt in to receive
|
|
148
|
-
* messages from the brand. Typically this should include URLs for opt-in forms or
|
|
149
|
-
* screenshots that might be helpful in explaining the flow to someone unfamiliar
|
|
150
|
-
* with the organization's purpose.
|
|
151
|
-
*/
|
|
152
|
-
consent_flow: string;
|
|
153
|
-
/**
|
|
154
|
-
* An explanation of the organization's purpose and how it will be using text
|
|
155
|
-
* messaging to accomplish that purpose.
|
|
156
|
-
*/
|
|
157
|
-
description: string;
|
|
158
|
-
/**
|
|
159
|
-
* An array of 2-5 strings with examples of the messages that will be sent from
|
|
160
|
-
* this campaign. Typically the first sample should be a compliance message like
|
|
161
|
-
* `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
|
|
162
|
-
* These samples don't necessarily need to be the only templates that will be used
|
|
163
|
-
* for the campaign, but they should reflect the purpose of the messages that will
|
|
164
|
-
* be sent. Any variable content can be reflected by wrapping it in square brackets
|
|
165
|
-
* like `[customer name]`.
|
|
166
|
-
*/
|
|
167
|
-
message_samples: Array<string>;
|
|
168
|
-
/**
|
|
169
|
-
* The URL of the privacy policy for the brand in question. This may be a shared
|
|
170
|
-
* privacy policy if it's the policy that is displayed to end users when they opt
|
|
171
|
-
* in to messaging.
|
|
172
|
-
*/
|
|
173
|
-
privacy_policy_url: string;
|
|
174
|
-
/**
|
|
175
|
-
* A list containing 1-5 types of messages that will be sent with this campaign.
|
|
176
|
-
*
|
|
177
|
-
* The following use cases are typically available to all brands:
|
|
178
|
-
*
|
|
179
|
-
* - `account_notification` - For sending reminders, alerts, and general
|
|
180
|
-
* account-related notifications like booking confirmations or appointment
|
|
181
|
-
* reminders.
|
|
182
|
-
* - `customer_care` - For account support, troubleshooting, and general customer
|
|
183
|
-
* service communication.
|
|
184
|
-
* - `delivery_notification` - For notifying customers about the status of product
|
|
185
|
-
* or service deliveries.
|
|
186
|
-
* - `fraud_alert` - For warning customers about suspicious or potentially
|
|
187
|
-
* fraudulent activity.
|
|
188
|
-
* - `higher_education` - For messaging related to colleges, universities, and
|
|
189
|
-
* school districts outside of K–12.
|
|
190
|
-
* - `marketing` - For promotional or advertising messages intended to market
|
|
191
|
-
* products or services.
|
|
192
|
-
* - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
|
|
193
|
-
* - `public_service_announcement` - For raising awareness about social issues or
|
|
194
|
-
* important public information.
|
|
195
|
-
* - `security_alert` - For alerts related to potential security breaches or
|
|
196
|
-
* compromised systems requiring user action.
|
|
197
|
-
* - `two_factor_authentication` - For sending one-time passwords or verification
|
|
198
|
-
* codes for login or password reset.
|
|
199
|
-
*
|
|
200
|
-
* For access to special use cases not shown here, reach out to support@surge.app.
|
|
201
|
-
*/
|
|
202
|
-
use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
|
|
203
|
-
/**
|
|
204
|
-
* This will be one of the following:
|
|
205
|
-
*
|
|
206
|
-
* - `low` - The campaign will be allowed to send up to 2000 SMS segments to
|
|
207
|
-
* T-Mobile customers each day. In this case your platform will be charged for
|
|
208
|
-
* the setup fee for a low volume number upon receipt of the API request.
|
|
209
|
-
* - `high` - The campaign will be allowed to send up to 200k SMS segments to
|
|
210
|
-
* T-Mobile customers each day, depending on the trust score assigned by The
|
|
211
|
-
* Campaign Registry. Your platform will be charged for the setup fee for a high
|
|
212
|
-
* volume number upon receipt of the API request, and phone numbers will be
|
|
213
|
-
* charged as high volume numbers going forward.
|
|
214
|
-
*/
|
|
215
|
-
volume: 'high' | 'low';
|
|
216
|
-
/**
|
|
217
|
-
* A list of properties that this campaign should include. These properties can be
|
|
218
|
-
* any of the following values:
|
|
219
|
-
*
|
|
220
|
-
* - `links` - whether the campaign might send links in messages
|
|
221
|
-
* - `phone_numbers` - whether the campaign might send phone numbers in messages
|
|
222
|
-
* - `age_gated` - whether the campaign contains age gated content (controlled
|
|
223
|
-
* substances or adult content)
|
|
224
|
-
* - `direct_lending` - whether the campaign contains content related to direct
|
|
225
|
-
* lending or other loan arrangements
|
|
226
|
-
*/
|
|
227
|
-
includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
|
|
228
|
-
/**
|
|
229
|
-
* A sample link that might be sent by this campaign. If links from other domains
|
|
230
|
-
* are sent through this campaign, they are much more likely to be filtered by the
|
|
231
|
-
* carriers. If link shortening is enabled for the account, the link shortener URL
|
|
232
|
-
* will be used instead of what is provided. Reach out to support if you would like
|
|
233
|
-
* to disable automatic link shortening.
|
|
234
|
-
*/
|
|
235
|
-
link_sample?: string;
|
|
236
|
-
/**
|
|
237
|
-
* The URL of the terms and conditions presented to end users when they opt in to
|
|
238
|
-
* messaging. These terms and conditions may be shared among all of a platform's
|
|
239
|
-
* customers if they're the terms that are presented to end users when they opt in
|
|
240
|
-
* to messaging.
|
|
241
|
-
*/
|
|
242
|
-
terms_and_conditions_url?: string;
|
|
243
|
-
}
|
|
244
142
|
export interface CampaignCreateParams {
|
|
245
143
|
/**
|
|
246
144
|
* A string explaining the method through which end users will opt in to receive
|
|
@@ -341,6 +239,6 @@ export interface CampaignCreateParams {
|
|
|
341
239
|
terms_and_conditions_url?: string;
|
|
342
240
|
}
|
|
343
241
|
export declare namespace Campaigns {
|
|
344
|
-
export { type Campaign as Campaign, type
|
|
242
|
+
export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
|
|
345
243
|
}
|
|
346
244
|
//# sourceMappingURL=campaigns.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED
|
|
1
|
+
{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACzF"}
|
package/resources/contacts.d.mts
CHANGED
|
@@ -70,33 +70,6 @@ export interface Contact {
|
|
|
70
70
|
[key: string]: string;
|
|
71
71
|
};
|
|
72
72
|
}
|
|
73
|
-
/**
|
|
74
|
-
* Parameters for creating a contact
|
|
75
|
-
*/
|
|
76
|
-
export interface ContactParams {
|
|
77
|
-
/**
|
|
78
|
-
* The contact's phone number in E.164 format.
|
|
79
|
-
*/
|
|
80
|
-
phone_number: string;
|
|
81
|
-
/**
|
|
82
|
-
* The contact's email address.
|
|
83
|
-
*/
|
|
84
|
-
email?: string;
|
|
85
|
-
/**
|
|
86
|
-
* The contact's first name.
|
|
87
|
-
*/
|
|
88
|
-
first_name?: string;
|
|
89
|
-
/**
|
|
90
|
-
* The contact's last name.
|
|
91
|
-
*/
|
|
92
|
-
last_name?: string;
|
|
93
|
-
/**
|
|
94
|
-
* Set of key-value pairs that will be stored with the object.
|
|
95
|
-
*/
|
|
96
|
-
metadata?: {
|
|
97
|
-
[key: string]: string;
|
|
98
|
-
};
|
|
99
|
-
}
|
|
100
73
|
export interface ContactCreateParams {
|
|
101
74
|
/**
|
|
102
75
|
* The contact's phone number in E.164 format.
|
|
@@ -146,6 +119,6 @@ export interface ContactUpdateParams {
|
|
|
146
119
|
};
|
|
147
120
|
}
|
|
148
121
|
export declare namespace Contacts {
|
|
149
|
-
export { type Contact as Contact, type
|
|
122
|
+
export { type Contact as Contact, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, };
|
|
150
123
|
}
|
|
151
124
|
//# sourceMappingURL=contacts.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.d.mts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED
|
|
1
|
+
{"version":3,"file":"contacts.d.mts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
package/resources/contacts.d.ts
CHANGED
|
@@ -70,33 +70,6 @@ export interface Contact {
|
|
|
70
70
|
[key: string]: string;
|
|
71
71
|
};
|
|
72
72
|
}
|
|
73
|
-
/**
|
|
74
|
-
* Parameters for creating a contact
|
|
75
|
-
*/
|
|
76
|
-
export interface ContactParams {
|
|
77
|
-
/**
|
|
78
|
-
* The contact's phone number in E.164 format.
|
|
79
|
-
*/
|
|
80
|
-
phone_number: string;
|
|
81
|
-
/**
|
|
82
|
-
* The contact's email address.
|
|
83
|
-
*/
|
|
84
|
-
email?: string;
|
|
85
|
-
/**
|
|
86
|
-
* The contact's first name.
|
|
87
|
-
*/
|
|
88
|
-
first_name?: string;
|
|
89
|
-
/**
|
|
90
|
-
* The contact's last name.
|
|
91
|
-
*/
|
|
92
|
-
last_name?: string;
|
|
93
|
-
/**
|
|
94
|
-
* Set of key-value pairs that will be stored with the object.
|
|
95
|
-
*/
|
|
96
|
-
metadata?: {
|
|
97
|
-
[key: string]: string;
|
|
98
|
-
};
|
|
99
|
-
}
|
|
100
73
|
export interface ContactCreateParams {
|
|
101
74
|
/**
|
|
102
75
|
* The contact's phone number in E.164 format.
|
|
@@ -146,6 +119,6 @@ export interface ContactUpdateParams {
|
|
|
146
119
|
};
|
|
147
120
|
}
|
|
148
121
|
export declare namespace Contacts {
|
|
149
|
-
export { type Contact as Contact, type
|
|
122
|
+
export { type Contact as Contact, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, };
|
|
150
123
|
}
|
|
151
124
|
//# sourceMappingURL=contacts.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED
|
|
1
|
+
{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
package/resources/index.d.mts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
export * from "./shared.mjs";
|
|
2
|
-
export { Accounts, type Account, type
|
|
3
|
-
export { Blasts, type Blast, type
|
|
4
|
-
export { Campaigns, type Campaign, type
|
|
5
|
-
export { Contacts, type Contact, type
|
|
6
|
-
export { Messages, type
|
|
2
|
+
export { Accounts, type Account, type AccountStatus, type Organization, type AccountCreateParams, type AccountUpdateParams, type AccountRetrieveStatusParams, } from "./accounts.mjs";
|
|
3
|
+
export { Blasts, type Blast, type BlastCreateParams } from "./blasts.mjs";
|
|
4
|
+
export { Campaigns, type Campaign, type CampaignCreateParams } from "./campaigns.mjs";
|
|
5
|
+
export { Contacts, type Contact, type ContactCreateParams, type ContactUpdateParams } from "./contacts.mjs";
|
|
6
|
+
export { Messages, type Message, type MessageCreateParams } from "./messages.mjs";
|
|
7
7
|
export { PhoneNumbers, type PhoneNumber, type PhoneNumberPurchaseParams } from "./phone-numbers.mjs";
|
|
8
|
-
export { Users, type User, type
|
|
9
|
-
export { Verifications, type Verification, type VerificationCheck, type
|
|
10
|
-
export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ConversationCreatedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.mjs";
|
|
8
|
+
export { Users, type User, type UserTokenResponse, type UserCreateParams, type UserUpdateParams, type UserCreateTokenParams, } from "./users.mjs";
|
|
9
|
+
export { Verifications, type Verification, type VerificationCheck, type VerificationCreateParams, type VerificationCheckParams, } from "./verifications.mjs";
|
|
10
|
+
export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ContactOptedInWebhookEvent, type ContactOptedOutWebhookEvent, type ConversationCreatedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.mjs";
|
|
11
11
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,EAAE,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,oBAAoB,EAAE;OACvD,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,mBAAmB,EAAE;OAC9E,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE;OACpD,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,yBAAyB,EAAE;OAClE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC7B;OACM,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,GACxB"}
|
package/resources/index.d.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
export * from "./shared.js";
|
|
2
|
-
export { Accounts, type Account, type
|
|
3
|
-
export { Blasts, type Blast, type
|
|
4
|
-
export { Campaigns, type Campaign, type
|
|
5
|
-
export { Contacts, type Contact, type
|
|
6
|
-
export { Messages, type
|
|
2
|
+
export { Accounts, type Account, type AccountStatus, type Organization, type AccountCreateParams, type AccountUpdateParams, type AccountRetrieveStatusParams, } from "./accounts.js";
|
|
3
|
+
export { Blasts, type Blast, type BlastCreateParams } from "./blasts.js";
|
|
4
|
+
export { Campaigns, type Campaign, type CampaignCreateParams } from "./campaigns.js";
|
|
5
|
+
export { Contacts, type Contact, type ContactCreateParams, type ContactUpdateParams } from "./contacts.js";
|
|
6
|
+
export { Messages, type Message, type MessageCreateParams } from "./messages.js";
|
|
7
7
|
export { PhoneNumbers, type PhoneNumber, type PhoneNumberPurchaseParams } from "./phone-numbers.js";
|
|
8
|
-
export { Users, type User, type
|
|
9
|
-
export { Verifications, type Verification, type VerificationCheck, type
|
|
10
|
-
export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ConversationCreatedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.js";
|
|
8
|
+
export { Users, type User, type UserTokenResponse, type UserCreateParams, type UserUpdateParams, type UserCreateTokenParams, } from "./users.js";
|
|
9
|
+
export { Verifications, type Verification, type VerificationCheck, type VerificationCreateParams, type VerificationCheckParams, } from "./verifications.js";
|
|
10
|
+
export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ContactOptedInWebhookEvent, type ContactOptedOutWebhookEvent, type ConversationCreatedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.js";
|
|
11
11
|
//# sourceMappingURL=index.d.ts.map
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,EAAE,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,oBAAoB,EAAE;OACvD,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,mBAAmB,EAAE;OAC9E,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE;OACpD,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,yBAAyB,EAAE;OAClE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC7B;OACM,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,GACxB"}
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA;AAQV,sCAAsE;AAA7D,gGAAA,MAAM,OAAA;AACf,4CAAkF;AAAzE,sGAAA,SAAS,OAAA;AAClB,0CAAwG;AAA/F,oGAAA,QAAQ,OAAA;AACjB,0CAA8E;AAArE,oGAAA,QAAQ,OAAA;AACjB,oDAAiG;AAAxF,6GAAA,YAAY,OAAA;AACrB,oCAOiB;AANf,8FAAA,KAAK,OAAA;AAOP,oDAMyB;AALvB,8GAAA,aAAa,OAAA;AAMf,0CAYoB;AAXlB,oGAAA,QAAQ,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -3,8 +3,8 @@ export * from "./shared.mjs";
|
|
|
3
3
|
export { Accounts, } from "./accounts.mjs";
|
|
4
4
|
export { Blasts } from "./blasts.mjs";
|
|
5
5
|
export { Campaigns } from "./campaigns.mjs";
|
|
6
|
-
export { Contacts
|
|
7
|
-
export { Messages
|
|
6
|
+
export { Contacts } from "./contacts.mjs";
|
|
7
|
+
export { Messages } from "./messages.mjs";
|
|
8
8
|
export { PhoneNumbers } from "./phone-numbers.mjs";
|
|
9
9
|
export { Users, } from "./users.mjs";
|
|
10
10
|
export { Verifications, } from "./verifications.mjs";
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,QAAQ,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,QAAQ,GAOT;OACM,EAAE,MAAM,EAAsC;OAC9C,EAAE,SAAS,EAA4C;OACvD,EAAE,QAAQ,EAAoE;OAC9E,EAAE,QAAQ,EAA0C;OACpD,EAAE,YAAY,EAAoD;OAClE,EACL,KAAK,GAMN;OACM,EACL,aAAa,GAKd;OACM,EACL,QAAQ,GAWT"}
|