@isnap/sdk 2.3.0 → 2.3.1-next.43435188216.1
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 +65 -40
- package/README.md +360 -167
- package/dist/client.d.ts +35 -49
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +44 -58
- package/dist/client.js.map +1 -1
- package/dist/config.d.ts +6 -6
- package/dist/config.js +6 -6
- package/dist/generated/openapi.d.ts +403 -14
- package/dist/internal/sleep.d.ts +2 -2
- package/dist/internal/sleep.js +5 -5
- package/dist/internal/sleep.js.map +1 -1
- package/dist/resources/apps.d.ts +11 -18
- package/dist/resources/apps.d.ts.map +1 -1
- package/dist/resources/apps.js +11 -18
- package/dist/resources/apps.js.map +1 -1
- package/dist/resources/area-codes.d.ts +5 -6
- package/dist/resources/area-codes.d.ts.map +1 -1
- package/dist/resources/area-codes.js +5 -6
- package/dist/resources/area-codes.js.map +1 -1
- package/dist/resources/attachments.d.ts +51 -17
- package/dist/resources/attachments.d.ts.map +1 -1
- package/dist/resources/attachments.js +42 -22
- package/dist/resources/attachments.js.map +1 -1
- package/dist/resources/byod.d.ts +14 -4
- package/dist/resources/byod.d.ts.map +1 -1
- package/dist/resources/byod.js +14 -4
- package/dist/resources/byod.js.map +1 -1
- package/dist/resources/chats.d.ts +30 -22
- package/dist/resources/chats.d.ts.map +1 -1
- package/dist/resources/chats.js +29 -21
- package/dist/resources/chats.js.map +1 -1
- package/dist/resources/lines.d.ts +240 -266
- package/dist/resources/lines.d.ts.map +1 -1
- package/dist/resources/lines.js +240 -266
- package/dist/resources/lines.js.map +1 -1
- package/dist/resources/lookup.d.ts +10 -13
- package/dist/resources/lookup.d.ts.map +1 -1
- package/dist/resources/lookup.js +10 -13
- package/dist/resources/lookup.js.map +1 -1
- package/dist/resources/macos-sessions.d.ts +42 -36
- package/dist/resources/macos-sessions.d.ts.map +1 -1
- package/dist/resources/macos-sessions.js +24 -22
- package/dist/resources/macos-sessions.js.map +1 -1
- package/dist/resources/messages.d.ts +35 -25
- package/dist/resources/messages.d.ts.map +1 -1
- package/dist/resources/messages.js +30 -19
- package/dist/resources/messages.js.map +1 -1
- package/dist/resources/preorders.d.ts +42 -47
- package/dist/resources/preorders.d.ts.map +1 -1
- package/dist/resources/preorders.js +42 -47
- package/dist/resources/preorders.js.map +1 -1
- package/dist/resources/trial.d.ts +30 -21
- package/dist/resources/trial.d.ts.map +1 -1
- package/dist/resources/trial.js +30 -21
- package/dist/resources/trial.js.map +1 -1
- package/dist/resources/webhooks.d.ts +39 -22
- package/dist/resources/webhooks.d.ts.map +1 -1
- package/dist/resources/webhooks.js +39 -22
- package/dist/resources/webhooks.js.map +1 -1
- package/dist/retry.d.ts +9 -10
- package/dist/retry.d.ts.map +1 -1
- package/dist/retry.js +11 -12
- package/dist/retry.js.map +1 -1
- package/dist/types.d.ts +10 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +13 -37
- package/dist/version.js.map +1 -1
- package/dist/webhooks/parse.d.ts +10 -9
- package/dist/webhooks/parse.d.ts.map +1 -1
- package/dist/webhooks/parse.js +14 -13
- package/dist/webhooks/parse.js.map +1 -1
- package/dist/webhooks/types.d.ts +74 -110
- package/dist/webhooks/types.d.ts.map +1 -1
- package/dist/webhooks/types.js.map +1 -1
- package/dist/webhooks/verify.d.ts +27 -29
- package/dist/webhooks/verify.d.ts.map +1 -1
- package/dist/webhooks/verify.js +29 -35
- package/dist/webhooks/verify.js.map +1 -1
- package/examples/handle-webhook.ts +146 -0
- package/examples/paginate-messages.ts +54 -0
- package/examples/send-message.ts +37 -0
- package/examples/upload-attachment.ts +91 -0
- package/package.json +4 -8
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lines.js","sourceRoot":"","sources":["../../src/resources/lines.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AA0BxC,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C;;;;;OAKG;IACH,IAAI,CAAC,QAAwB,EAAE,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE;YAClE,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"lines.js","sourceRoot":"","sources":["../../src/resources/lines.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AA0BxC,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C;;;;;OAKG;IACH,IAAI,CAAC,QAAwB,EAAE,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE;YAClE,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAqB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAU,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IAC7E,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,KAAK,EAAE,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAoB,EAAE,IAAqB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,OAA2B,EAAE,EAAE,IAAqB;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1E,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAyB,EAAE,EAAE,IAAqB;QACrE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAC9C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,SAAS,CAAC,EAAU,EAAE,OAA0B,EAAE,EAAE,IAAqB;QACvE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAC/C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,EAAU,EAAE,IAAqB;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAC9C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,EAAU,EACV,IAA4B,EAC5B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,cAAc,EACjD,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CACf,EAAU,EACV,IAA2B,EAC3B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,qBAAqB,EACxD,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAU,EAAE,IAAqB;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,kBAAkB,EACrD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,EAAU,EAAE,IAAqB;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,oBAAoB,EACvD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,UAAU,CAAC,EAAU,EAAE,IAAwB,EAAE,IAAqB;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CAAC,EAAU,EAAE,IAAqB;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,QAAQ,EACR,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAU,EAAE,IAAmB,EAAE,IAAqB;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACrC,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,EAAU,EAAE,IAAqB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAC3C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CACH,EAAU,EACV,QAAwB,EAAE,EAC1B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAC3C,SAAS,EACT,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,EAAE,CACjD,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,EAAU,EACV,OAA6B,EAAE,EAC/B,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,aAAa,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC7C,IAAI;QACJ,0EAA0E;QAC1E,8CAA8C;QAC9C,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,IAAI,CAAC,EAAE,CAC/C,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,EAAU,EAAE,IAAqB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,EAAU,EACV,IAAqB,EACrB,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,aAAa,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC5C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;CACF"}
|
|
@@ -5,22 +5,19 @@ export type LookupRequest = components['schemas']['LookupRequest'];
|
|
|
5
5
|
export type LookupResult = components['schemas']['Lookup'];
|
|
6
6
|
export declare class LookupResource extends BaseResource {
|
|
7
7
|
/**
|
|
8
|
-
* `POST /v1/lookup
|
|
8
|
+
* `POST /v1/lookup`: check whether a handle can receive iMessage.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
10
|
+
* The call resolves the same way on a final answer and on a pending one,
|
|
11
|
+
* and the HTTP status is not available: branch on `pending`.
|
|
12
12
|
*
|
|
13
|
-
* -
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* answered within the wait budget. `pending: true`, `imessage: null`,
|
|
19
|
-
* plus `probe_id` and `retry_after` (seconds).
|
|
13
|
+
* - Final (`200`): `imessage` is `true`, `false` or `null`, and `pending` is
|
|
14
|
+
* absent. `null` means the answer is unknown and no check was started.
|
|
15
|
+
* - Pending (`202`): a check was started and has given no answer yet.
|
|
16
|
+
* `pending` is `true`, `imessage` is `null`, and the result carries
|
|
17
|
+
* `probe_id` and `retry_after` (seconds).
|
|
20
18
|
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* probe warms answers `200`.
|
|
19
|
+
* No event announces the result. Repeat the same call after `retry_after`
|
|
20
|
+
* seconds.
|
|
24
21
|
*
|
|
25
22
|
* ```ts
|
|
26
23
|
* const result = await client.lookup.check({ handle })
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lookup.d.ts","sourceRoot":"","sources":["../../src/resources/lookup.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAA;AAE1D,qBAAa,cAAe,SAAQ,YAAY;IAC9C
|
|
1
|
+
{"version":3,"file":"lookup.d.ts","sourceRoot":"","sources":["../../src/resources/lookup.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAA;AAE1D,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;CAG3E"}
|
package/dist/resources/lookup.js
CHANGED
|
@@ -1,22 +1,19 @@
|
|
|
1
1
|
import { BaseResource } from './base.js';
|
|
2
2
|
export class LookupResource extends BaseResource {
|
|
3
3
|
/**
|
|
4
|
-
* `POST /v1/lookup
|
|
4
|
+
* `POST /v1/lookup`: check whether a handle can receive iMessage.
|
|
5
5
|
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
6
|
+
* The call resolves the same way on a final answer and on a pending one,
|
|
7
|
+
* and the HTTP status is not available: branch on `pending`.
|
|
8
8
|
*
|
|
9
|
-
* -
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* answered within the wait budget. `pending: true`, `imessage: null`,
|
|
15
|
-
* plus `probe_id` and `retry_after` (seconds).
|
|
9
|
+
* - Final (`200`): `imessage` is `true`, `false` or `null`, and `pending` is
|
|
10
|
+
* absent. `null` means the answer is unknown and no check was started.
|
|
11
|
+
* - Pending (`202`): a check was started and has given no answer yet.
|
|
12
|
+
* `pending` is `true`, `imessage` is `null`, and the result carries
|
|
13
|
+
* `probe_id` and `retry_after` (seconds).
|
|
16
14
|
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* probe warms answers `200`.
|
|
15
|
+
* No event announces the result. Repeat the same call after `retry_after`
|
|
16
|
+
* seconds.
|
|
20
17
|
*
|
|
21
18
|
* ```ts
|
|
22
19
|
* const result = await client.lookup.check({ handle })
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lookup.js","sourceRoot":"","sources":["../../src/resources/lookup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAKxC,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C
|
|
1
|
+
{"version":3,"file":"lookup.js","sourceRoot":"","sources":["../../src/resources/lookup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAKxC,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAqB,EAAE,IAAqB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAe,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IAC9E,CAAC;CACF"}
|
|
@@ -5,65 +5,71 @@ export type MacosSession = components['schemas']['MacosSession'];
|
|
|
5
5
|
export type RentMacosSessionBody = components['schemas']['RentMacosSession'];
|
|
6
6
|
export type PatchMacosSessionBody = components['schemas']['PatchMacosSession'];
|
|
7
7
|
/**
|
|
8
|
-
* Hosted macOS sessions rented
|
|
8
|
+
* Hosted macOS sessions rented by a wholesale partner.
|
|
9
9
|
*
|
|
10
|
-
* A session is a macOS
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* platform or a capability.
|
|
10
|
+
* A hosted macOS session is a macOS user account on an iSnap Mac, signed into
|
|
11
|
+
* no Apple ID when you receive it. It is not a line: it has no number and
|
|
12
|
+
* sends nothing.
|
|
14
13
|
*
|
|
15
|
-
*
|
|
16
|
-
* `
|
|
17
|
-
*
|
|
14
|
+
* Wholesale partners only. For any other account `rent` is a
|
|
15
|
+
* `PermissionDeniedError` (403 `not_a_wholesale_partner`), and the other
|
|
16
|
+
* methods return `404` for a session the caller does not rent. A direct
|
|
17
|
+
* account buys sessions in the iSnap dashboard.
|
|
18
18
|
*/
|
|
19
19
|
export declare class MacosSessionsResource extends BaseResource {
|
|
20
20
|
/**
|
|
21
|
-
* `POST /v1/macos-sessions/rent
|
|
21
|
+
* `POST /v1/macos-sessions/rent`: rent one session from iSnap stock.
|
|
22
22
|
*
|
|
23
|
-
* The tenancy starts immediately and `anniversary_at` is
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
23
|
+
* The tenancy starts immediately and `anniversary_at` is set to the time of
|
|
24
|
+
* the call: the session bills monthly on that day, moved to the last day of
|
|
25
|
+
* shorter months. With no free session the call is a `ConflictError` (409
|
|
26
|
+
* `no_macos_session_in_stock`) and nothing is recorded. iSnap can later
|
|
27
|
+
* attach a session to your account and announce it with
|
|
28
|
+
* `macos_session.rented`; that attach is not linked to the refused call.
|
|
28
29
|
*
|
|
29
|
-
* One call rents one session
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* One call rents one session. The API honors the idempotency key on this
|
|
31
|
+
* operation: calls that share a key and a body within 24 hours rent at most
|
|
32
|
+
* one session between them, and once one of them has succeeded the later
|
|
33
|
+
* ones get its response. A call that fails records nothing, so a later call
|
|
34
|
+
* with the same key runs again. The SDK generates a key per call unless you
|
|
35
|
+
* pass `opts.idempotencyKey`. To rent three sessions, make three calls, each
|
|
36
|
+
* with its own key. Reuse a key only to retry the call it was first sent
|
|
37
|
+
* with.
|
|
34
38
|
*
|
|
35
|
-
* Pass `{ metadata }` to
|
|
36
|
-
* back on the session and as `data.metadata` on every
|
|
37
|
-
*
|
|
39
|
+
* Pass `{ metadata }` to attach your own identifiers to the session: they
|
|
40
|
+
* come back on the session and as `data.metadata` on every
|
|
41
|
+
* `macos_session.*` event. `rent(opts)`, without a body, is accepted too.
|
|
38
42
|
*/
|
|
39
43
|
rent(opts?: RequestOptions): Promise<MacosSession>;
|
|
40
44
|
rent(body: RentMacosSessionBody, opts?: RequestOptions): Promise<MacosSession>;
|
|
41
45
|
/**
|
|
42
|
-
* `GET /v1/macos-sessions/{id}
|
|
43
|
-
* A session rented by
|
|
46
|
+
* `GET /v1/macos-sessions/{id}`: one session you rent, with its `metadata`.
|
|
47
|
+
* A session rented by another account, or already released, returns `404`.
|
|
44
48
|
*/
|
|
45
49
|
get(id: string, opts?: RequestOptions): Promise<MacosSession>;
|
|
46
50
|
/**
|
|
47
|
-
* `PATCH /v1/macos-sessions/{id}
|
|
48
|
-
* A key you send overwrites, a key sent as `null` is deleted, every
|
|
49
|
-
* is kept. The
|
|
51
|
+
* `PATCH /v1/macos-sessions/{id}`: merge `metadata` into the session's
|
|
52
|
+
* metadata. A key you send overwrites, a key sent as `null` is deleted, every
|
|
53
|
+
* other key is kept. The metadata is cleared when the session is released.
|
|
50
54
|
*/
|
|
51
55
|
update(id: string, body: PatchMacosSessionBody, opts?: RequestOptions): Promise<MacosSession>;
|
|
52
56
|
/**
|
|
53
|
-
* `POST /v1/macos-sessions/{id}/cancel
|
|
57
|
+
* `POST /v1/macos-sessions/{id}/cancel`: end the tenancy at its next
|
|
58
|
+
* anniversary.
|
|
54
59
|
*
|
|
55
|
-
* The session
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* month further out.
|
|
60
|
+
* The session works and bills until `cancel_at`, the next occurrence of
|
|
61
|
+
* `anniversary_at` strictly after the call. A second call returns the same
|
|
62
|
+
* `cancel_at`.
|
|
59
63
|
*/
|
|
60
64
|
cancel(id: string, opts?: RequestOptions): Promise<MacosSession>;
|
|
61
65
|
/**
|
|
62
|
-
* `POST /v1/macos-sessions/{id}/uncancel
|
|
66
|
+
* `POST /v1/macos-sessions/{id}/uncancel`: withdraw a pending cancellation.
|
|
63
67
|
*
|
|
64
|
-
* Clears `cancel_at` and
|
|
65
|
-
*
|
|
66
|
-
*
|
|
68
|
+
* Clears `cancel_at` and keeps `anniversary_at`, so the billing day does not
|
|
69
|
+
* move. It changes nothing on a session that is not canceled. Once
|
|
70
|
+
* `cancel_at` has passed the call is a `ConflictError` (409
|
|
71
|
+
* `macos_session_cancellation_already_due`), and once the session is released
|
|
72
|
+
* it returns `404`.
|
|
67
73
|
*/
|
|
68
74
|
uncancel(id: string, opts?: RequestOptions): Promise<MacosSession>;
|
|
69
75
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"macos-sessions.d.ts","sourceRoot":"","sources":["../../src/resources/macos-sessions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAA;AAChE,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAC5E,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAA;AAE9E;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD
|
|
1
|
+
{"version":3,"file":"macos-sessions.d.ts","sourceRoot":"","sources":["../../src/resources/macos-sessions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAA;AAChE,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAC5E,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAA;AAE9E;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAClD,IAAI,CAAC,IAAI,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAgB9E;;;OAGG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAS7D;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAS7F;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShE;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;CAQnE"}
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import { BaseResource } from './base.js';
|
|
2
2
|
/**
|
|
3
|
-
* Hosted macOS sessions rented
|
|
3
|
+
* Hosted macOS sessions rented by a wholesale partner.
|
|
4
4
|
*
|
|
5
|
-
* A session is a macOS
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* platform or a capability.
|
|
5
|
+
* A hosted macOS session is a macOS user account on an iSnap Mac, signed into
|
|
6
|
+
* no Apple ID when you receive it. It is not a line: it has no number and
|
|
7
|
+
* sends nothing.
|
|
9
8
|
*
|
|
10
|
-
*
|
|
11
|
-
* `
|
|
12
|
-
*
|
|
9
|
+
* Wholesale partners only. For any other account `rent` is a
|
|
10
|
+
* `PermissionDeniedError` (403 `not_a_wholesale_partner`), and the other
|
|
11
|
+
* methods return `404` for a session the caller does not rent. A direct
|
|
12
|
+
* account buys sessions in the iSnap dashboard.
|
|
13
13
|
*/
|
|
14
14
|
export class MacosSessionsResource extends BaseResource {
|
|
15
15
|
rent(bodyOrOpts, opts) {
|
|
@@ -19,37 +19,39 @@ export class MacosSessionsResource extends BaseResource {
|
|
|
19
19
|
return this.client.request('POST', '/v1/macos-sessions/rent', hasBody ? bodyOrOpts : undefined, hasBody ? opts : bodyOrOpts);
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* `GET /v1/macos-sessions/{id}
|
|
23
|
-
* A session rented by
|
|
22
|
+
* `GET /v1/macos-sessions/{id}`: one session you rent, with its `metadata`.
|
|
23
|
+
* A session rented by another account, or already released, returns `404`.
|
|
24
24
|
*/
|
|
25
25
|
get(id, opts) {
|
|
26
26
|
return this.client.request('GET', `/v1/macos-sessions/${encodeURIComponent(id)}`, undefined, opts);
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
|
-
* `PATCH /v1/macos-sessions/{id}
|
|
30
|
-
* A key you send overwrites, a key sent as `null` is deleted, every
|
|
31
|
-
* is kept. The
|
|
29
|
+
* `PATCH /v1/macos-sessions/{id}`: merge `metadata` into the session's
|
|
30
|
+
* metadata. A key you send overwrites, a key sent as `null` is deleted, every
|
|
31
|
+
* other key is kept. The metadata is cleared when the session is released.
|
|
32
32
|
*/
|
|
33
33
|
update(id, body, opts) {
|
|
34
34
|
return this.client.request('PATCH', `/v1/macos-sessions/${encodeURIComponent(id)}`, body, opts);
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* `POST /v1/macos-sessions/{id}/cancel
|
|
37
|
+
* `POST /v1/macos-sessions/{id}/cancel`: end the tenancy at its next
|
|
38
|
+
* anniversary.
|
|
38
39
|
*
|
|
39
|
-
* The session
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* month further out.
|
|
40
|
+
* The session works and bills until `cancel_at`, the next occurrence of
|
|
41
|
+
* `anniversary_at` strictly after the call. A second call returns the same
|
|
42
|
+
* `cancel_at`.
|
|
43
43
|
*/
|
|
44
44
|
cancel(id, opts) {
|
|
45
45
|
return this.client.request('POST', `/v1/macos-sessions/${encodeURIComponent(id)}/cancel`, undefined, opts);
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
* `POST /v1/macos-sessions/{id}/uncancel
|
|
48
|
+
* `POST /v1/macos-sessions/{id}/uncancel`: withdraw a pending cancellation.
|
|
49
49
|
*
|
|
50
|
-
* Clears `cancel_at` and
|
|
51
|
-
*
|
|
52
|
-
*
|
|
50
|
+
* Clears `cancel_at` and keeps `anniversary_at`, so the billing day does not
|
|
51
|
+
* move. It changes nothing on a session that is not canceled. Once
|
|
52
|
+
* `cancel_at` has passed the call is a `ConflictError` (409
|
|
53
|
+
* `macos_session_cancellation_already_due`), and once the session is released
|
|
54
|
+
* it returns `404`.
|
|
53
55
|
*/
|
|
54
56
|
uncancel(id, opts) {
|
|
55
57
|
return this.client.request('POST', `/v1/macos-sessions/${encodeURIComponent(id)}/uncancel`, undefined, opts);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"macos-sessions.js","sourceRoot":"","sources":["../../src/resources/macos-sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAMxC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;
|
|
1
|
+
{"version":3,"file":"macos-sessions.js","sourceRoot":"","sources":["../../src/resources/macos-sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAMxC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IA0BrD,IAAI,CACF,UAAkD,EAClD,IAAqB;QAErB,2EAA2E;QAC3E,2CAA2C;QAC3C,MAAM,OAAO,GAAG,UAAU,KAAK,SAAS,IAAI,UAAU,IAAI,UAAU,CAAA;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,yBAAyB,EACzB,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAChC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,UAAyC,CAC5D,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,sBAAsB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC9C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,IAA2B,EAAE,IAAqB;QACnE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,sBAAsB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC9C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,sBAAsB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACrD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,IAAqB;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,sBAAsB,kBAAkB,CAAC,EAAE,CAAC,WAAW,EACvD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;CACF"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { components, paths } from '../generated/openapi.js';
|
|
2
2
|
import type { RequestOptions } from '../types.js';
|
|
3
3
|
import { BaseResource } from './base.js';
|
|
4
|
-
/**
|
|
4
|
+
/** A message, as `send`, `get`, `list` and `cancel` return it. */
|
|
5
5
|
export type Message = components['schemas']['MessageV1'];
|
|
6
6
|
export type SendMessageBody = NonNullable<paths['/v1/messages']['post']['requestBody']>['content']['application/json'];
|
|
7
7
|
export type ListMessagesQuery = NonNullable<paths['/v1/messages']['get']['parameters']['query']>;
|
|
@@ -9,45 +9,55 @@ export type SendReactionBody = components['schemas']['SendReactionRequest'];
|
|
|
9
9
|
export type Reaction = components['schemas']['Reaction'];
|
|
10
10
|
export type ReactionRemoval = components['schemas']['ReactionRemoval'];
|
|
11
11
|
/**
|
|
12
|
-
* The
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* `MessageReactionV1` so a regeneration cannot silently drop `custom`.
|
|
12
|
+
* The kind of a reaction as the API reports it: the six kinds you can send,
|
|
13
|
+
* plus `custom` for any other emoji a contact sends. It is wider than
|
|
14
|
+
* `Reaction['type']` and `SendReactionBody['type']`, which cover only what you
|
|
15
|
+
* can send.
|
|
17
16
|
*/
|
|
18
17
|
export type ReactionType = components['schemas']['MessageReactionV1']['reaction_type'];
|
|
19
18
|
export declare class MessagesResource extends BaseResource {
|
|
20
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* `POST /v1/messages`: send a message. Resolves with the message, whose
|
|
21
|
+
* `status` is `queued` when it leaves now and `scheduled` when iSnap holds
|
|
22
|
+
* it.
|
|
23
|
+
*
|
|
24
|
+
* The API honors the idempotency key on this operation: a repeat with the
|
|
25
|
+
* same key and body resolves with the message first sent, in its current
|
|
26
|
+
* `status`. The key belongs to the line, and the API remembers it for as
|
|
27
|
+
* long as it keeps the message, at least 72 hours.
|
|
28
|
+
*/
|
|
21
29
|
send(body: SendMessageBody, opts?: RequestOptions): Promise<Message>;
|
|
22
|
-
/** `GET /v1/messages/{id}
|
|
30
|
+
/** `GET /v1/messages/{id}`: one message. */
|
|
23
31
|
get(id: string, opts?: RequestOptions): Promise<Message>;
|
|
24
32
|
/**
|
|
25
|
-
* `GET /v1/messages
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
33
|
+
* `GET /v1/messages`: your messages, as an `AsyncIterable`. A `for await`
|
|
34
|
+
* loop receives every matching message; the SDK fetches the next page when
|
|
35
|
+
* the current one is consumed. Messages come newest first unless `sort` or
|
|
36
|
+
* `order` says otherwise. Set the page size with `limit` (1 to 100, default
|
|
37
|
+
* 25).
|
|
30
38
|
*/
|
|
31
39
|
list(filters?: Omit<ListMessagesQuery, 'cursor'>, opts?: RequestOptions): AsyncIterable<Message>;
|
|
32
40
|
/**
|
|
33
|
-
* `POST /v1/messages/{id}/reactions
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
41
|
+
* `POST /v1/messages/{id}/reactions`: put the line's reaction (an iMessage
|
|
42
|
+
* tapback) on a message of the line, received or sent. `type` is `love`,
|
|
43
|
+
* `like`, `dislike`, `laugh`, `emphasize` or `question`. A line has at most
|
|
44
|
+
* one reaction per message: a call with another `type` replaces it. The
|
|
45
|
+
* message must be an iMessage message: an SMS or RCS message is an
|
|
46
|
+
* `UnprocessableEntityError` (422 `sms_reactions_not_supported`).
|
|
38
47
|
*/
|
|
39
48
|
addReaction(messageId: string, body: SendReactionBody, opts?: RequestOptions): Promise<Reaction>;
|
|
40
49
|
/**
|
|
41
|
-
* `DELETE /v1/messages/{id}/reactions
|
|
42
|
-
* message.
|
|
43
|
-
* was
|
|
44
|
-
*
|
|
45
|
-
* for UI feedback ("removed your 'love'").
|
|
50
|
+
* `DELETE /v1/messages/{id}/reactions`: remove the line's reaction from a
|
|
51
|
+
* message. Resolves with `{ parent_message_id, removed, type }`. When there
|
|
52
|
+
* was no reaction to remove, `removed` is `false` and `type` is `null`: the
|
|
53
|
+
* call does not return `404`.
|
|
46
54
|
*/
|
|
47
55
|
removeReaction(messageId: string, opts?: RequestOptions): Promise<ReactionRemoval>;
|
|
48
56
|
/**
|
|
49
|
-
* `DELETE /v1/messages/{id}
|
|
50
|
-
*
|
|
57
|
+
* `DELETE /v1/messages/{id}`: cancel a message whose `status` is `queued` or
|
|
58
|
+
* `scheduled` and that the line's device has not taken. Resolves with the
|
|
59
|
+
* message, `status: cancelled`. Any other message is a `ConflictError` (409
|
|
60
|
+
* `too_late_to_cancel`).
|
|
51
61
|
*/
|
|
52
62
|
cancel(id: string, opts?: RequestOptions): Promise<Message>;
|
|
53
63
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/resources/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAGhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,
|
|
1
|
+
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/resources/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAGhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,kEAAkE;AAClE,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAA;AACxD,MAAM,MAAM,eAAe,GAAG,WAAW,CACvC,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAC7C,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAChC,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;AAChG,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAA;AAC3E,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAA;AACxD,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACtE;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC,eAAe,CAAC,CAAA;AAEtF,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpE,4CAA4C;IAC5C,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxD;;;;;;OAMG;IACH,IAAI,CACF,OAAO,GAAE,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAM,EAC/C,IAAI,CAAC,EAAE,cAAc,GACpB,aAAa,CAAC,OAAO,CAAC;IAWzB;;;;;;;OAOG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAShG;;;;;OAKG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASlF;;;;;OAKG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;CAQ5D"}
|
|
@@ -1,20 +1,29 @@
|
|
|
1
1
|
import { paginate } from '../pagination.js';
|
|
2
2
|
import { BaseResource } from './base.js';
|
|
3
3
|
export class MessagesResource extends BaseResource {
|
|
4
|
-
/**
|
|
4
|
+
/**
|
|
5
|
+
* `POST /v1/messages`: send a message. Resolves with the message, whose
|
|
6
|
+
* `status` is `queued` when it leaves now and `scheduled` when iSnap holds
|
|
7
|
+
* it.
|
|
8
|
+
*
|
|
9
|
+
* The API honors the idempotency key on this operation: a repeat with the
|
|
10
|
+
* same key and body resolves with the message first sent, in its current
|
|
11
|
+
* `status`. The key belongs to the line, and the API remembers it for as
|
|
12
|
+
* long as it keeps the message, at least 72 hours.
|
|
13
|
+
*/
|
|
5
14
|
send(body, opts) {
|
|
6
15
|
return this.client.request('POST', '/v1/messages', body, opts);
|
|
7
16
|
}
|
|
8
|
-
/** `GET /v1/messages/{id}
|
|
17
|
+
/** `GET /v1/messages/{id}`: one message. */
|
|
9
18
|
get(id, opts) {
|
|
10
19
|
return this.client.request('GET', `/v1/messages/${encodeURIComponent(id)}`, undefined, opts);
|
|
11
20
|
}
|
|
12
21
|
/**
|
|
13
|
-
* `GET /v1/messages
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
22
|
+
* `GET /v1/messages`: your messages, as an `AsyncIterable`. A `for await`
|
|
23
|
+
* loop receives every matching message; the SDK fetches the next page when
|
|
24
|
+
* the current one is consumed. Messages come newest first unless `sort` or
|
|
25
|
+
* `order` says otherwise. Set the page size with `limit` (1 to 100, default
|
|
26
|
+
* 25).
|
|
18
27
|
*/
|
|
19
28
|
list(filters = {}, opts) {
|
|
20
29
|
return paginate((cursor) => this.client.request('GET', '/v1/messages', undefined, {
|
|
@@ -23,28 +32,30 @@ export class MessagesResource extends BaseResource {
|
|
|
23
32
|
}), { signal: opts?.signal });
|
|
24
33
|
}
|
|
25
34
|
/**
|
|
26
|
-
* `POST /v1/messages/{id}/reactions
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
35
|
+
* `POST /v1/messages/{id}/reactions`: put the line's reaction (an iMessage
|
|
36
|
+
* tapback) on a message of the line, received or sent. `type` is `love`,
|
|
37
|
+
* `like`, `dislike`, `laugh`, `emphasize` or `question`. A line has at most
|
|
38
|
+
* one reaction per message: a call with another `type` replaces it. The
|
|
39
|
+
* message must be an iMessage message: an SMS or RCS message is an
|
|
40
|
+
* `UnprocessableEntityError` (422 `sms_reactions_not_supported`).
|
|
31
41
|
*/
|
|
32
42
|
addReaction(messageId, body, opts) {
|
|
33
43
|
return this.client.request('POST', `/v1/messages/${encodeURIComponent(messageId)}/reactions`, body, opts);
|
|
34
44
|
}
|
|
35
45
|
/**
|
|
36
|
-
* `DELETE /v1/messages/{id}/reactions
|
|
37
|
-
* message.
|
|
38
|
-
* was
|
|
39
|
-
*
|
|
40
|
-
* for UI feedback ("removed your 'love'").
|
|
46
|
+
* `DELETE /v1/messages/{id}/reactions`: remove the line's reaction from a
|
|
47
|
+
* message. Resolves with `{ parent_message_id, removed, type }`. When there
|
|
48
|
+
* was no reaction to remove, `removed` is `false` and `type` is `null`: the
|
|
49
|
+
* call does not return `404`.
|
|
41
50
|
*/
|
|
42
51
|
removeReaction(messageId, opts) {
|
|
43
52
|
return this.client.request('DELETE', `/v1/messages/${encodeURIComponent(messageId)}/reactions`, undefined, opts);
|
|
44
53
|
}
|
|
45
54
|
/**
|
|
46
|
-
* `DELETE /v1/messages/{id}
|
|
47
|
-
*
|
|
55
|
+
* `DELETE /v1/messages/{id}`: cancel a message whose `status` is `queued` or
|
|
56
|
+
* `scheduled` and that the line's device has not taken. Resolves with the
|
|
57
|
+
* message, `status: cancelled`. Any other message is a `ConflictError` (409
|
|
58
|
+
* `too_late_to_cancel`).
|
|
48
59
|
*/
|
|
49
60
|
cancel(id, opts) {
|
|
50
61
|
return this.client.request('DELETE', `/v1/messages/${encodeURIComponent(id)}`, undefined, opts);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;
|
|
1
|
+
{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAmBxC,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAqB,EAAE,IAAqB;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAU,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IACzE,CAAC;IAED,4CAA4C;IAC5C,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAU,KAAK,EAAE,gBAAgB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAA;IACvG,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,UAA6C,EAAE,EAC/C,IAAqB;QAErB,OAAO,QAAQ,CACb,CAAC,MAAM,EAAE,EAAE,CACT,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsB,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE;YACzE,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE;SAC9B,CAAC,EACJ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CACzB,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,SAAiB,EAAE,IAAsB,EAAE,IAAqB;QAC1E,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,gBAAgB,kBAAkB,CAAC,SAAS,CAAC,YAAY,EACzD,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,SAAiB,EAAE,IAAqB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,QAAQ,EACR,gBAAgB,kBAAkB,CAAC,SAAS,CAAC,YAAY,EACzD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,QAAQ,EACR,gBAAgB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACxC,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;CACF"}
|