@surgeapi/node 0.35.0 → 0.37.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 +45 -0
- package/README.md +8 -8
- package/client.d.mts +10 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -6
- package/client.d.ts.map +1 -1
- package/client.js +19 -2
- package/client.js.map +1 -1
- package/client.mjs +20 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/campaigns.d.mts +34 -1
- package/resources/campaigns.d.mts.map +1 -1
- package/resources/campaigns.d.ts +34 -1
- package/resources/campaigns.d.ts.map +1 -1
- package/resources/campaigns.js +33 -0
- package/resources/campaigns.js.map +1 -1
- package/resources/campaigns.mjs +33 -0
- package/resources/campaigns.mjs.map +1 -1
- package/resources/index.d.mts +3 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -2
- 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 +2 -1
- package/resources/index.mjs.map +1 -1
- package/resources/messages.d.mts +2 -2
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +2 -2
- package/resources/messages.d.ts.map +1 -1
- package/resources/recordings.d.mts +88 -0
- package/resources/recordings.d.mts.map +1 -0
- package/resources/recordings.d.ts +88 -0
- package/resources/recordings.d.ts.map +1 -0
- package/resources/recordings.js +38 -0
- package/resources/recordings.js.map +1 -0
- package/resources/recordings.mjs +34 -0
- package/resources/recordings.mjs.map +1 -0
- package/resources/webhooks.d.mts +158 -2
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +158 -2
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +46 -6
- package/src/resources/campaigns.ts +54 -1
- package/src/resources/index.ts +10 -1
- package/src/resources/messages.ts +2 -2
- package/src/resources/recordings.ts +118 -0
- package/src/resources/webhooks.ts +200 -1
- 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/package.json
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { Cursor, type CursorParams, PagePromise } from "../core/pagination.mjs";
|
|
3
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
5
|
export declare class Campaigns extends APIResource {
|
|
5
6
|
/**
|
|
@@ -31,7 +32,33 @@ export declare class Campaigns extends APIResource {
|
|
|
31
32
|
* ```
|
|
32
33
|
*/
|
|
33
34
|
create(accountID: string, body: CampaignCreateParams, options?: RequestOptions): APIPromise<Campaign>;
|
|
35
|
+
/**
|
|
36
|
+
* Retrieves a Campaign object.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const campaign = await client.campaigns.retrieve(
|
|
41
|
+
* 'cpn_01k0qczvhbet4azgn5xm2ccfst',
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Campaign>;
|
|
46
|
+
/**
|
|
47
|
+
* List all campaigns for an account with cursor-based pagination.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Automatically fetches more pages as needed.
|
|
52
|
+
* for await (const campaign of client.campaigns.list(
|
|
53
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
54
|
+
* )) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
list(accountID: string, query?: CampaignListParams | null | undefined, options?: RequestOptions): PagePromise<CampaignsCursor, Campaign>;
|
|
34
60
|
}
|
|
61
|
+
export type CampaignsCursor = Cursor<Campaign>;
|
|
35
62
|
/**
|
|
36
63
|
* A campaign represents the context in which one or more of your phone numbers
|
|
37
64
|
* communicates with your contacts. Consent and opt-outs are tied to the campaign.
|
|
@@ -81,6 +108,10 @@ export interface Campaign {
|
|
|
81
108
|
* in to messaging.
|
|
82
109
|
*/
|
|
83
110
|
privacy_policy_url: string;
|
|
111
|
+
/**
|
|
112
|
+
* The current status of the campaign.
|
|
113
|
+
*/
|
|
114
|
+
status: 'active' | 'canceled' | 'created' | 'deactivated' | 'in_review' | 'pending' | 'rejected';
|
|
84
115
|
/**
|
|
85
116
|
* A list containing 1-5 types of messages that will be sent with this campaign.
|
|
86
117
|
*
|
|
@@ -247,7 +278,9 @@ export declare namespace CampaignCreateParams {
|
|
|
247
278
|
tcr_id: string;
|
|
248
279
|
}
|
|
249
280
|
}
|
|
281
|
+
export interface CampaignListParams extends CursorParams {
|
|
282
|
+
}
|
|
250
283
|
export declare namespace Campaigns {
|
|
251
|
-
export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
|
|
284
|
+
export { type Campaign as Campaign, type CampaignsCursor as CampaignsCursor, type CampaignCreateParams as CampaignCreateParams, type CampaignListParams as CampaignListParams, };
|
|
252
285
|
}
|
|
253
286
|
//# 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;
|
|
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,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,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;IAIrG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC;CAM1C;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AAE/C;;;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;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;IAEjG;;;;;;;;;;;;;;;;;;;;;;;;;;;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,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,sBAAsB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;;;WAKG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;;;;WAQG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,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;QAEF;;;;;;;;;;;WAWG;QACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;QAEvB;;;;;;;;;;WAUG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;QAE7E;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;KACnC;IAED,UAAiB,sBAAsB;QACrC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,YAAY;CAAG;AAE3D,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/campaigns.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { Cursor, type CursorParams, PagePromise } from "../core/pagination.js";
|
|
3
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
4
5
|
export declare class Campaigns extends APIResource {
|
|
5
6
|
/**
|
|
@@ -31,7 +32,33 @@ export declare class Campaigns extends APIResource {
|
|
|
31
32
|
* ```
|
|
32
33
|
*/
|
|
33
34
|
create(accountID: string, body: CampaignCreateParams, options?: RequestOptions): APIPromise<Campaign>;
|
|
35
|
+
/**
|
|
36
|
+
* Retrieves a Campaign object.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const campaign = await client.campaigns.retrieve(
|
|
41
|
+
* 'cpn_01k0qczvhbet4azgn5xm2ccfst',
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Campaign>;
|
|
46
|
+
/**
|
|
47
|
+
* List all campaigns for an account with cursor-based pagination.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Automatically fetches more pages as needed.
|
|
52
|
+
* for await (const campaign of client.campaigns.list(
|
|
53
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
54
|
+
* )) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
list(accountID: string, query?: CampaignListParams | null | undefined, options?: RequestOptions): PagePromise<CampaignsCursor, Campaign>;
|
|
34
60
|
}
|
|
61
|
+
export type CampaignsCursor = Cursor<Campaign>;
|
|
35
62
|
/**
|
|
36
63
|
* A campaign represents the context in which one or more of your phone numbers
|
|
37
64
|
* communicates with your contacts. Consent and opt-outs are tied to the campaign.
|
|
@@ -81,6 +108,10 @@ export interface Campaign {
|
|
|
81
108
|
* in to messaging.
|
|
82
109
|
*/
|
|
83
110
|
privacy_policy_url: string;
|
|
111
|
+
/**
|
|
112
|
+
* The current status of the campaign.
|
|
113
|
+
*/
|
|
114
|
+
status: 'active' | 'canceled' | 'created' | 'deactivated' | 'in_review' | 'pending' | 'rejected';
|
|
84
115
|
/**
|
|
85
116
|
* A list containing 1-5 types of messages that will be sent with this campaign.
|
|
86
117
|
*
|
|
@@ -247,7 +278,9 @@ export declare namespace CampaignCreateParams {
|
|
|
247
278
|
tcr_id: string;
|
|
248
279
|
}
|
|
249
280
|
}
|
|
281
|
+
export interface CampaignListParams extends CursorParams {
|
|
282
|
+
}
|
|
250
283
|
export declare namespace Campaigns {
|
|
251
|
-
export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
|
|
284
|
+
export { type Campaign as Campaign, type CampaignsCursor as CampaignsCursor, type CampaignCreateParams as CampaignCreateParams, type CampaignListParams as CampaignListParams, };
|
|
252
285
|
}
|
|
253
286
|
//# 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;
|
|
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,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,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;IAIrG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC;CAM1C;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AAE/C;;;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;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;IAEjG;;;;;;;;;;;;;;;;;;;;;;;;;;;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,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,sBAAsB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;;;WAKG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;;;;WAQG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,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;QAEF;;;;;;;;;;;WAWG;QACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;QAEvB;;;;;;;;;;WAUG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;QAE7E;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;KACnC;IAED,UAAiB,sBAAsB;QACrC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,YAAY;CAAG;AAE3D,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/campaigns.js
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.Campaigns = void 0;
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
6
7
|
const path_1 = require("../internal/utils/path.js");
|
|
7
8
|
class Campaigns extends resource_1.APIResource {
|
|
8
9
|
/**
|
|
@@ -36,6 +37,38 @@ class Campaigns extends resource_1.APIResource {
|
|
|
36
37
|
create(accountID, body, options) {
|
|
37
38
|
return this._client.post((0, path_1.path) `/accounts/${accountID}/campaigns`, { body, ...options });
|
|
38
39
|
}
|
|
40
|
+
/**
|
|
41
|
+
* Retrieves a Campaign object.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* const campaign = await client.campaigns.retrieve(
|
|
46
|
+
* 'cpn_01k0qczvhbet4azgn5xm2ccfst',
|
|
47
|
+
* );
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
retrieve(id, options) {
|
|
51
|
+
return this._client.get((0, path_1.path) `/campaigns/${id}`, options);
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* List all campaigns for an account with cursor-based pagination.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* // Automatically fetches more pages as needed.
|
|
59
|
+
* for await (const campaign of client.campaigns.list(
|
|
60
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
61
|
+
* )) {
|
|
62
|
+
* // ...
|
|
63
|
+
* }
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
list(accountID, query = {}, options) {
|
|
67
|
+
return this._client.getAPIList((0, path_1.path) `/accounts/${accountID}/campaigns`, (pagination_1.Cursor), {
|
|
68
|
+
query,
|
|
69
|
+
...options,
|
|
70
|
+
});
|
|
71
|
+
}
|
|
39
72
|
}
|
|
40
73
|
exports.Campaigns = Campaigns;
|
|
41
74
|
//# sourceMappingURL=campaigns.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;
|
|
1
|
+
{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAE5E,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAiB,EAAE,IAA0B,EAAE,OAAwB;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,CAAA,mBAAgB,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAtED,8BAsEC"}
|
package/resources/campaigns.mjs
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { Cursor } from "../core/pagination.mjs";
|
|
3
4
|
import { path } from "../internal/utils/path.mjs";
|
|
4
5
|
export class Campaigns extends APIResource {
|
|
5
6
|
/**
|
|
@@ -33,5 +34,37 @@ export class Campaigns extends APIResource {
|
|
|
33
34
|
create(accountID, body, options) {
|
|
34
35
|
return this._client.post(path `/accounts/${accountID}/campaigns`, { body, ...options });
|
|
35
36
|
}
|
|
37
|
+
/**
|
|
38
|
+
* Retrieves a Campaign object.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const campaign = await client.campaigns.retrieve(
|
|
43
|
+
* 'cpn_01k0qczvhbet4azgn5xm2ccfst',
|
|
44
|
+
* );
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
retrieve(id, options) {
|
|
48
|
+
return this._client.get(path `/campaigns/${id}`, options);
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* List all campaigns for an account with cursor-based pagination.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* // Automatically fetches more pages as needed.
|
|
56
|
+
* for await (const campaign of client.campaigns.list(
|
|
57
|
+
* 'acct_01j9a43avnfqzbjfch6pygv1td',
|
|
58
|
+
* )) {
|
|
59
|
+
* // ...
|
|
60
|
+
* }
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
list(accountID, query = {}, options) {
|
|
64
|
+
return this._client.getAPIList(path `/accounts/${accountID}/campaigns`, (Cursor), {
|
|
65
|
+
query,
|
|
66
|
+
...options,
|
|
67
|
+
});
|
|
68
|
+
}
|
|
36
69
|
}
|
|
37
70
|
//# sourceMappingURL=campaigns.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"campaigns.mjs","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"campaigns.mjs","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,MAAM,EAAkC;OAE1C,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAiB,EAAE,IAA0B,EAAE,OAAwB;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,YAAY,EAAE,CAAA,MAAgB,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/resources/index.d.mts
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
export * from "./shared.mjs";
|
|
2
2
|
export { Accounts, type Account, type AccountStatus, type Organization, type AccountCreateParams, type AccountUpdateParams, type AccountRetrieveStatusParams, } from "./accounts.mjs";
|
|
3
3
|
export { Blasts, type Blast, type BlastCreateParams } from "./blasts.mjs";
|
|
4
|
-
export { Campaigns, type Campaign, type CampaignCreateParams } from "./campaigns.mjs";
|
|
4
|
+
export { Campaigns, type Campaign, type CampaignCreateParams, type CampaignListParams, type CampaignsCursor, } from "./campaigns.mjs";
|
|
5
5
|
export { Contacts, type Contact, type ContactCreateParams, type ContactUpdateParams, type ContactListParams, type ContactsCursor, } from "./contacts.mjs";
|
|
6
6
|
export { Messages, type Message, type MessageCreateParams, type MessageListParams, type MessagesCursor, } from "./messages.mjs";
|
|
7
7
|
export { PhoneNumbers, type PhoneNumber, type PhoneNumberListParams, type PhoneNumberPurchaseParams, type PhoneNumbersCursor, } from "./phone-numbers.mjs";
|
|
8
|
+
export { Recordings, type RecordingDeleteResponse, type RecordingGetFileResponse } from "./recordings.mjs";
|
|
8
9
|
export { Users, type User, type UserTokenResponse, type UserCreateParams, type UserUpdateParams, type UserCreateTokenParams, } from "./users.mjs";
|
|
9
10
|
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 LinkFollowedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.mjs";
|
|
11
|
+
export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ContactOptedInWebhookEvent, type ContactOptedOutWebhookEvent, type ConversationCreatedWebhookEvent, type LinkFollowedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type RecordingCompletedWebhookEvent, type VoicemailReceivedWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.mjs";
|
|
11
12
|
//# 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,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,
|
|
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,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,eAAe,GACrB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,GACxB;OACM,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE,KAAK,wBAAwB,EAAE;OAC3E,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,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,6BAA6B,EAClC,KAAK,kBAAkB,GACxB"}
|
package/resources/index.d.ts
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
export * from "./shared.js";
|
|
2
2
|
export { Accounts, type Account, type AccountStatus, type Organization, type AccountCreateParams, type AccountUpdateParams, type AccountRetrieveStatusParams, } from "./accounts.js";
|
|
3
3
|
export { Blasts, type Blast, type BlastCreateParams } from "./blasts.js";
|
|
4
|
-
export { Campaigns, type Campaign, type CampaignCreateParams } from "./campaigns.js";
|
|
4
|
+
export { Campaigns, type Campaign, type CampaignCreateParams, type CampaignListParams, type CampaignsCursor, } from "./campaigns.js";
|
|
5
5
|
export { Contacts, type Contact, type ContactCreateParams, type ContactUpdateParams, type ContactListParams, type ContactsCursor, } from "./contacts.js";
|
|
6
6
|
export { Messages, type Message, type MessageCreateParams, type MessageListParams, type MessagesCursor, } from "./messages.js";
|
|
7
7
|
export { PhoneNumbers, type PhoneNumber, type PhoneNumberListParams, type PhoneNumberPurchaseParams, type PhoneNumbersCursor, } from "./phone-numbers.js";
|
|
8
|
+
export { Recordings, type RecordingDeleteResponse, type RecordingGetFileResponse } from "./recordings.js";
|
|
8
9
|
export { Users, type User, type UserTokenResponse, type UserCreateParams, type UserUpdateParams, type UserCreateTokenParams, } from "./users.js";
|
|
9
10
|
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 LinkFollowedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.js";
|
|
11
|
+
export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ContactOptedInWebhookEvent, type ContactOptedOutWebhookEvent, type ConversationCreatedWebhookEvent, type LinkFollowedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type RecordingCompletedWebhookEvent, type VoicemailReceivedWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.js";
|
|
11
12
|
//# 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,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,
|
|
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,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,eAAe,GACrB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,GACxB;OACM,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE,KAAK,wBAAwB,EAAE;OAC3E,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,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,6BAA6B,EAClC,KAAK,kBAAkB,GACxB"}
|
package/resources/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Webhooks = exports.Verifications = exports.Users = exports.PhoneNumbers = exports.Messages = exports.Contacts = exports.Campaigns = exports.Blasts = exports.Accounts = void 0;
|
|
4
|
+
exports.Webhooks = exports.Verifications = exports.Users = exports.Recordings = exports.PhoneNumbers = exports.Messages = exports.Contacts = exports.Campaigns = exports.Blasts = exports.Accounts = void 0;
|
|
5
5
|
const tslib_1 = require("../internal/tslib.js");
|
|
6
6
|
tslib_1.__exportStar(require("./shared.js"), exports);
|
|
7
7
|
var accounts_1 = require("./accounts.js");
|
|
@@ -16,6 +16,8 @@ var messages_1 = require("./messages.js");
|
|
|
16
16
|
Object.defineProperty(exports, "Messages", { enumerable: true, get: function () { return messages_1.Messages; } });
|
|
17
17
|
var phone_numbers_1 = require("./phone-numbers.js");
|
|
18
18
|
Object.defineProperty(exports, "PhoneNumbers", { enumerable: true, get: function () { return phone_numbers_1.PhoneNumbers; } });
|
|
19
|
+
var recordings_1 = require("./recordings.js");
|
|
20
|
+
Object.defineProperty(exports, "Recordings", { enumerable: true, get: function () { return recordings_1.Recordings; } });
|
|
19
21
|
var users_1 = require("./users.js");
|
|
20
22
|
Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
|
|
21
23
|
var verifications_1 = require("./verifications.js");
|
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,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA;AAQV,sCAAsE;AAA7D,gGAAA,MAAM,OAAA;AACf,
|
|
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,4CAMqB;AALnB,sGAAA,SAAS,OAAA;AAMX,0CAOoB;AANlB,oGAAA,QAAQ,OAAA;AAOV,0CAMoB;AALlB,oGAAA,QAAQ,OAAA;AAMV,oDAMyB;AALvB,6GAAA,YAAY,OAAA;AAMd,8CAAuG;AAA9F,wGAAA,UAAU,OAAA;AACnB,oCAOiB;AANf,8FAAA,KAAK,OAAA;AAOP,oDAMyB;AALvB,8GAAA,aAAa,OAAA;AAMf,0CAeoB;AAdlB,oGAAA,QAAQ,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -2,10 +2,11 @@
|
|
|
2
2
|
export * from "./shared.mjs";
|
|
3
3
|
export { Accounts, } from "./accounts.mjs";
|
|
4
4
|
export { Blasts } from "./blasts.mjs";
|
|
5
|
-
export { Campaigns } from "./campaigns.mjs";
|
|
5
|
+
export { Campaigns, } from "./campaigns.mjs";
|
|
6
6
|
export { Contacts, } from "./contacts.mjs";
|
|
7
7
|
export { Messages, } from "./messages.mjs";
|
|
8
8
|
export { PhoneNumbers, } from "./phone-numbers.mjs";
|
|
9
|
+
export { Recordings } from "./recordings.mjs";
|
|
9
10
|
export { Users, } from "./users.mjs";
|
|
10
11
|
export { Verifications, } from "./verifications.mjs";
|
|
11
12
|
export { Webhooks, } from "./webhooks.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,GAOT;OACM,EAAE,MAAM,EAAsC;OAC9C,
|
|
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,EACL,SAAS,GAKV;OACM,EACL,QAAQ,GAMT;OACM,EACL,QAAQ,GAKT;OACM,EACL,YAAY,GAKb;OACM,EAAE,UAAU,EAA+D;OAC3E,EACL,KAAK,GAMN;OACM,EACL,aAAa,GAKd;OACM,EACL,QAAQ,GAcT"}
|
package/resources/messages.d.mts
CHANGED
|
@@ -84,7 +84,7 @@ export interface Message {
|
|
|
84
84
|
* The ID of the blast this message belongs to, if any. This can be used to
|
|
85
85
|
* attribute messages back to a specific blast.
|
|
86
86
|
*/
|
|
87
|
-
blast_id?: string;
|
|
87
|
+
blast_id?: string | null;
|
|
88
88
|
/**
|
|
89
89
|
* The message body.
|
|
90
90
|
*/
|
|
@@ -112,7 +112,7 @@ export declare namespace Message {
|
|
|
112
112
|
/**
|
|
113
113
|
* The type of attachment.
|
|
114
114
|
*/
|
|
115
|
-
type?:
|
|
115
|
+
type?: 'file' | 'image' | 'link' | 'video';
|
|
116
116
|
/**
|
|
117
117
|
* The URL of the attachment.
|
|
118
118
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;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;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;CAMxC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAExC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;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;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;CAMxC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAExC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;QAE3C;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC;KACzC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,6BAA6B,GACjD,mBAAmB,CAAC,mBAAmB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,6BAA6B;QAC5C;;;WAGG;QACH,YAAY,EAAE,6BAA6B,CAAC,YAAY,CAAC;QAEzD,WAAW,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;QAE9D;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,6BAA6B,CAAC;QAC7C;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;YAE9B;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,YAAY,CAAC;YAC5B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACtC;SACF;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAEpD;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,mBAAmB,CAAC;QACnC;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;CAAG;AAE1D,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/messages.d.ts
CHANGED
|
@@ -84,7 +84,7 @@ export interface Message {
|
|
|
84
84
|
* The ID of the blast this message belongs to, if any. This can be used to
|
|
85
85
|
* attribute messages back to a specific blast.
|
|
86
86
|
*/
|
|
87
|
-
blast_id?: string;
|
|
87
|
+
blast_id?: string | null;
|
|
88
88
|
/**
|
|
89
89
|
* The message body.
|
|
90
90
|
*/
|
|
@@ -112,7 +112,7 @@ export declare namespace Message {
|
|
|
112
112
|
/**
|
|
113
113
|
* The type of attachment.
|
|
114
114
|
*/
|
|
115
|
-
type?:
|
|
115
|
+
type?: 'file' | 'image' | 'link' | 'video';
|
|
116
116
|
/**
|
|
117
117
|
* The URL of the attachment.
|
|
118
118
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;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;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;CAMxC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAExC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;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;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC;CAMxC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAExC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;QAE3C;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC;KACzC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,6BAA6B,GACjD,mBAAmB,CAAC,mBAAmB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,6BAA6B;QAC5C;;;WAGG;QACH,YAAY,EAAE,6BAA6B,CAAC,YAAY,CAAC;QAEzD,WAAW,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;QAE9D;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,6BAA6B,CAAC;QAC7C;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;YAE9B;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,YAAY,CAAC;YAC5B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACtC;SACF;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAEpD;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,mBAAmB,CAAC;QACnC;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;CAAG;AAE1D,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as ContactsAPI from "./contacts.mjs";
|
|
3
|
+
import * as Shared from "./shared.mjs";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
|
+
export declare class Recordings extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Deletes a recording. The recording file will be removed from storage
|
|
9
|
+
* asynchronously.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const recording = await client.recordings.delete(
|
|
14
|
+
* 'rec_01kfyc9dgdec1avkgs7tng8htg',
|
|
15
|
+
* );
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
delete(id: string, options?: RequestOptions): APIPromise<RecordingDeleteResponse>;
|
|
19
|
+
/**
|
|
20
|
+
* Redirects to a signed URL where the recording audio file can be downloaded. URL
|
|
21
|
+
* is short-lived, so redirect should be followed immediately.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const response = await client.recordings.getFile(
|
|
26
|
+
* 'rec_01kfyc9dgdec1avkgs7tng8htg',
|
|
27
|
+
* );
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
getFile(recordingID: string, options?: RequestOptions): APIPromise<RecordingGetFileResponse>;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* A call recording
|
|
34
|
+
*/
|
|
35
|
+
export interface RecordingDeleteResponse {
|
|
36
|
+
/**
|
|
37
|
+
* The unique identifier for the recording
|
|
38
|
+
*/
|
|
39
|
+
id: string;
|
|
40
|
+
/**
|
|
41
|
+
* The call that produced this recording
|
|
42
|
+
*/
|
|
43
|
+
call: RecordingDeleteResponse.Call;
|
|
44
|
+
/**
|
|
45
|
+
* The duration of the recording in seconds
|
|
46
|
+
*/
|
|
47
|
+
duration: number;
|
|
48
|
+
}
|
|
49
|
+
export declare namespace RecordingDeleteResponse {
|
|
50
|
+
/**
|
|
51
|
+
* The call that produced this recording
|
|
52
|
+
*/
|
|
53
|
+
interface Call {
|
|
54
|
+
/**
|
|
55
|
+
* The unique identifier for the call
|
|
56
|
+
*/
|
|
57
|
+
id: string;
|
|
58
|
+
/**
|
|
59
|
+
* A contact who has consented to receive messages
|
|
60
|
+
*/
|
|
61
|
+
contact: ContactsAPI.Contact;
|
|
62
|
+
/**
|
|
63
|
+
* The duration of the call in seconds
|
|
64
|
+
*/
|
|
65
|
+
duration: number;
|
|
66
|
+
/**
|
|
67
|
+
* When the call was initiated
|
|
68
|
+
*/
|
|
69
|
+
initiated_at: string;
|
|
70
|
+
/**
|
|
71
|
+
* The status of the call
|
|
72
|
+
*/
|
|
73
|
+
status: 'busy' | 'canceled' | 'completed' | 'failed' | 'in_progress' | 'missed' | 'no_answer' | 'queued' | 'ringing';
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* An error response
|
|
78
|
+
*/
|
|
79
|
+
export interface RecordingGetFileResponse {
|
|
80
|
+
/**
|
|
81
|
+
* An error response
|
|
82
|
+
*/
|
|
83
|
+
error: Shared.Error;
|
|
84
|
+
}
|
|
85
|
+
export declare namespace Recordings {
|
|
86
|
+
export { type RecordingDeleteResponse as RecordingDeleteResponse, type RecordingGetFileResponse as RecordingGetFileResponse, };
|
|
87
|
+
}
|
|
88
|
+
//# sourceMappingURL=recordings.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"recordings.d.mts","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIjF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EACF,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,SAAS,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as ContactsAPI from "./contacts.js";
|
|
3
|
+
import * as Shared from "./shared.js";
|
|
4
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
6
|
+
export declare class Recordings extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Deletes a recording. The recording file will be removed from storage
|
|
9
|
+
* asynchronously.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const recording = await client.recordings.delete(
|
|
14
|
+
* 'rec_01kfyc9dgdec1avkgs7tng8htg',
|
|
15
|
+
* );
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
delete(id: string, options?: RequestOptions): APIPromise<RecordingDeleteResponse>;
|
|
19
|
+
/**
|
|
20
|
+
* Redirects to a signed URL where the recording audio file can be downloaded. URL
|
|
21
|
+
* is short-lived, so redirect should be followed immediately.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const response = await client.recordings.getFile(
|
|
26
|
+
* 'rec_01kfyc9dgdec1avkgs7tng8htg',
|
|
27
|
+
* );
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
getFile(recordingID: string, options?: RequestOptions): APIPromise<RecordingGetFileResponse>;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* A call recording
|
|
34
|
+
*/
|
|
35
|
+
export interface RecordingDeleteResponse {
|
|
36
|
+
/**
|
|
37
|
+
* The unique identifier for the recording
|
|
38
|
+
*/
|
|
39
|
+
id: string;
|
|
40
|
+
/**
|
|
41
|
+
* The call that produced this recording
|
|
42
|
+
*/
|
|
43
|
+
call: RecordingDeleteResponse.Call;
|
|
44
|
+
/**
|
|
45
|
+
* The duration of the recording in seconds
|
|
46
|
+
*/
|
|
47
|
+
duration: number;
|
|
48
|
+
}
|
|
49
|
+
export declare namespace RecordingDeleteResponse {
|
|
50
|
+
/**
|
|
51
|
+
* The call that produced this recording
|
|
52
|
+
*/
|
|
53
|
+
interface Call {
|
|
54
|
+
/**
|
|
55
|
+
* The unique identifier for the call
|
|
56
|
+
*/
|
|
57
|
+
id: string;
|
|
58
|
+
/**
|
|
59
|
+
* A contact who has consented to receive messages
|
|
60
|
+
*/
|
|
61
|
+
contact: ContactsAPI.Contact;
|
|
62
|
+
/**
|
|
63
|
+
* The duration of the call in seconds
|
|
64
|
+
*/
|
|
65
|
+
duration: number;
|
|
66
|
+
/**
|
|
67
|
+
* When the call was initiated
|
|
68
|
+
*/
|
|
69
|
+
initiated_at: string;
|
|
70
|
+
/**
|
|
71
|
+
* The status of the call
|
|
72
|
+
*/
|
|
73
|
+
status: 'busy' | 'canceled' | 'completed' | 'failed' | 'in_progress' | 'missed' | 'no_answer' | 'queued' | 'ringing';
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* An error response
|
|
78
|
+
*/
|
|
79
|
+
export interface RecordingGetFileResponse {
|
|
80
|
+
/**
|
|
81
|
+
* An error response
|
|
82
|
+
*/
|
|
83
|
+
error: Shared.Error;
|
|
84
|
+
}
|
|
85
|
+
export declare namespace Recordings {
|
|
86
|
+
export { type RecordingDeleteResponse as RecordingDeleteResponse, type RecordingGetFileResponse as RecordingGetFileResponse, };
|
|
87
|
+
}
|
|
88
|
+
//# sourceMappingURL=recordings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"recordings.d.ts","sourceRoot":"","sources":["../src/resources/recordings.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIjF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EACF,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,SAAS,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|