@linqapp/sdk 0.81.0 → 0.82.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 (44) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/client.d.mts +3 -8
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +3 -8
  5. package/client.d.ts.map +1 -1
  6. package/client.js +3 -8
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -8
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/messages/messages.d.mts +20 -11
  12. package/resources/messages/messages.d.mts.map +1 -1
  13. package/resources/messages/messages.d.ts +20 -11
  14. package/resources/messages/messages.d.ts.map +1 -1
  15. package/resources/messages/messages.js +5 -1
  16. package/resources/messages/messages.js.map +1 -1
  17. package/resources/messages/messages.mjs +5 -1
  18. package/resources/messages/messages.mjs.map +1 -1
  19. package/resources/shared.d.mts +13 -11
  20. package/resources/shared.d.mts.map +1 -1
  21. package/resources/shared.d.ts +13 -11
  22. package/resources/shared.d.ts.map +1 -1
  23. package/resources/sip-profiles.d.mts +9 -24
  24. package/resources/sip-profiles.d.mts.map +1 -1
  25. package/resources/sip-profiles.d.ts +9 -24
  26. package/resources/sip-profiles.d.ts.map +1 -1
  27. package/resources/sip-profiles.js +9 -24
  28. package/resources/sip-profiles.js.map +1 -1
  29. package/resources/sip-profiles.mjs +9 -24
  30. package/resources/sip-profiles.mjs.map +1 -1
  31. package/resources/webhooks.d.mts +10 -8
  32. package/resources/webhooks.d.mts.map +1 -1
  33. package/resources/webhooks.d.ts +10 -8
  34. package/resources/webhooks.d.ts.map +1 -1
  35. package/src/client.ts +3 -8
  36. package/src/resources/messages/messages.ts +20 -11
  37. package/src/resources/shared.ts +13 -11
  38. package/src/resources/sip-profiles.ts +9 -24
  39. package/src/resources/webhooks.ts +10 -8
  40. package/src/version.ts +1 -1
  41. package/version.d.mts +1 -1
  42. package/version.d.ts +1 -1
  43. package/version.js +1 -1
  44. package/version.mjs +1 -1
package/src/client.ts CHANGED
@@ -1653,13 +1653,8 @@ export class LinqAPIV3 {
1653
1653
  /**
1654
1654
  * ## SIP configuration
1655
1655
  *
1656
- * Add these IP ranges to your SIP endpoint's allowlist:
1657
- *
1658
- * ```
1659
- * 54.172.60.0/30
1660
- * 54.244.51.0/30
1661
- * 168.86.128.0/18
1662
- * ```
1656
+ * Your Linq representative provides the signaling and media IP ranges and
1657
+ * ports to allow through your firewall during onboarding.
1663
1658
  *
1664
1659
  * Set `primary_uri` to your endpoint as scheme + host — `sips:` for TLS or
1665
1660
  * `sip:` for UDP, with no user part (we add it). Each call arrives at your
@@ -1670,7 +1665,7 @@ export class LinqAPIV3 {
1670
1665
  * ```
1671
1666
  *
1672
1667
  * so you can route on the dialed number. The caller's number is in the
1673
- * `From` header in E.164. Media (RTP) uses UDP ports 10000–60000.
1668
+ * `From` header in E.164.
1674
1669
  *
1675
1670
  */
1676
1671
  sipProfiles: API.SipProfiles = new API.SipProfiles(this);
@@ -238,7 +238,8 @@ export class Messages extends APIResource {
238
238
  * - laugh 😂
239
239
  * - emphasize ‼️
240
240
  * - question ❓
241
- * - custom - any emoji as a tapback (use `custom_emoji` field to specify)
241
+ * - custom - any emoji or image as a tapback (use `custom_emoji` for an emoji, or
242
+ * `url` / `attachment_id` for an image)
242
243
  * - sticker - an emoji or image peeled onto the message (use `emoji`, `url` or
243
244
  * `attachment_id`)
244
245
  *
@@ -247,6 +248,9 @@ export class Messages extends APIResource {
247
248
  * `sticker` is peeled onto the bubble itself, and can be dragged, resized and
248
249
  * rotated. Both accept an emoji; they do not look alike.
249
250
  *
251
+ * **Image tapbacks** are iMessage-only. Remove one with `operation: "remove"` and
252
+ * `type: "custom"`; no image is needed.
253
+ *
250
254
  * **Stickers** are iMessage-only and cannot be removed, so `operation: "remove"`
251
255
  * with `type: "sticker"` is rejected. Position, size and rotation are optional via
252
256
  * `placement`, and can be changed afterwards with
@@ -932,15 +936,17 @@ export interface MessageAddReactionParams {
932
936
 
933
937
  /**
934
938
  * Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh,
935
- * emphasize, question. Custom emoji reactions have type "custom" with the actual
936
- * emoji in the custom_emoji field. Sticker reactions have type "sticker" with
937
- * sticker attachment details in the sticker field.
939
+ * emphasize, question. Custom tapbacks have type "custom": an emoji tapback
940
+ * carries the emoji in the custom_emoji field, and an image tapback carries the
941
+ * image in the sticker field. Sticker reactions have type "sticker" with sticker
942
+ * attachment details in the sticker field.
938
943
  */
939
944
  type: Shared.ReactionType;
940
945
 
941
946
  /**
942
- * Reference to a sticker image pre-uploaded via `POST /v3/attachments`. Only valid
943
- * when type is "sticker".
947
+ * Reference to an image pre-uploaded via `POST /v3/attachments`. Valid when type
948
+ * is "sticker", or when adding a type "custom" reaction to make it an image
949
+ * tapback.
944
950
  *
945
951
  * Exactly one of `emoji`, `url` or `attachment_id` is required when type is
946
952
  * "sticker".
@@ -948,7 +954,9 @@ export interface MessageAddReactionParams {
948
954
  attachment_id?: string;
949
955
 
950
956
  /**
951
- * Custom emoji string. Required when type is "custom".
957
+ * Custom emoji string. When adding a type "custom" reaction, provide exactly one
958
+ * of `custom_emoji`, `url` or `attachment_id`. To remove an emoji reaction, pass
959
+ * the same `custom_emoji`.
952
960
  *
953
961
  * This is a **tapback** — the emoji sits in the tapback bubble on the corner of
954
962
  * the message. To peel an emoji onto the message as a draggable sticker instead,
@@ -983,11 +991,12 @@ export interface MessageAddReactionParams {
983
991
  placement?: MessageAddReactionParams.Placement;
984
992
 
985
993
  /**
986
- * Linq attachment URL of the sticker image — the `download_url` returned by
987
- * `POST /v3/attachments`. Only valid when type is "sticker".
994
+ * Linq attachment URL of the image — the `download_url` returned by
995
+ * `POST /v3/attachments`. Valid when type is "sticker", or when adding a type
996
+ * "custom" reaction to make it an image tapback.
988
997
  *
989
- * The image must already be stored with us. To send a sticker from elsewhere,
990
- * upload it with `POST /v3/attachments` first and pass `attachment_id`.
998
+ * The image must already be stored with us. To use an image from elsewhere, upload
999
+ * it with `POST /v3/attachments` first and pass `attachment_id`.
991
1000
  *
992
1001
  * Exactly one of `emoji`, `url` or `attachment_id` is required when type is
993
1002
  * "sticker".
@@ -153,9 +153,10 @@ export interface Reaction {
153
153
 
154
154
  /**
155
155
  * Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh,
156
- * emphasize, question. Custom emoji reactions have type "custom" with the actual
157
- * emoji in the custom_emoji field. Sticker reactions have type "sticker" with
158
- * sticker attachment details in the sticker field.
156
+ * emphasize, question. Custom tapbacks have type "custom": an emoji tapback
157
+ * carries the emoji in the custom_emoji field, and an image tapback carries the
158
+ * image in the sticker field. Sticker reactions have type "sticker" with sticker
159
+ * attachment details in the sticker field.
159
160
  */
160
161
  type: ReactionType;
161
162
 
@@ -172,21 +173,21 @@ export interface Reaction {
172
173
  id?: string;
173
174
 
174
175
  /**
175
- * Custom emoji if type is "custom", null otherwise
176
+ * Custom emoji if type is "custom" and the tapback is an emoji, null otherwise
176
177
  */
177
178
  custom_emoji?: string | null;
178
179
 
179
180
  /**
180
- * Sticker attachment details when reaction_type is "sticker". Null for non-sticker
181
- * reactions.
181
+ * The image when type is "sticker", or when type is "custom" and the tapback is an
182
+ * image. Null otherwise.
182
183
  */
183
184
  sticker?: Reaction.Sticker | null;
184
185
  }
185
186
 
186
187
  export namespace Reaction {
187
188
  /**
188
- * Sticker attachment details when reaction_type is "sticker". Null for non-sticker
189
- * reactions.
189
+ * The image when type is "sticker", or when type is "custom" and the tapback is an
190
+ * image. Null otherwise.
190
191
  */
191
192
  export interface Sticker {
192
193
  /**
@@ -218,9 +219,10 @@ export namespace Reaction {
218
219
 
219
220
  /**
220
221
  * Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh,
221
- * emphasize, question. Custom emoji reactions have type "custom" with the actual
222
- * emoji in the custom_emoji field. Sticker reactions have type "sticker" with
223
- * sticker attachment details in the sticker field.
222
+ * emphasize, question. Custom tapbacks have type "custom": an emoji tapback
223
+ * carries the emoji in the custom_emoji field, and an image tapback carries the
224
+ * image in the sticker field. Sticker reactions have type "sticker" with sticker
225
+ * attachment details in the sticker field.
224
226
  */
225
227
  export type ReactionType =
226
228
  | 'love'
@@ -9,13 +9,8 @@ import { path } from '../internal/utils/path';
9
9
  /**
10
10
  * ## SIP configuration
11
11
  *
12
- * Add these IP ranges to your SIP endpoint's allowlist:
13
- *
14
- * ```
15
- * 54.172.60.0/30
16
- * 54.244.51.0/30
17
- * 168.86.128.0/18
18
- * ```
12
+ * Your Linq representative provides the signaling and media IP ranges and
13
+ * ports to allow through your firewall during onboarding.
19
14
  *
20
15
  * Set `primary_uri` to your endpoint as scheme + host — `sips:` for TLS or
21
16
  * `sip:` for UDP, with no user part (we add it). Each call arrives at your
@@ -26,19 +21,14 @@ import { path } from '../internal/utils/path';
26
21
  * ```
27
22
  *
28
23
  * so you can route on the dialed number. The caller's number is in the
29
- * `From` header in E.164. Media (RTP) uses UDP ports 10000–60000.
24
+ * `From` header in E.164.
30
25
  */
31
26
  export class SipProfiles extends APIResource {
32
27
  /**
33
28
  * ## SIP configuration
34
29
  *
35
- * Add these IP ranges to your SIP endpoint's allowlist:
36
- *
37
- * ```
38
- * 54.172.60.0/30
39
- * 54.244.51.0/30
40
- * 168.86.128.0/18
41
- * ```
30
+ * Your Linq representative provides the signaling and media IP ranges and ports to
31
+ * allow through your firewall during onboarding.
42
32
  *
43
33
  * Set `primary_uri` to your endpoint as scheme + host — `sips:` for TLS or `sip:`
44
34
  * for UDP, with no user part (we add it). Each call arrives at your endpoint as:
@@ -48,7 +38,7 @@ export class SipProfiles extends APIResource {
48
38
  * ```
49
39
  *
50
40
  * so you can route on the dialed number. The caller's number is in the `From`
51
- * header in E.164. Media (RTP) uses UDP ports 10000–60000.
41
+ * header in E.164.
52
42
  *
53
43
  * ---
54
44
  *
@@ -134,13 +124,8 @@ export class SipProfiles extends APIResource {
134
124
  /**
135
125
  * ## SIP configuration
136
126
  *
137
- * Add these IP ranges to your SIP endpoint's allowlist:
138
- *
139
- * ```
140
- * 54.172.60.0/30
141
- * 54.244.51.0/30
142
- * 168.86.128.0/18
143
- * ```
127
+ * Your Linq representative provides the signaling and media IP ranges and ports to
128
+ * allow through your firewall during onboarding.
144
129
  *
145
130
  * Set `primary_uri` to your endpoint as scheme + host — `sips:` for TLS or `sip:`
146
131
  * for UDP, with no user part (we add it). Each call arrives at your endpoint as:
@@ -150,7 +135,7 @@ export class SipProfiles extends APIResource {
150
135
  * ```
151
136
  *
152
137
  * so you can route on the dialed number. The caller's number is in the `From`
153
- * header in E.164. Media (RTP) uses UDP ports 10000–60000.
138
+ * header in E.164.
154
139
  *
155
140
  * ---
156
141
  *
@@ -649,9 +649,10 @@ export interface ReactionEventBase {
649
649
 
650
650
  /**
651
651
  * Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh,
652
- * emphasize, question. Custom emoji reactions have type "custom" with the actual
653
- * emoji in the custom_emoji field. Sticker reactions have type "sticker" with
654
- * sticker attachment details in the sticker field.
652
+ * emphasize, question. Custom tapbacks have type "custom": an emoji tapback
653
+ * carries the emoji in the custom_emoji field, and an image tapback carries the
654
+ * image in the sticker field. Sticker reactions have type "sticker" with sticker
655
+ * attachment details in the sticker field.
655
656
  */
656
657
  reaction_type: Shared.ReactionType;
657
658
 
@@ -661,7 +662,8 @@ export interface ReactionEventBase {
661
662
  chat_id?: string;
662
663
 
663
664
  /**
664
- * The actual emoji when reaction_type is "custom". Null for standard tapbacks.
665
+ * The actual emoji when reaction_type is "custom" and the tapback is an emoji.
666
+ * Null otherwise.
665
667
  */
666
668
  custom_emoji?: string | null;
667
669
 
@@ -709,16 +711,16 @@ export interface ReactionEventBase {
709
711
  service?: Shared.ServiceType;
710
712
 
711
713
  /**
712
- * Sticker attachment details when reaction_type is "sticker". Null for non-sticker
713
- * reactions.
714
+ * The image when reaction_type is "sticker", or when reaction_type is "custom" and
715
+ * the tapback is an image. Null otherwise.
714
716
  */
715
717
  sticker?: ReactionEventBase.Sticker | null;
716
718
  }
717
719
 
718
720
  export namespace ReactionEventBase {
719
721
  /**
720
- * Sticker attachment details when reaction_type is "sticker". Null for non-sticker
721
- * reactions.
722
+ * The image when reaction_type is "sticker", or when reaction_type is "custom" and
723
+ * the tapback is an image. Null otherwise.
722
724
  */
723
725
  export interface Sticker {
724
726
  /**
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.81.0'; // x-release-please-version
1
+ export const VERSION = '0.82.1'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.81.0";
1
+ export declare const VERSION = "0.82.1";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.81.0";
1
+ export declare const VERSION = "0.82.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.81.0'; // x-release-please-version
4
+ exports.VERSION = '0.82.1'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.81.0'; // x-release-please-version
1
+ export const VERSION = '0.82.1'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map