@sentdm/sentdm 0.31.0 → 0.33.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 +9 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -6
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/contacts.d.mts +66 -1
- package/resources/contacts.d.mts.map +1 -1
- package/resources/contacts.d.ts +66 -1
- package/resources/contacts.d.ts.map +1 -1
- package/resources/contacts.js +24 -0
- package/resources/contacts.js.map +1 -1
- package/resources/contacts.mjs +24 -0
- package/resources/contacts.mjs.map +1 -1
- package/resources/conversations.d.mts +160 -0
- package/resources/conversations.d.mts.map +1 -0
- package/resources/conversations.d.ts +160 -0
- package/resources/conversations.d.ts.map +1 -0
- package/resources/conversations.js +59 -0
- package/resources/conversations.js.map +1 -0
- package/resources/conversations.mjs +55 -0
- package/resources/conversations.mjs.map +1 -0
- package/resources/index.d.mts +4 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/messages.d.mts +5 -3
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +5 -3
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +4 -1
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +4 -1
- package/resources/messages.mjs.map +1 -1
- package/resources/profiles/campaigns.d.mts +112 -83
- package/resources/profiles/campaigns.d.mts.map +1 -1
- package/resources/profiles/campaigns.d.ts +112 -83
- package/resources/profiles/campaigns.d.ts.map +1 -1
- package/resources/profiles/campaigns.js +6 -5
- package/resources/profiles/campaigns.js.map +1 -1
- package/resources/profiles/campaigns.mjs +6 -5
- package/resources/profiles/campaigns.mjs.map +1 -1
- package/resources/profiles/index.d.mts +2 -2
- package/resources/profiles/index.d.mts.map +1 -1
- package/resources/profiles/index.d.ts +2 -2
- package/resources/profiles/index.d.ts.map +1 -1
- package/resources/profiles/profiles.d.mts +138 -135
- package/resources/profiles/profiles.d.mts.map +1 -1
- package/resources/profiles/profiles.d.ts +138 -135
- package/resources/profiles/profiles.d.ts.map +1 -1
- package/resources/profiles/profiles.js +30 -18
- package/resources/profiles/profiles.js.map +1 -1
- package/resources/profiles/profiles.mjs +30 -18
- package/resources/profiles/profiles.mjs.map +1 -1
- package/resources/templates.d.mts +87 -87
- package/resources/templates.d.mts.map +1 -1
- package/resources/templates.d.ts +87 -87
- package/resources/templates.d.ts.map +1 -1
- package/src/client.ts +41 -18
- package/src/resources/contacts.ts +96 -0
- package/src/resources/conversations.ts +238 -0
- package/src/resources/index.ts +19 -9
- package/src/resources/messages.ts +5 -3
- package/src/resources/profiles/campaigns.ts +160 -132
- package/src/resources/profiles/index.ts +8 -8
- package/src/resources/profiles/profiles.ts +172 -171
- package/src/resources/templates.ts +105 -105
- 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/contacts.d.ts
CHANGED
|
@@ -69,6 +69,21 @@ export declare class Contacts extends APIResource {
|
|
|
69
69
|
* ```
|
|
70
70
|
*/
|
|
71
71
|
delete(id: string, params: ContactDeleteParams, options?: RequestOptions): APIPromise<void>;
|
|
72
|
+
/**
|
|
73
|
+
* Returns aggregate message counts, time bounds, channels used, and per-channel
|
|
74
|
+
* success/fail scores (each as a percentage 0-100 of messages on that channel) for
|
|
75
|
+
* one of your contacts. Successful terminal states: SENT/DELIVERED/READ for
|
|
76
|
+
* outbound, RECEIVED for inbound. Fail: FAILED.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* const apiResponseOfContactMessageSummary =
|
|
81
|
+
* await client.contacts.retrieveMessageSummary(
|
|
82
|
+
* '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
|
|
83
|
+
* );
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
retrieveMessageSummary(contactID: string, params?: ContactRetrieveMessageSummaryParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfContactMessageSummary>;
|
|
72
87
|
}
|
|
73
88
|
/**
|
|
74
89
|
* Standard API response envelope for all v3 endpoints
|
|
@@ -91,6 +106,49 @@ export interface APIResponseOfContact {
|
|
|
91
106
|
*/
|
|
92
107
|
success?: boolean;
|
|
93
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* Standard API response envelope for all v3 endpoints
|
|
111
|
+
*/
|
|
112
|
+
export interface APIResponseOfContactMessageSummary {
|
|
113
|
+
/**
|
|
114
|
+
* The response data (null if error)
|
|
115
|
+
*/
|
|
116
|
+
data?: ContactMessageSummary | null;
|
|
117
|
+
/**
|
|
118
|
+
* Error information
|
|
119
|
+
*/
|
|
120
|
+
error?: WebhooksAPI.ErrorDetail | null;
|
|
121
|
+
/**
|
|
122
|
+
* Request and response metadata
|
|
123
|
+
*/
|
|
124
|
+
meta?: WebhooksAPI.APIMeta;
|
|
125
|
+
/**
|
|
126
|
+
* Indicates whether the request was successful
|
|
127
|
+
*/
|
|
128
|
+
success?: boolean;
|
|
129
|
+
}
|
|
130
|
+
export interface ContactMessageSummary {
|
|
131
|
+
channel_scores?: Array<ContactMessageSummary.ChannelScore>;
|
|
132
|
+
channels_used?: Array<string>;
|
|
133
|
+
contact_id?: string;
|
|
134
|
+
first_message_at?: string | null;
|
|
135
|
+
last_message_at?: string | null;
|
|
136
|
+
message_count?: number;
|
|
137
|
+
}
|
|
138
|
+
export declare namespace ContactMessageSummary {
|
|
139
|
+
interface ChannelScore {
|
|
140
|
+
channel?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Percentage (0-100) of messages on this channel that ended in FAILED.
|
|
143
|
+
*/
|
|
144
|
+
fail_score?: number;
|
|
145
|
+
/**
|
|
146
|
+
* Percentage (0-100) of messages on this channel that reached a successful
|
|
147
|
+
* terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
|
|
148
|
+
*/
|
|
149
|
+
success_score?: number;
|
|
150
|
+
}
|
|
151
|
+
}
|
|
94
152
|
/**
|
|
95
153
|
* Contact response for v3 API Uses snake_case for JSON property names
|
|
96
154
|
*/
|
|
@@ -288,7 +346,14 @@ export interface ContactDeleteParams {
|
|
|
288
346
|
*/
|
|
289
347
|
'x-profile-id'?: string;
|
|
290
348
|
}
|
|
349
|
+
export interface ContactRetrieveMessageSummaryParams {
|
|
350
|
+
/**
|
|
351
|
+
* Profile UUID to scope the request to a child profile. Only organization API keys
|
|
352
|
+
* can use this header. The profile must belong to the calling organization.
|
|
353
|
+
*/
|
|
354
|
+
'x-profile-id'?: string;
|
|
355
|
+
}
|
|
291
356
|
export declare namespace Contacts {
|
|
292
|
-
export { type APIResponseOfContact as APIResponseOfContact, type ContactResponse as ContactResponse, type ContactListResponse as ContactListResponse, type ContactCreateParams as ContactCreateParams, type ContactRetrieveParams as ContactRetrieveParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactDeleteParams as ContactDeleteParams, };
|
|
357
|
+
export { type APIResponseOfContact as APIResponseOfContact, type APIResponseOfContactMessageSummary as APIResponseOfContactMessageSummary, type ContactMessageSummary as ContactMessageSummary, type ContactResponse as ContactResponse, type ContactListResponse as ContactListResponse, type ContactCreateParams as ContactCreateParams, type ContactRetrieveParams as ContactRetrieveParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactDeleteParams as ContactDeleteParams, type ContactRetrieveMessageSummaryParams as ContactRetrieveMessageSummaryParams, };
|
|
293
358
|
}
|
|
294
359
|
//# sourceMappingURL=contacts.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAe/F;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAWnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAenC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAY1F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAe/F;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAWnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAenC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAY1F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAY3F;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CACpB,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAUlD;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,cAAc,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAE3D,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAE9C;;WAEG;QACH,UAAU,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACzC;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
|
package/resources/contacts.js
CHANGED
|
@@ -126,6 +126,30 @@ class Contacts extends resource_1.APIResource {
|
|
|
126
126
|
]),
|
|
127
127
|
});
|
|
128
128
|
}
|
|
129
|
+
/**
|
|
130
|
+
* Returns aggregate message counts, time bounds, channels used, and per-channel
|
|
131
|
+
* success/fail scores (each as a percentage 0-100 of messages on that channel) for
|
|
132
|
+
* one of your contacts. Successful terminal states: SENT/DELIVERED/READ for
|
|
133
|
+
* outbound, RECEIVED for inbound. Fail: FAILED.
|
|
134
|
+
*
|
|
135
|
+
* @example
|
|
136
|
+
* ```ts
|
|
137
|
+
* const apiResponseOfContactMessageSummary =
|
|
138
|
+
* await client.contacts.retrieveMessageSummary(
|
|
139
|
+
* '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
|
|
140
|
+
* );
|
|
141
|
+
* ```
|
|
142
|
+
*/
|
|
143
|
+
retrieveMessageSummary(contactID, params = {}, options) {
|
|
144
|
+
const { 'x-profile-id': xProfileID } = params ?? {};
|
|
145
|
+
return this._client.get((0, path_1.path) `/v3/contacts/${contactID}/message-summary`, {
|
|
146
|
+
...options,
|
|
147
|
+
headers: (0, headers_1.buildHeaders)([
|
|
148
|
+
{ ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
|
|
149
|
+
options?.headers,
|
|
150
|
+
]),
|
|
151
|
+
});
|
|
152
|
+
}
|
|
129
153
|
}
|
|
130
154
|
exports.Contacts = Contacts;
|
|
131
155
|
//# sourceMappingURL=contacts.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YACtC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YACtC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CACpB,SAAiB,EACjB,SAAiE,EAAE,EACnE,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,kBAAkB,EAAE;YACvE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA/JD,4BA+JC"}
|
package/resources/contacts.mjs
CHANGED
|
@@ -123,5 +123,29 @@ export class Contacts extends APIResource {
|
|
|
123
123
|
]),
|
|
124
124
|
});
|
|
125
125
|
}
|
|
126
|
+
/**
|
|
127
|
+
* Returns aggregate message counts, time bounds, channels used, and per-channel
|
|
128
|
+
* success/fail scores (each as a percentage 0-100 of messages on that channel) for
|
|
129
|
+
* one of your contacts. Successful terminal states: SENT/DELIVERED/READ for
|
|
130
|
+
* outbound, RECEIVED for inbound. Fail: FAILED.
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* ```ts
|
|
134
|
+
* const apiResponseOfContactMessageSummary =
|
|
135
|
+
* await client.contacts.retrieveMessageSummary(
|
|
136
|
+
* '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
|
|
137
|
+
* );
|
|
138
|
+
* ```
|
|
139
|
+
*/
|
|
140
|
+
retrieveMessageSummary(contactID, params = {}, options) {
|
|
141
|
+
const { 'x-profile-id': xProfileID } = params ?? {};
|
|
142
|
+
return this._client.get(path `/v3/contacts/${contactID}/message-summary`, {
|
|
143
|
+
...options,
|
|
144
|
+
headers: buildHeaders([
|
|
145
|
+
{ ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
|
|
146
|
+
options?.headers,
|
|
147
|
+
]),
|
|
148
|
+
});
|
|
149
|
+
}
|
|
126
150
|
}
|
|
127
151
|
//# sourceMappingURL=contacts.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YACtC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
1
|
+
{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YACtC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CACpB,SAAiB,EACjB,SAAiE,EAAE,EACnE,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,kBAAkB,EAAE;YACvE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as WebhooksAPI from "./webhooks.mjs";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class Conversations extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a paginated list of the authenticated customer's messages across all
|
|
8
|
+
* conversations, ordered by created date (most recent first).
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const apiResponseOfConversationMessagesList =
|
|
13
|
+
* await client.conversations.list({
|
|
14
|
+
* page: 0,
|
|
15
|
+
* page_size: 0,
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
list(params: ConversationListParams, options?: RequestOptions): APIPromise<APIResponseOfConversationMessagesList>;
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves a paginated list of the messages in a single conversation (scoped to
|
|
22
|
+
* the authenticated customer), ordered by created date (most recent first).
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const apiResponseOfConversationMessagesList =
|
|
27
|
+
* await client.conversations.listMessages(
|
|
28
|
+
* '08fab313-c9e2-502c-975e-08b0356c432e',
|
|
29
|
+
* { page: 0, page_size: 0 },
|
|
30
|
+
* );
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
listMessages(id: string, params: ConversationListMessagesParams, options?: RequestOptions): APIPromise<APIResponseOfConversationMessagesList>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Standard API response envelope for all v3 endpoints
|
|
37
|
+
*/
|
|
38
|
+
export interface APIResponseOfConversationMessagesList {
|
|
39
|
+
/**
|
|
40
|
+
* A paginated list of messages — used by both conversation read endpoints.
|
|
41
|
+
*/
|
|
42
|
+
data?: ConversationMessagesList | null;
|
|
43
|
+
/**
|
|
44
|
+
* Error information
|
|
45
|
+
*/
|
|
46
|
+
error?: WebhooksAPI.ErrorDetail | null;
|
|
47
|
+
/**
|
|
48
|
+
* Request and response metadata
|
|
49
|
+
*/
|
|
50
|
+
meta?: WebhooksAPI.APIMeta;
|
|
51
|
+
/**
|
|
52
|
+
* Indicates whether the request was successful
|
|
53
|
+
*/
|
|
54
|
+
success?: boolean;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* A paginated list of messages — used by both conversation read endpoints.
|
|
58
|
+
*/
|
|
59
|
+
export interface ConversationMessagesList {
|
|
60
|
+
/**
|
|
61
|
+
* The messages on this page, most recent first.
|
|
62
|
+
*/
|
|
63
|
+
messages?: Array<ConversationMessagesList.Message>;
|
|
64
|
+
/**
|
|
65
|
+
* Pagination metadata for list responses
|
|
66
|
+
*/
|
|
67
|
+
pagination?: WebhooksAPI.PaginationMeta;
|
|
68
|
+
}
|
|
69
|
+
export declare namespace ConversationMessagesList {
|
|
70
|
+
/**
|
|
71
|
+
* Message response for v3 API — same shape as v2 with snake_case JSON conventions
|
|
72
|
+
*/
|
|
73
|
+
interface Message {
|
|
74
|
+
id?: string;
|
|
75
|
+
active_contact_price?: number | null;
|
|
76
|
+
channel?: string;
|
|
77
|
+
contact_id?: string;
|
|
78
|
+
created_at?: string;
|
|
79
|
+
customer_id?: string;
|
|
80
|
+
direction?: string;
|
|
81
|
+
events?: Array<Message.Event> | null;
|
|
82
|
+
/**
|
|
83
|
+
* Structured message body format for database storage. Preserves channel-specific
|
|
84
|
+
* components (header, body, footer, buttons).
|
|
85
|
+
*/
|
|
86
|
+
message_body?: Message.MessageBody | null;
|
|
87
|
+
phone?: string;
|
|
88
|
+
phone_international?: string;
|
|
89
|
+
price?: number | null;
|
|
90
|
+
region_code?: string;
|
|
91
|
+
status?: string;
|
|
92
|
+
template_category?: string | null;
|
|
93
|
+
template_id?: string | null;
|
|
94
|
+
template_name?: string | null;
|
|
95
|
+
}
|
|
96
|
+
namespace Message {
|
|
97
|
+
/**
|
|
98
|
+
* Represents a status change event in a message's lifecycle (v3)
|
|
99
|
+
*/
|
|
100
|
+
interface Event {
|
|
101
|
+
status: string;
|
|
102
|
+
timestamp: string;
|
|
103
|
+
description?: string | null;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Structured message body format for database storage. Preserves channel-specific
|
|
107
|
+
* components (header, body, footer, buttons).
|
|
108
|
+
*/
|
|
109
|
+
interface MessageBody {
|
|
110
|
+
buttons?: Array<MessageBody.Button> | null;
|
|
111
|
+
content?: string;
|
|
112
|
+
footer?: string | null;
|
|
113
|
+
header?: string | null;
|
|
114
|
+
}
|
|
115
|
+
namespace MessageBody {
|
|
116
|
+
interface Button {
|
|
117
|
+
postbackData?: string | null;
|
|
118
|
+
text?: string | null;
|
|
119
|
+
type?: string;
|
|
120
|
+
value?: string;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
export interface ConversationListParams {
|
|
126
|
+
/**
|
|
127
|
+
* Query param
|
|
128
|
+
*/
|
|
129
|
+
page: number;
|
|
130
|
+
/**
|
|
131
|
+
* Query param
|
|
132
|
+
*/
|
|
133
|
+
page_size: number;
|
|
134
|
+
/**
|
|
135
|
+
* Header param: Profile UUID to scope the request to a child profile. Only
|
|
136
|
+
* organization API keys can use this header. The profile must belong to the
|
|
137
|
+
* calling organization.
|
|
138
|
+
*/
|
|
139
|
+
'x-profile-id'?: string;
|
|
140
|
+
}
|
|
141
|
+
export interface ConversationListMessagesParams {
|
|
142
|
+
/**
|
|
143
|
+
* Query param
|
|
144
|
+
*/
|
|
145
|
+
page: number;
|
|
146
|
+
/**
|
|
147
|
+
* Query param
|
|
148
|
+
*/
|
|
149
|
+
page_size: number;
|
|
150
|
+
/**
|
|
151
|
+
* Header param: Profile UUID to scope the request to a child profile. Only
|
|
152
|
+
* organization API keys can use this header. The profile must belong to the
|
|
153
|
+
* calling organization.
|
|
154
|
+
*/
|
|
155
|
+
'x-profile-id'?: string;
|
|
156
|
+
}
|
|
157
|
+
export declare namespace Conversations {
|
|
158
|
+
export { type APIResponseOfConversationMessagesList as APIResponseOfConversationMessagesList, type ConversationMessagesList as ConversationMessagesList, type ConversationListParams as ConversationListParams, type ConversationListMessagesParams as ConversationListMessagesParams, };
|
|
159
|
+
}
|
|
160
|
+
//# sourceMappingURL=conversations.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversations.d.mts","sourceRoot":"","sources":["../src/resources/conversations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAYpD;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAWrD;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;CACzC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAErC;;;WAGG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;QAE1C,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED,UAAiB,OAAO,CAAC;QACvB;;WAEG;QACH,UAAiB,KAAK;YACpB,MAAM,EAAE,MAAM,CAAC;YAEf,SAAS,EAAE,MAAM,CAAC;YAElB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;QAED;;;WAGG;QACH,UAAiB,WAAW;YAC1B,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YAE3C,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,WAAW,CAAC;YAC3B,UAAiB,MAAM;gBACrB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE7B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;SACF;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as WebhooksAPI from "./webhooks.js";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class Conversations extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a paginated list of the authenticated customer's messages across all
|
|
8
|
+
* conversations, ordered by created date (most recent first).
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const apiResponseOfConversationMessagesList =
|
|
13
|
+
* await client.conversations.list({
|
|
14
|
+
* page: 0,
|
|
15
|
+
* page_size: 0,
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
list(params: ConversationListParams, options?: RequestOptions): APIPromise<APIResponseOfConversationMessagesList>;
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves a paginated list of the messages in a single conversation (scoped to
|
|
22
|
+
* the authenticated customer), ordered by created date (most recent first).
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const apiResponseOfConversationMessagesList =
|
|
27
|
+
* await client.conversations.listMessages(
|
|
28
|
+
* '08fab313-c9e2-502c-975e-08b0356c432e',
|
|
29
|
+
* { page: 0, page_size: 0 },
|
|
30
|
+
* );
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
listMessages(id: string, params: ConversationListMessagesParams, options?: RequestOptions): APIPromise<APIResponseOfConversationMessagesList>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Standard API response envelope for all v3 endpoints
|
|
37
|
+
*/
|
|
38
|
+
export interface APIResponseOfConversationMessagesList {
|
|
39
|
+
/**
|
|
40
|
+
* A paginated list of messages — used by both conversation read endpoints.
|
|
41
|
+
*/
|
|
42
|
+
data?: ConversationMessagesList | null;
|
|
43
|
+
/**
|
|
44
|
+
* Error information
|
|
45
|
+
*/
|
|
46
|
+
error?: WebhooksAPI.ErrorDetail | null;
|
|
47
|
+
/**
|
|
48
|
+
* Request and response metadata
|
|
49
|
+
*/
|
|
50
|
+
meta?: WebhooksAPI.APIMeta;
|
|
51
|
+
/**
|
|
52
|
+
* Indicates whether the request was successful
|
|
53
|
+
*/
|
|
54
|
+
success?: boolean;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* A paginated list of messages — used by both conversation read endpoints.
|
|
58
|
+
*/
|
|
59
|
+
export interface ConversationMessagesList {
|
|
60
|
+
/**
|
|
61
|
+
* The messages on this page, most recent first.
|
|
62
|
+
*/
|
|
63
|
+
messages?: Array<ConversationMessagesList.Message>;
|
|
64
|
+
/**
|
|
65
|
+
* Pagination metadata for list responses
|
|
66
|
+
*/
|
|
67
|
+
pagination?: WebhooksAPI.PaginationMeta;
|
|
68
|
+
}
|
|
69
|
+
export declare namespace ConversationMessagesList {
|
|
70
|
+
/**
|
|
71
|
+
* Message response for v3 API — same shape as v2 with snake_case JSON conventions
|
|
72
|
+
*/
|
|
73
|
+
interface Message {
|
|
74
|
+
id?: string;
|
|
75
|
+
active_contact_price?: number | null;
|
|
76
|
+
channel?: string;
|
|
77
|
+
contact_id?: string;
|
|
78
|
+
created_at?: string;
|
|
79
|
+
customer_id?: string;
|
|
80
|
+
direction?: string;
|
|
81
|
+
events?: Array<Message.Event> | null;
|
|
82
|
+
/**
|
|
83
|
+
* Structured message body format for database storage. Preserves channel-specific
|
|
84
|
+
* components (header, body, footer, buttons).
|
|
85
|
+
*/
|
|
86
|
+
message_body?: Message.MessageBody | null;
|
|
87
|
+
phone?: string;
|
|
88
|
+
phone_international?: string;
|
|
89
|
+
price?: number | null;
|
|
90
|
+
region_code?: string;
|
|
91
|
+
status?: string;
|
|
92
|
+
template_category?: string | null;
|
|
93
|
+
template_id?: string | null;
|
|
94
|
+
template_name?: string | null;
|
|
95
|
+
}
|
|
96
|
+
namespace Message {
|
|
97
|
+
/**
|
|
98
|
+
* Represents a status change event in a message's lifecycle (v3)
|
|
99
|
+
*/
|
|
100
|
+
interface Event {
|
|
101
|
+
status: string;
|
|
102
|
+
timestamp: string;
|
|
103
|
+
description?: string | null;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Structured message body format for database storage. Preserves channel-specific
|
|
107
|
+
* components (header, body, footer, buttons).
|
|
108
|
+
*/
|
|
109
|
+
interface MessageBody {
|
|
110
|
+
buttons?: Array<MessageBody.Button> | null;
|
|
111
|
+
content?: string;
|
|
112
|
+
footer?: string | null;
|
|
113
|
+
header?: string | null;
|
|
114
|
+
}
|
|
115
|
+
namespace MessageBody {
|
|
116
|
+
interface Button {
|
|
117
|
+
postbackData?: string | null;
|
|
118
|
+
text?: string | null;
|
|
119
|
+
type?: string;
|
|
120
|
+
value?: string;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
export interface ConversationListParams {
|
|
126
|
+
/**
|
|
127
|
+
* Query param
|
|
128
|
+
*/
|
|
129
|
+
page: number;
|
|
130
|
+
/**
|
|
131
|
+
* Query param
|
|
132
|
+
*/
|
|
133
|
+
page_size: number;
|
|
134
|
+
/**
|
|
135
|
+
* Header param: Profile UUID to scope the request to a child profile. Only
|
|
136
|
+
* organization API keys can use this header. The profile must belong to the
|
|
137
|
+
* calling organization.
|
|
138
|
+
*/
|
|
139
|
+
'x-profile-id'?: string;
|
|
140
|
+
}
|
|
141
|
+
export interface ConversationListMessagesParams {
|
|
142
|
+
/**
|
|
143
|
+
* Query param
|
|
144
|
+
*/
|
|
145
|
+
page: number;
|
|
146
|
+
/**
|
|
147
|
+
* Query param
|
|
148
|
+
*/
|
|
149
|
+
page_size: number;
|
|
150
|
+
/**
|
|
151
|
+
* Header param: Profile UUID to scope the request to a child profile. Only
|
|
152
|
+
* organization API keys can use this header. The profile must belong to the
|
|
153
|
+
* calling organization.
|
|
154
|
+
*/
|
|
155
|
+
'x-profile-id'?: string;
|
|
156
|
+
}
|
|
157
|
+
export declare namespace Conversations {
|
|
158
|
+
export { type APIResponseOfConversationMessagesList as APIResponseOfConversationMessagesList, type ConversationMessagesList as ConversationMessagesList, type ConversationListParams as ConversationListParams, type ConversationListMessagesParams as ConversationListMessagesParams, };
|
|
159
|
+
}
|
|
160
|
+
//# sourceMappingURL=conversations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversations.d.ts","sourceRoot":"","sources":["../src/resources/conversations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAYpD;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAWrD;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;CACzC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAErC;;;WAGG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;QAE1C,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED,UAAiB,OAAO,CAAC;QACvB;;WAEG;QACH,UAAiB,KAAK;YACpB,MAAM,EAAE,MAAM,CAAC;YAEf,SAAS,EAAE,MAAM,CAAC;YAElB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;QAED;;;WAGG;QACH,UAAiB,WAAW;YAC1B,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YAE3C,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,WAAW,CAAC;YAC3B,UAAiB,MAAM;gBACrB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE7B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;SACF;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Conversations = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const headers_1 = require("../internal/headers.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class Conversations extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieves a paginated list of the authenticated customer's messages across all
|
|
11
|
+
* conversations, ordered by created date (most recent first).
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const apiResponseOfConversationMessagesList =
|
|
16
|
+
* await client.conversations.list({
|
|
17
|
+
* page: 0,
|
|
18
|
+
* page_size: 0,
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
list(params, options) {
|
|
23
|
+
const { 'x-profile-id': xProfileID, ...query } = params;
|
|
24
|
+
return this._client.get('/v3/conversations', {
|
|
25
|
+
query,
|
|
26
|
+
...options,
|
|
27
|
+
headers: (0, headers_1.buildHeaders)([
|
|
28
|
+
{ ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
|
|
29
|
+
options?.headers,
|
|
30
|
+
]),
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Retrieves a paginated list of the messages in a single conversation (scoped to
|
|
35
|
+
* the authenticated customer), ordered by created date (most recent first).
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const apiResponseOfConversationMessagesList =
|
|
40
|
+
* await client.conversations.listMessages(
|
|
41
|
+
* '08fab313-c9e2-502c-975e-08b0356c432e',
|
|
42
|
+
* { page: 0, page_size: 0 },
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
listMessages(id, params, options) {
|
|
47
|
+
const { 'x-profile-id': xProfileID, ...query } = params;
|
|
48
|
+
return this._client.get((0, path_1.path) `/v3/conversations/${id}`, {
|
|
49
|
+
query,
|
|
50
|
+
...options,
|
|
51
|
+
headers: (0, headers_1.buildHeaders)([
|
|
52
|
+
{ ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
|
|
53
|
+
options?.headers,
|
|
54
|
+
]),
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
exports.Conversations = Conversations;
|
|
59
|
+
//# sourceMappingURL=conversations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversations.js","sourceRoot":"","sources":["../src/resources/conversations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC3C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,EAAU,EACV,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE;YACrD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAzDD,sCAyDC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../internal/headers.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class Conversations extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a paginated list of the authenticated customer's messages across all
|
|
8
|
+
* conversations, ordered by created date (most recent first).
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const apiResponseOfConversationMessagesList =
|
|
13
|
+
* await client.conversations.list({
|
|
14
|
+
* page: 0,
|
|
15
|
+
* page_size: 0,
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
list(params, options) {
|
|
20
|
+
const { 'x-profile-id': xProfileID, ...query } = params;
|
|
21
|
+
return this._client.get('/v3/conversations', {
|
|
22
|
+
query,
|
|
23
|
+
...options,
|
|
24
|
+
headers: buildHeaders([
|
|
25
|
+
{ ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
|
|
26
|
+
options?.headers,
|
|
27
|
+
]),
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Retrieves a paginated list of the messages in a single conversation (scoped to
|
|
32
|
+
* the authenticated customer), ordered by created date (most recent first).
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const apiResponseOfConversationMessagesList =
|
|
37
|
+
* await client.conversations.listMessages(
|
|
38
|
+
* '08fab313-c9e2-502c-975e-08b0356c432e',
|
|
39
|
+
* { page: 0, page_size: 0 },
|
|
40
|
+
* );
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
listMessages(id, params, options) {
|
|
44
|
+
const { 'x-profile-id': xProfileID, ...query } = params;
|
|
45
|
+
return this._client.get(path `/v3/conversations/${id}`, {
|
|
46
|
+
query,
|
|
47
|
+
...options,
|
|
48
|
+
headers: buildHeaders([
|
|
49
|
+
{ ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
|
|
50
|
+
options?.headers,
|
|
51
|
+
]),
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=conversations.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversations.mjs","sourceRoot":"","sources":["../src/resources/conversations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC3C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,EAAU,EACV,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE;YACrD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|