@linqapp/sdk 0.36.1 → 0.37.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.
Files changed (16) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/package.json +1 -1
  3. package/resources/capability.d.mts +34 -3
  4. package/resources/capability.d.mts.map +1 -1
  5. package/resources/capability.d.ts +34 -3
  6. package/resources/capability.d.ts.map +1 -1
  7. package/resources/capability.js +10 -0
  8. package/resources/capability.js.map +1 -1
  9. package/resources/capability.mjs +10 -0
  10. package/resources/capability.mjs.map +1 -1
  11. package/src/resources/capability.ts +36 -3
  12. package/src/version.ts +1 -1
  13. package/version.d.mts +1 -1
  14. package/version.d.ts +1 -1
  15. package/version.js +1 -1
  16. package/version.mjs +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.37.1](https://github.com/linq-team/linq-node/compare/v0.37.0...v0.37.1) (2026-08-13)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * clarify address format requirements for messaging checks ([bda9bb0](https://github.com/linq-team/linq-node/commit/bda9bb0c0ffa6d3022dcf63f1c74566b3b26c325))
9
+
10
+ ## [0.37.0](https://github.com/linq-team/linq-node/compare/v0.36.1...v0.37.0) (2026-08-13)
11
+
12
+
13
+ ### Features
14
+
15
+ * add detailed 503 errors and response fields for capability checks ([eda6a4a](https://github.com/linq-team/linq-node/commit/eda6a4a70b0c488e0f9f802084e98c3f728e384f))
16
+
3
17
  ## [0.36.1](https://github.com/linq-team/linq-node/compare/v0.36.0...v0.36.1) (2026-08-12)
4
18
 
5
19
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@linqapp/sdk",
3
- "version": "0.36.1",
3
+ "version": "0.37.1",
4
4
  "description": "The official TypeScript library for the Linq API V3 API",
5
5
  "author": "Linq API V3 <support@linq.com>",
6
6
  "types": "./index.d.ts",
package/resources/capability.d.mts CHANGED
@@ -21,6 +21,16 @@ export declare class Capability extends APIResource {
21
21
  /**
22
22
  * Check whether a recipient address (phone number) supports RCS messaging.
23
23
  *
24
+ * `address` must be an E.164 phone number. RCS has no email addressing, so an
25
+ * email is rejected with a `400` rather than attempted.
26
+ *
27
+ * A `200` means the check ran and the answer is about the **recipient**. A `503`
28
+ * means the check could not produce an answer because of a fault on the **sender**
29
+ * line — `4004` (RCS not turned on for the line), `4009` (line has no RCS
30
+ * account), or `4010` (the check could not run). Treat all three as "unknown",
31
+ * never as "the recipient does not support RCS", and do not cache them as a
32
+ * negative result.
33
+ *
24
34
  * @example
25
35
  * ```ts
26
36
  * const handleCheckResponse =
@@ -33,7 +43,9 @@ export declare class Capability extends APIResource {
33
43
  }
34
44
  export interface HandleCheck {
35
45
  /**
36
- * The recipient phone number or email address to check
46
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
47
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
48
+ * an email with a `400`, since RCS has no email addressing.
37
49
  */
38
50
  address: string;
39
51
  /**
@@ -51,10 +63,27 @@ export interface HandleCheckResponse {
51
63
  * Whether the recipient supports the checked messaging service
52
64
  */
53
65
  available: boolean;
66
+ /**
67
+ * Why `available` is `false`. Only present on a negative result.
68
+ *
69
+ * `not_supported` is the only value returned with a `200`, and it means the check
70
+ * completed and the recipient is genuinely not reachable over this service. On
71
+ * `check_rcs`, sender-side faults do not return `200` — they return `503` with a
72
+ * specific error code. `check_imessage` does not use this mapping.
73
+ */
74
+ reason?: 'not_supported';
75
+ /**
76
+ * The service that would actually carry a message to this address right now, which
77
+ * is not always the service you checked — a recipient without RCS resolves to
78
+ * `SMS`. Absent when the check could not determine one.
79
+ */
80
+ selected_service?: string;
54
81
  }
55
82
  export interface CapabilityCheckIMessageParams {
56
83
  /**
57
- * The recipient phone number or email address to check
84
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
85
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
86
+ * an email with a `400`, since RCS has no email addressing.
58
87
  */
59
88
  address: string;
60
89
  /**
@@ -65,7 +94,9 @@ export interface CapabilityCheckIMessageParams {
65
94
  }
66
95
  export interface CapabilityCheckRCSParams {
67
96
  /**
68
- * The recipient phone number or email address to check
97
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
98
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
99
+ * an email with a `400`, since RCS has no email addressing.
69
100
  */
70
101
  address: string;
71
102
  /**
package/resources/capability.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"capability.d.mts","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGpG;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"capability.d.mts","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGpG;AAED,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IAEzB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
package/resources/capability.d.ts CHANGED
@@ -21,6 +21,16 @@ export declare class Capability extends APIResource {
21
21
  /**
22
22
  * Check whether a recipient address (phone number) supports RCS messaging.
23
23
  *
24
+ * `address` must be an E.164 phone number. RCS has no email addressing, so an
25
+ * email is rejected with a `400` rather than attempted.
26
+ *
27
+ * A `200` means the check ran and the answer is about the **recipient**. A `503`
28
+ * means the check could not produce an answer because of a fault on the **sender**
29
+ * line — `4004` (RCS not turned on for the line), `4009` (line has no RCS
30
+ * account), or `4010` (the check could not run). Treat all three as "unknown",
31
+ * never as "the recipient does not support RCS", and do not cache them as a
32
+ * negative result.
33
+ *
24
34
  * @example
25
35
  * ```ts
26
36
  * const handleCheckResponse =
@@ -33,7 +43,9 @@ export declare class Capability extends APIResource {
33
43
  }
34
44
  export interface HandleCheck {
35
45
  /**
36
- * The recipient phone number or email address to check
46
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
47
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
48
+ * an email with a `400`, since RCS has no email addressing.
37
49
  */
38
50
  address: string;
39
51
  /**
@@ -51,10 +63,27 @@ export interface HandleCheckResponse {
51
63
  * Whether the recipient supports the checked messaging service
52
64
  */
53
65
  available: boolean;
66
+ /**
67
+ * Why `available` is `false`. Only present on a negative result.
68
+ *
69
+ * `not_supported` is the only value returned with a `200`, and it means the check
70
+ * completed and the recipient is genuinely not reachable over this service. On
71
+ * `check_rcs`, sender-side faults do not return `200` — they return `503` with a
72
+ * specific error code. `check_imessage` does not use this mapping.
73
+ */
74
+ reason?: 'not_supported';
75
+ /**
76
+ * The service that would actually carry a message to this address right now, which
77
+ * is not always the service you checked — a recipient without RCS resolves to
78
+ * `SMS`. Absent when the check could not determine one.
79
+ */
80
+ selected_service?: string;
54
81
  }
55
82
  export interface CapabilityCheckIMessageParams {
56
83
  /**
57
- * The recipient phone number or email address to check
84
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
85
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
86
+ * an email with a `400`, since RCS has no email addressing.
58
87
  */
59
88
  address: string;
60
89
  /**
@@ -65,7 +94,9 @@ export interface CapabilityCheckIMessageParams {
65
94
  }
66
95
  export interface CapabilityCheckRCSParams {
67
96
  /**
68
- * The recipient phone number or email address to check
97
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
98
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
99
+ * an email with a `400`, since RCS has no email addressing.
69
100
  */
70
101
  address: string;
71
102
  /**
package/resources/capability.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"capability.d.ts","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGpG;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"capability.d.ts","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGpG;AAED,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IAEzB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
package/resources/capability.js CHANGED
@@ -25,6 +25,16 @@ class Capability extends resource_1.APIResource {
25
25
  /**
26
26
  * Check whether a recipient address (phone number) supports RCS messaging.
27
27
  *
28
+ * `address` must be an E.164 phone number. RCS has no email addressing, so an
29
+ * email is rejected with a `400` rather than attempted.
30
+ *
31
+ * A `200` means the check ran and the answer is about the **recipient**. A `503`
32
+ * means the check could not produce an answer because of a fault on the **sender**
33
+ * line — `4004` (RCS not turned on for the line), `4009` (line has no RCS
34
+ * account), or `4010` (the check could not run). Treat all three as "unknown",
35
+ * never as "the recipient does not support RCS", and do not cache them as a
36
+ * negative result.
37
+ *
28
38
  * @example
29
39
  * ```ts
30
40
  * const handleCheckResponse =
package/resources/capability.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"capability.js","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAA8B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AAlCD,gCAkCC"}
1
+ {"version":3,"file":"capability.js","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,IAA8B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AA5CD,gCA4CC"}
package/resources/capability.mjs CHANGED
@@ -22,6 +22,16 @@ export class Capability extends APIResource {
22
22
  /**
23
23
  * Check whether a recipient address (phone number) supports RCS messaging.
24
24
  *
25
+ * `address` must be an E.164 phone number. RCS has no email addressing, so an
26
+ * email is rejected with a `400` rather than attempted.
27
+ *
28
+ * A `200` means the check ran and the answer is about the **recipient**. A `503`
29
+ * means the check could not produce an answer because of a fault on the **sender**
30
+ * line — `4004` (RCS not turned on for the line), `4009` (line has no RCS
31
+ * account), or `4010` (the check could not run). Treat all three as "unknown",
32
+ * never as "the recipient does not support RCS", and do not cache them as a
33
+ * negative result.
34
+ *
25
35
  * @example
26
36
  * ```ts
27
37
  * const handleCheckResponse =
package/resources/capability.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"capability.mjs","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAA8B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
1
+ {"version":3,"file":"capability.mjs","sourceRoot":"","sources":["../src/resources/capability.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,IAA8B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
package/src/resources/capability.ts CHANGED
@@ -30,6 +30,16 @@ export class Capability extends APIResource {
30
30
  /**
31
31
  * Check whether a recipient address (phone number) supports RCS messaging.
32
32
  *
33
+ * `address` must be an E.164 phone number. RCS has no email addressing, so an
34
+ * email is rejected with a `400` rather than attempted.
35
+ *
36
+ * A `200` means the check ran and the answer is about the **recipient**. A `503`
37
+ * means the check could not produce an answer because of a fault on the **sender**
38
+ * line — `4004` (RCS not turned on for the line), `4009` (line has no RCS
39
+ * account), or `4010` (the check could not run). Treat all three as "unknown",
40
+ * never as "the recipient does not support RCS", and do not cache them as a
41
+ * negative result.
42
+ *
33
43
  * @example
34
44
  * ```ts
35
45
  * const handleCheckResponse =
@@ -45,7 +55,9 @@ export class Capability extends APIResource {
45
55
 
46
56
  export interface HandleCheck {
47
57
  /**
48
- * The recipient phone number or email address to check
58
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
59
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
60
+ * an email with a `400`, since RCS has no email addressing.
49
61
  */
50
62
  address: string;
51
63
 
@@ -66,11 +78,30 @@ export interface HandleCheckResponse {
66
78
  * Whether the recipient supports the checked messaging service
67
79
  */
68
80
  available: boolean;
81
+
82
+ /**
83
+ * Why `available` is `false`. Only present on a negative result.
84
+ *
85
+ * `not_supported` is the only value returned with a `200`, and it means the check
86
+ * completed and the recipient is genuinely not reachable over this service. On
87
+ * `check_rcs`, sender-side faults do not return `200` — they return `503` with a
88
+ * specific error code. `check_imessage` does not use this mapping.
89
+ */
90
+ reason?: 'not_supported';
91
+
92
+ /**
93
+ * The service that would actually carry a message to this address right now, which
94
+ * is not always the service you checked — a recipient without RCS resolves to
95
+ * `SMS`. Absent when the check could not determine one.
96
+ */
97
+ selected_service?: string;
69
98
  }
70
99
 
71
100
  export interface CapabilityCheckIMessageParams {
72
101
  /**
73
- * The recipient phone number or email address to check
102
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
103
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
104
+ * an email with a `400`, since RCS has no email addressing.
74
105
  */
75
106
  address: string;
76
107
 
@@ -83,7 +114,9 @@ export interface CapabilityCheckIMessageParams {
83
114
 
84
115
  export interface CapabilityCheckRCSParams {
85
116
  /**
86
- * The recipient phone number or email address to check
117
+ * The recipient address to check. `check_imessage` accepts an E.164 phone number
118
+ * or an email address; `check_rcs` accepts an E.164 phone number only and rejects
119
+ * an email with a `400`, since RCS has no email addressing.
87
120
  */
88
121
  address: string;
89
122
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.36.1'; // x-release-please-version
1
+ export const VERSION = '0.37.1'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.36.1";
1
+ export declare const VERSION = "0.37.1";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.36.1";
1
+ export declare const VERSION = "0.37.1";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.36.1'; // x-release-please-version
4
+ exports.VERSION = '0.37.1'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.36.1'; // x-release-please-version
1
+ export const VERSION = '0.37.1'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map