@knocklabs/node 1.19.0 → 1.21.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.
Files changed (107) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/client.d.mts +2 -3
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -3
  5. package/client.d.ts.map +1 -1
  6. package/client.js +0 -3
  7. package/client.js.map +1 -1
  8. package/client.mjs +0 -3
  9. package/client.mjs.map +1 -1
  10. package/internal/to-file.d.mts +1 -1
  11. package/internal/to-file.d.ts +1 -1
  12. package/internal/to-file.js +1 -1
  13. package/internal/to-file.mjs +1 -1
  14. package/package.json +1 -1
  15. package/resources/audiences.d.mts +2 -2
  16. package/resources/audiences.d.mts.map +1 -1
  17. package/resources/audiences.d.ts +2 -2
  18. package/resources/audiences.d.ts.map +1 -1
  19. package/resources/index.d.mts +1 -1
  20. package/resources/index.d.mts.map +1 -1
  21. package/resources/index.d.ts +1 -1
  22. package/resources/index.d.ts.map +1 -1
  23. package/resources/index.js +3 -3
  24. package/resources/index.js.map +1 -1
  25. package/resources/index.mjs +1 -1
  26. package/resources/index.mjs.map +1 -1
  27. package/resources/messages/messages.d.mts +46 -5
  28. package/resources/messages/messages.d.mts.map +1 -1
  29. package/resources/messages/messages.d.ts +46 -5
  30. package/resources/messages/messages.d.ts.map +1 -1
  31. package/resources/messages/messages.js.map +1 -1
  32. package/resources/messages/messages.mjs.map +1 -1
  33. package/resources/objects/objects.d.mts +87 -9
  34. package/resources/objects/objects.d.mts.map +1 -1
  35. package/resources/objects/objects.d.ts +87 -9
  36. package/resources/objects/objects.d.ts.map +1 -1
  37. package/resources/objects/objects.js +7 -4
  38. package/resources/objects/objects.js.map +1 -1
  39. package/resources/objects/objects.mjs +7 -4
  40. package/resources/objects/objects.mjs.map +1 -1
  41. package/resources/recipients/channel-data.d.mts +113 -25
  42. package/resources/recipients/channel-data.d.mts.map +1 -1
  43. package/resources/recipients/channel-data.d.ts +113 -25
  44. package/resources/recipients/channel-data.d.ts.map +1 -1
  45. package/resources/recipients/index.d.mts +1 -1
  46. package/resources/recipients/index.d.mts.map +1 -1
  47. package/resources/recipients/index.d.ts +1 -1
  48. package/resources/recipients/index.d.ts.map +1 -1
  49. package/resources/recipients/index.js.map +1 -1
  50. package/resources/recipients/index.mjs.map +1 -1
  51. package/resources/recipients/preferences.d.mts +120 -6
  52. package/resources/recipients/preferences.d.mts.map +1 -1
  53. package/resources/recipients/preferences.d.ts +120 -6
  54. package/resources/recipients/preferences.d.ts.map +1 -1
  55. package/resources/recipients/recipients.d.mts +2 -2
  56. package/resources/recipients/recipients.d.mts.map +1 -1
  57. package/resources/recipients/recipients.d.ts +2 -2
  58. package/resources/recipients/recipients.d.ts.map +1 -1
  59. package/resources/recipients/recipients.js.map +1 -1
  60. package/resources/recipients/recipients.mjs.map +1 -1
  61. package/resources/shared.d.mts +0 -6
  62. package/resources/shared.d.mts.map +1 -1
  63. package/resources/shared.d.ts +0 -6
  64. package/resources/shared.d.ts.map +1 -1
  65. package/resources/shared.js +0 -5
  66. package/resources/shared.js.map +1 -1
  67. package/resources/shared.mjs +1 -3
  68. package/resources/shared.mjs.map +1 -1
  69. package/resources/users/bulk.d.mts +13 -0
  70. package/resources/users/bulk.d.mts.map +1 -1
  71. package/resources/users/bulk.d.ts +13 -0
  72. package/resources/users/bulk.d.ts.map +1 -1
  73. package/resources/users/bulk.js +13 -0
  74. package/resources/users/bulk.js.map +1 -1
  75. package/resources/users/bulk.mjs +13 -0
  76. package/resources/users/bulk.mjs.map +1 -1
  77. package/resources/users/guides.d.mts +90 -21
  78. package/resources/users/guides.d.mts.map +1 -1
  79. package/resources/users/guides.d.ts +90 -21
  80. package/resources/users/guides.d.ts.map +1 -1
  81. package/resources/users/users.d.mts +93 -5
  82. package/resources/users/users.d.mts.map +1 -1
  83. package/resources/users/users.d.ts +93 -5
  84. package/resources/users/users.d.ts.map +1 -1
  85. package/resources/users/users.js +13 -0
  86. package/resources/users/users.js.map +1 -1
  87. package/resources/users/users.mjs +13 -0
  88. package/resources/users/users.mjs.map +1 -1
  89. package/src/client.ts +3 -5
  90. package/src/internal/to-file.ts +1 -1
  91. package/src/resources/audiences.ts +2 -2
  92. package/src/resources/index.ts +1 -1
  93. package/src/resources/messages/messages.ts +55 -5
  94. package/src/resources/objects/objects.ts +96 -11
  95. package/src/resources/recipients/channel-data.ts +133 -35
  96. package/src/resources/recipients/index.ts +0 -2
  97. package/src/resources/recipients/preferences.ts +130 -6
  98. package/src/resources/recipients/recipients.ts +0 -4
  99. package/src/resources/shared.ts +0 -8
  100. package/src/resources/users/bulk.ts +13 -0
  101. package/src/resources/users/guides.ts +118 -19
  102. package/src/resources/users/users.ts +102 -7
  103. package/src/version.ts +1 -1
  104. package/version.d.mts +1 -1
  105. package/version.d.ts +1 -1
  106. package/version.js +1 -1
  107. package/version.mjs +1 -1
@@ -16,23 +16,93 @@ export interface ChannelData {
16
16
  /**
17
17
  * Channel data for a given channel type.
18
18
  */
19
- data: PushChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData | OneSignalChannelData | ChannelData.AwsSnsPushChannelData;
19
+ data: ChannelData.PushChannelDataFull | ChannelData.AwssnsPushChannelDataFull | ChannelData.OneSignalChannelDataPlayerIDsOnly | SlackChannelData | MsTeamsChannelData | DiscordChannelData;
20
20
  /**
21
21
  * The type of provider.
22
22
  */
23
23
  provider?: 'push_fcm' | 'push_apns' | 'push_aws_sns' | 'push_expo' | 'push_one_signal' | 'chat_slack' | 'chat_ms_teams' | 'chat_discord' | 'http_knock_webhook';
24
24
  }
25
25
  export declare namespace ChannelData {
26
+ /**
27
+ * Push channel data.
28
+ */
29
+ interface PushChannelDataFull {
30
+ /**
31
+ * A list of devices. Each device contains a token, and optionally a locale and
32
+ * timezone.
33
+ */
34
+ devices: Array<PushChannelDataFull.Device>;
35
+ /**
36
+ * A list of push channel tokens.
37
+ */
38
+ tokens: Array<string>;
39
+ }
40
+ namespace PushChannelDataFull {
41
+ interface Device {
42
+ /**
43
+ * The device token to send the push notification to.
44
+ */
45
+ token: string;
46
+ /**
47
+ * The locale of the object. Used for
48
+ * [message localization](/concepts/translations).
49
+ */
50
+ locale?: string | null;
51
+ /**
52
+ * The timezone of the object. Must be a
53
+ * valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
54
+ * Used
55
+ * for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
56
+ */
57
+ timezone?: string | null;
58
+ }
59
+ }
26
60
  /**
27
61
  * AWS SNS push channel data.
28
62
  */
29
- interface AwsSnsPushChannelData {
63
+ interface AwssnsPushChannelDataFull {
64
+ /**
65
+ * A list of devices. Each device contains a target_arn, and optionally a locale
66
+ * and timezone.
67
+ */
68
+ devices: Array<AwssnsPushChannelDataFull.Device>;
30
69
  /**
31
70
  * A list of platform endpoint ARNs. See
32
71
  * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
33
72
  */
34
73
  target_arns: Array<string>;
35
74
  }
75
+ namespace AwssnsPushChannelDataFull {
76
+ interface Device {
77
+ /**
78
+ * The ARN of a platform endpoint associated with a platform application and a
79
+ * device token. See
80
+ * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
81
+ */
82
+ target_arn: string;
83
+ /**
84
+ * The locale of the object. Used for
85
+ * [message localization](/concepts/translations).
86
+ */
87
+ locale?: string | null;
88
+ /**
89
+ * The timezone of the object. Must be a
90
+ * valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
91
+ * Used
92
+ * for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
93
+ */
94
+ timezone?: string | null;
95
+ }
96
+ }
97
+ /**
98
+ * OneSignal channel data.
99
+ */
100
+ interface OneSignalChannelDataPlayerIDsOnly {
101
+ /**
102
+ * A list of OneSignal player IDs.
103
+ */
104
+ player_ids: Array<string>;
105
+ }
36
106
  }
37
107
  /**
38
108
  * A request to set channel data for a type of channel.
@@ -41,19 +111,37 @@ export interface ChannelDataRequest {
41
111
  /**
42
112
  * Channel data for a given channel type.
43
113
  */
44
- data: PushChannelData | OneSignalChannelData | ChannelDataRequest.AwsSnsPushChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData;
114
+ data: ChannelDataRequest.PushChannelDataTokensOnly | ChannelDataRequest.AwssnsPushChannelDataTargetArNsOnly | ChannelDataRequest.OneSignalChannelDataPlayerIDsOnly | SlackChannelData | MsTeamsChannelData | DiscordChannelData;
45
115
  }
46
116
  export declare namespace ChannelDataRequest {
117
+ /**
118
+ * Push channel data.
119
+ */
120
+ interface PushChannelDataTokensOnly {
121
+ /**
122
+ * A list of push channel tokens.
123
+ */
124
+ tokens: Array<string>;
125
+ }
47
126
  /**
48
127
  * AWS SNS push channel data.
49
128
  */
50
- interface AwsSnsPushChannelData {
129
+ interface AwssnsPushChannelDataTargetArNsOnly {
51
130
  /**
52
131
  * A list of platform endpoint ARNs. See
53
132
  * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
54
133
  */
55
134
  target_arns: Array<string>;
56
135
  }
136
+ /**
137
+ * OneSignal channel data.
138
+ */
139
+ interface OneSignalChannelDataPlayerIDsOnly {
140
+ /**
141
+ * A list of OneSignal player IDs.
142
+ */
143
+ player_ids: Array<string>;
144
+ }
57
145
  }
58
146
  /**
59
147
  * Discord channel data.
@@ -99,19 +187,37 @@ export declare namespace DiscordChannelData {
99
187
  * A request to set channel data for a type of channel inline.
100
188
  */
101
189
  export type InlineChannelDataRequest = {
102
- [key: string]: PushChannelData | OneSignalChannelData | InlineChannelDataRequest.AwsSnsPushChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData;
190
+ [key: string]: InlineChannelDataRequest.PushChannelDataTokensOnly | InlineChannelDataRequest.AwssnsPushChannelDataTargetArNsOnly | InlineChannelDataRequest.OneSignalChannelDataPlayerIDsOnly | SlackChannelData | MsTeamsChannelData | DiscordChannelData;
103
191
  };
104
192
  export declare namespace InlineChannelDataRequest {
193
+ /**
194
+ * Push channel data.
195
+ */
196
+ interface PushChannelDataTokensOnly {
197
+ /**
198
+ * A list of push channel tokens.
199
+ */
200
+ tokens: Array<string>;
201
+ }
105
202
  /**
106
203
  * AWS SNS push channel data.
107
204
  */
108
- interface AwsSnsPushChannelData {
205
+ interface AwssnsPushChannelDataTargetArNsOnly {
109
206
  /**
110
207
  * A list of platform endpoint ARNs. See
111
208
  * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
112
209
  */
113
210
  target_arns: Array<string>;
114
211
  }
212
+ /**
213
+ * OneSignal channel data.
214
+ */
215
+ interface OneSignalChannelDataPlayerIDsOnly {
216
+ /**
217
+ * A list of OneSignal player IDs.
218
+ */
219
+ player_ids: Array<string>;
220
+ }
115
221
  }
116
222
  /**
117
223
  * Microsoft Teams channel data.
@@ -169,24 +275,6 @@ export declare namespace MsTeamsChannelData {
169
275
  }
170
276
  }
171
277
  }
172
- /**
173
- * OneSignal channel data.
174
- */
175
- export interface OneSignalChannelData {
176
- /**
177
- * A list of OneSignal player IDs.
178
- */
179
- player_ids: Array<string>;
180
- }
181
- /**
182
- * Push channel data.
183
- */
184
- export interface PushChannelData {
185
- /**
186
- * A list of push channel tokens.
187
- */
188
- tokens: Array<string>;
189
- }
190
278
  /**
191
279
  * Slack channel data.
192
280
  */
@@ -238,6 +326,6 @@ export declare namespace SlackChannelData {
238
326
  }
239
327
  }
240
328
  export declare namespace ChannelData {
241
- export { type ChannelData as ChannelData, type ChannelDataRequest as ChannelDataRequest, type DiscordChannelData as DiscordChannelData, type InlineChannelDataRequest as InlineChannelDataRequest, type MsTeamsChannelData as MsTeamsChannelData, type OneSignalChannelData as OneSignalChannelData, type PushChannelData as PushChannelData, type SlackChannelData as SlackChannelData, };
329
+ export { type ChannelData as ChannelData, type ChannelDataRequest as ChannelDataRequest, type DiscordChannelData as DiscordChannelData, type InlineChannelDataRequest as InlineChannelDataRequest, type MsTeamsChannelData as MsTeamsChannelData, type SlackChannelData as SlackChannelData, };
242
330
  }
243
331
  //# sourceMappingURL=channel-data.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"channel-data.d.ts","sourceRoot":"","sources":["../../src/resources/recipients/channel-data.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EACA,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,WAAW,CAAC,qBAAqB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,WAAW,GACX,cAAc,GACd,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,eAAe,GACf,cAAc,GACd,oBAAoB,CAAC;CAC1B;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;WAGG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EACA,eAAe,GACf,oBAAoB,GACpB,kBAAkB,CAAC,qBAAqB,GACxC,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,CAAC;CACxB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;WAGG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,wBAAwB,GAAG,kBAAkB,CAAC,gCAAgC,CAClG,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,GAAG,EAAE,MAAM,GACR,eAAe,GACf,oBAAoB,GACpB,wBAAwB,CAAC,qBAAqB,GAC9C,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,CAAC;CACxB,CAAC;AAEF,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;WAGG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,gCAAgC,CAChG,CAAC;IAEF;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"channel-data.d.ts","sourceRoot":"","sources":["../../src/resources/recipients/channel-data.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EACA,WAAW,CAAC,mBAAmB,GAC/B,WAAW,CAAC,yBAAyB,GACrC,WAAW,CAAC,iCAAiC,GAC7C,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,WAAW,GACX,cAAc,GACd,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,eAAe,GACf,cAAc,GACd,oBAAoB,CAAC;CAC1B;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAE3C;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED,UAAiB,mBAAmB,CAAC;QACnC,UAAiB,MAAM;YACrB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;;;;eAKG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;;WAGG;QACH,OAAO,EAAE,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAEjD;;;WAGG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED,UAAiB,yBAAyB,CAAC;QACzC,UAAiB,MAAM;YACrB;;;;eAIG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;;;;eAKG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EACA,kBAAkB,CAAC,yBAAyB,GAC5C,kBAAkB,CAAC,mCAAmC,GACtD,kBAAkB,CAAC,iCAAiC,GACpD,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,CAAC;CACxB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,mCAAmC;QAClD;;;WAGG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,wBAAwB,GAAG,kBAAkB,CAAC,gCAAgC,CAClG,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,GAAG,EAAE,MAAM,GACR,wBAAwB,CAAC,yBAAyB,GAClD,wBAAwB,CAAC,mCAAmC,GAC5D,wBAAwB,CAAC,iCAAiC,GAC1D,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,CAAC;CACxB,CAAC;AAEF,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,mCAAmC;QAClD;;;WAGG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,gCAAgC,CAChG,CAAC;IAEF;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -1,4 +1,4 @@
1
- export { ChannelData, type ChannelDataRequest, type DiscordChannelData, type InlineChannelDataRequest, type MsTeamsChannelData, type OneSignalChannelData, type PushChannelData, type SlackChannelData, } from "./channel-data.mjs";
1
+ export { ChannelData, type ChannelDataRequest, type DiscordChannelData, type InlineChannelDataRequest, type MsTeamsChannelData, type SlackChannelData, } from "./channel-data.mjs";
2
2
  export { Preferences, type InlinePreferenceSetRequest, type PreferenceSet, type PreferenceSetChannelTypeSetting, type PreferenceSetChannelTypes, type PreferenceSetRequest, } from "./preferences.mjs";
3
3
  export { Recipients, type Recipient, type RecipientReference, type RecipientRequest } from "./recipients.mjs";
4
4
  export { Subscriptions, type Subscription, type SubscriptionsEntriesCursor } from "./subscriptions.mjs";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,0BAA0B,EAC/B,KAAK,aAAa,EAClB,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,GAC1B;OACM,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE;OAC9E,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,0BAA0B,EAAE"}
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,0BAA0B,EAC/B,KAAK,aAAa,EAClB,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,GAC1B;OACM,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE;OAC9E,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,0BAA0B,EAAE"}
@@ -1,4 +1,4 @@
1
- export { ChannelData, type ChannelDataRequest, type DiscordChannelData, type InlineChannelDataRequest, type MsTeamsChannelData, type OneSignalChannelData, type PushChannelData, type SlackChannelData, } from "./channel-data.js";
1
+ export { ChannelData, type ChannelDataRequest, type DiscordChannelData, type InlineChannelDataRequest, type MsTeamsChannelData, type SlackChannelData, } from "./channel-data.js";
2
2
  export { Preferences, type InlinePreferenceSetRequest, type PreferenceSet, type PreferenceSetChannelTypeSetting, type PreferenceSetChannelTypes, type PreferenceSetRequest, } from "./preferences.js";
3
3
  export { Recipients, type Recipient, type RecipientReference, type RecipientRequest } from "./recipients.js";
4
4
  export { Subscriptions, type Subscription, type SubscriptionsEntriesCursor } from "./subscriptions.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,0BAA0B,EAC/B,KAAK,aAAa,EAClB,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,GAC1B;OACM,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE;OAC9E,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,0BAA0B,EAAE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,0BAA0B,EAC/B,KAAK,aAAa,EAClB,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,GAC1B;OACM,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE;OAC9E,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,0BAA0B,EAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDASwB;AARtB,2GAAA,WAAW,OAAA;AASb,gDAOuB;AANrB,0GAAA,WAAW,OAAA;AAOb,8CAA0G;AAAjG,wGAAA,UAAU,OAAA;AACnB,oDAAoG;AAA3F,8GAAA,aAAa,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAOwB;AANtB,2GAAA,WAAW,OAAA;AAOb,gDAOuB;AANrB,0GAAA,WAAW,OAAA;AAOb,8CAA0G;AAAjG,wGAAA,UAAU,OAAA;AACnB,oDAAoG;AAA3F,8GAAA,aAAa,OAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,WAAW,GAQZ;OACM,EACL,WAAW,GAMZ;OACM,EAAE,UAAU,EAAkE;OAC9E,EAAE,aAAa,EAAsD"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/recipients/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,WAAW,GAMZ;OACM,EACL,WAAW,GAMZ;OACM,EAAE,UAAU,EAAkE;OAC9E,EAAE,aAAa,EAAsD"}
@@ -1,6 +1,6 @@
1
1
  import { APIResource } from "../../core/resource.mjs";
2
2
  import * as PreferencesAPI from "./preferences.mjs";
3
- import * as SharedAPI from "../shared.mjs";
3
+ import * as Shared from "../shared.mjs";
4
4
  export declare class Preferences extends APIResource {
5
5
  }
6
6
  /**
@@ -31,6 +31,17 @@ export interface PreferenceSet {
31
31
  * Channel type preferences.
32
32
  */
33
33
  channel_types?: PreferenceSetChannelTypes | null;
34
+ /**
35
+ * Channel preferences.
36
+ */
37
+ channels?: {
38
+ [key: string]: boolean | PreferenceSet.PreferenceSetChannelSetting;
39
+ } | null;
40
+ /**
41
+ * Whether the recipient is subscribed to commercial communications. When false,
42
+ * the recipient will not receive commercial workflow notifications.
43
+ */
44
+ commercial_subscribed?: boolean | null;
34
45
  /**
35
46
  * An object where the key is the workflow key and the values are the preference
36
47
  * settings for that workflow.
@@ -49,10 +60,38 @@ export declare namespace PreferenceSet {
49
60
  * Channel type preferences.
50
61
  */
51
62
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
63
+ /**
64
+ * Channel preferences.
65
+ */
66
+ channels?: {
67
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
68
+ } | null;
52
69
  /**
53
70
  * A list of conditions to apply to a channel type.
54
71
  */
55
- conditions?: Array<SharedAPI.Condition> | null;
72
+ conditions?: Array<Shared.Condition> | null;
73
+ }
74
+ namespace PreferenceSetWorkflowCategorySettingObject {
75
+ /**
76
+ * A set of settings for a specific channel. Currently, this can only be a list of
77
+ * conditions to apply.
78
+ */
79
+ interface PreferenceSetChannelSetting {
80
+ /**
81
+ * A list of conditions to apply to a specific channel.
82
+ */
83
+ conditions: Array<Shared.Condition>;
84
+ }
85
+ }
86
+ /**
87
+ * A set of settings for a specific channel. Currently, this can only be a list of
88
+ * conditions to apply.
89
+ */
90
+ interface PreferenceSetChannelSetting {
91
+ /**
92
+ * A list of conditions to apply to a specific channel.
93
+ */
94
+ conditions: Array<Shared.Condition>;
56
95
  }
57
96
  /**
58
97
  * The settings object for a workflow or category, where you can specify channel
@@ -63,10 +102,28 @@ export declare namespace PreferenceSet {
63
102
  * Channel type preferences.
64
103
  */
65
104
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
105
+ /**
106
+ * Channel preferences.
107
+ */
108
+ channels?: {
109
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
110
+ } | null;
66
111
  /**
67
112
  * A list of conditions to apply to a channel type.
68
113
  */
69
- conditions?: Array<SharedAPI.Condition> | null;
114
+ conditions?: Array<Shared.Condition> | null;
115
+ }
116
+ namespace PreferenceSetWorkflowCategorySettingObject {
117
+ /**
118
+ * A set of settings for a specific channel. Currently, this can only be a list of
119
+ * conditions to apply.
120
+ */
121
+ interface PreferenceSetChannelSetting {
122
+ /**
123
+ * A list of conditions to apply to a specific channel.
124
+ */
125
+ conditions: Array<Shared.Condition>;
126
+ }
70
127
  }
71
128
  }
72
129
  /**
@@ -77,7 +134,7 @@ export interface PreferenceSetChannelTypeSetting {
77
134
  /**
78
135
  * A list of conditions to apply to a channel type.
79
136
  */
80
- conditions: Array<SharedAPI.Condition>;
137
+ conditions: Array<Shared.Condition>;
81
138
  }
82
139
  /**
83
140
  * Channel type preferences.
@@ -128,6 +185,17 @@ export interface PreferenceSetRequest {
128
185
  * Channel type preferences.
129
186
  */
130
187
  channel_types?: PreferenceSetChannelTypes | null;
188
+ /**
189
+ * Channel preferences.
190
+ */
191
+ channels?: {
192
+ [key: string]: boolean | PreferenceSetRequest.PreferenceSetChannelSetting;
193
+ } | null;
194
+ /**
195
+ * Whether the recipient is subscribed to commercial communications. When false,
196
+ * the recipient will not receive commercial workflow notifications.
197
+ */
198
+ commercial_subscribed?: boolean | null;
131
199
  /**
132
200
  * An object where the key is the workflow key and the values are the preference
133
201
  * settings for that workflow.
@@ -146,10 +214,38 @@ export declare namespace PreferenceSetRequest {
146
214
  * Channel type preferences.
147
215
  */
148
216
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
217
+ /**
218
+ * Channel preferences.
219
+ */
220
+ channels?: {
221
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
222
+ } | null;
149
223
  /**
150
224
  * A list of conditions to apply to a channel type.
151
225
  */
152
- conditions?: Array<SharedAPI.Condition> | null;
226
+ conditions?: Array<Shared.Condition> | null;
227
+ }
228
+ namespace PreferenceSetWorkflowCategorySettingObject {
229
+ /**
230
+ * A set of settings for a specific channel. Currently, this can only be a list of
231
+ * conditions to apply.
232
+ */
233
+ interface PreferenceSetChannelSetting {
234
+ /**
235
+ * A list of conditions to apply to a specific channel.
236
+ */
237
+ conditions: Array<Shared.Condition>;
238
+ }
239
+ }
240
+ /**
241
+ * A set of settings for a specific channel. Currently, this can only be a list of
242
+ * conditions to apply.
243
+ */
244
+ interface PreferenceSetChannelSetting {
245
+ /**
246
+ * A list of conditions to apply to a specific channel.
247
+ */
248
+ conditions: Array<Shared.Condition>;
153
249
  }
154
250
  /**
155
251
  * The settings object for a workflow or category, where you can specify channel
@@ -160,10 +256,28 @@ export declare namespace PreferenceSetRequest {
160
256
  * Channel type preferences.
161
257
  */
162
258
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
259
+ /**
260
+ * Channel preferences.
261
+ */
262
+ channels?: {
263
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
264
+ } | null;
163
265
  /**
164
266
  * A list of conditions to apply to a channel type.
165
267
  */
166
- conditions?: Array<SharedAPI.Condition> | null;
268
+ conditions?: Array<Shared.Condition> | null;
269
+ }
270
+ namespace PreferenceSetWorkflowCategorySettingObject {
271
+ /**
272
+ * A set of settings for a specific channel. Currently, this can only be a list of
273
+ * conditions to apply.
274
+ */
275
+ interface PreferenceSetChannelSetting {
276
+ /**
277
+ * A list of conditions to apply to a specific channel.
278
+ */
279
+ conditions: Array<Shared.Condition>;
280
+ }
167
281
  }
168
282
  }
169
283
  export declare namespace Preferences {
@@ -1 +1 @@
1
- {"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/recipients/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,SAAS;AAErB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,CAAA;CAAE,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,CAAC,0CAA0C,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1G;;OAEG;IACH,aAAa,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,CAAC,0CAA0C,CAAA;KAAE,GAAG,IAAI,CAAC;CAC1G;AAED,yBAAiB,aAAa,CAAC;IAC7B;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;IAED;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAEjD;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAExD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAEjD;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE/C;;;OAGG;IACH,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,oBAAoB,CAAC,0CAA0C,CAAC;KAC1F,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,oBAAoB,CAAC,0CAA0C,CAAC;KAC1F,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;IAED;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/recipients/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,MAAM;AAElB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,CAAA;CAAE,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,CAAC,0CAA0C,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1G;;OAEG;IACH,aAAa,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,CAAC,2BAA2B,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzF;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,CAAC,0CAA0C,CAAA;KAAE,GAAG,IAAI,CAAC;CAC1G;AAED,yBAAiB,aAAa,CAAC;IAC7B;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,0CAA0C,CAAC,2BAA2B,CAAC;SACjG,GAAG,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAC7C;IAED,UAAiB,0CAA0C,CAAC;QAC1D;;;WAGG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SACrC;KACF;IAED;;;OAGG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACrC;IAED;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,0CAA0C,CAAC,2BAA2B,CAAC;SACjG,GAAG,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAC7C;IAED,UAAiB,0CAA0C,CAAC;QAC1D;;;WAGG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SACrC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAEjD;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAExD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IAEjD;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE/C;;;OAGG;IACH,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,oBAAoB,CAAC,0CAA0C,CAAC;KAC1F,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,oBAAoB,CAAC,2BAA2B,CAAA;KAAE,GAAG,IAAI,CAAC;IAEhG;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,oBAAoB,CAAC,0CAA0C,CAAC;KAC1F,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,0CAA0C,CAAC,2BAA2B,CAAC;SACjG,GAAG,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAC7C;IAED,UAAiB,0CAA0C,CAAC;QAC1D;;;WAGG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SACrC;KACF;IAED;;;OAGG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KACrC;IAED;;;OAGG;IACH,UAAiB,0CAA0C;QACzD;;WAEG;QACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;QAEhE;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,0CAA0C,CAAC,2BAA2B,CAAC;SACjG,GAAG,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAC7C;IAED,UAAiB,0CAA0C,CAAC;QAC1D;;;WAGG;QACH,UAAiB,2BAA2B;YAC1C;;eAEG;YACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SACrC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -1,6 +1,6 @@
1
1
  import { APIResource } from "../../core/resource.js";
2
2
  import * as PreferencesAPI from "./preferences.js";
3
- import * as SharedAPI from "../shared.js";
3
+ import * as Shared from "../shared.js";
4
4
  export declare class Preferences extends APIResource {
5
5
  }
6
6
  /**
@@ -31,6 +31,17 @@ export interface PreferenceSet {
31
31
  * Channel type preferences.
32
32
  */
33
33
  channel_types?: PreferenceSetChannelTypes | null;
34
+ /**
35
+ * Channel preferences.
36
+ */
37
+ channels?: {
38
+ [key: string]: boolean | PreferenceSet.PreferenceSetChannelSetting;
39
+ } | null;
40
+ /**
41
+ * Whether the recipient is subscribed to commercial communications. When false,
42
+ * the recipient will not receive commercial workflow notifications.
43
+ */
44
+ commercial_subscribed?: boolean | null;
34
45
  /**
35
46
  * An object where the key is the workflow key and the values are the preference
36
47
  * settings for that workflow.
@@ -49,10 +60,38 @@ export declare namespace PreferenceSet {
49
60
  * Channel type preferences.
50
61
  */
51
62
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
63
+ /**
64
+ * Channel preferences.
65
+ */
66
+ channels?: {
67
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
68
+ } | null;
52
69
  /**
53
70
  * A list of conditions to apply to a channel type.
54
71
  */
55
- conditions?: Array<SharedAPI.Condition> | null;
72
+ conditions?: Array<Shared.Condition> | null;
73
+ }
74
+ namespace PreferenceSetWorkflowCategorySettingObject {
75
+ /**
76
+ * A set of settings for a specific channel. Currently, this can only be a list of
77
+ * conditions to apply.
78
+ */
79
+ interface PreferenceSetChannelSetting {
80
+ /**
81
+ * A list of conditions to apply to a specific channel.
82
+ */
83
+ conditions: Array<Shared.Condition>;
84
+ }
85
+ }
86
+ /**
87
+ * A set of settings for a specific channel. Currently, this can only be a list of
88
+ * conditions to apply.
89
+ */
90
+ interface PreferenceSetChannelSetting {
91
+ /**
92
+ * A list of conditions to apply to a specific channel.
93
+ */
94
+ conditions: Array<Shared.Condition>;
56
95
  }
57
96
  /**
58
97
  * The settings object for a workflow or category, where you can specify channel
@@ -63,10 +102,28 @@ export declare namespace PreferenceSet {
63
102
  * Channel type preferences.
64
103
  */
65
104
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
105
+ /**
106
+ * Channel preferences.
107
+ */
108
+ channels?: {
109
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
110
+ } | null;
66
111
  /**
67
112
  * A list of conditions to apply to a channel type.
68
113
  */
69
- conditions?: Array<SharedAPI.Condition> | null;
114
+ conditions?: Array<Shared.Condition> | null;
115
+ }
116
+ namespace PreferenceSetWorkflowCategorySettingObject {
117
+ /**
118
+ * A set of settings for a specific channel. Currently, this can only be a list of
119
+ * conditions to apply.
120
+ */
121
+ interface PreferenceSetChannelSetting {
122
+ /**
123
+ * A list of conditions to apply to a specific channel.
124
+ */
125
+ conditions: Array<Shared.Condition>;
126
+ }
70
127
  }
71
128
  }
72
129
  /**
@@ -77,7 +134,7 @@ export interface PreferenceSetChannelTypeSetting {
77
134
  /**
78
135
  * A list of conditions to apply to a channel type.
79
136
  */
80
- conditions: Array<SharedAPI.Condition>;
137
+ conditions: Array<Shared.Condition>;
81
138
  }
82
139
  /**
83
140
  * Channel type preferences.
@@ -128,6 +185,17 @@ export interface PreferenceSetRequest {
128
185
  * Channel type preferences.
129
186
  */
130
187
  channel_types?: PreferenceSetChannelTypes | null;
188
+ /**
189
+ * Channel preferences.
190
+ */
191
+ channels?: {
192
+ [key: string]: boolean | PreferenceSetRequest.PreferenceSetChannelSetting;
193
+ } | null;
194
+ /**
195
+ * Whether the recipient is subscribed to commercial communications. When false,
196
+ * the recipient will not receive commercial workflow notifications.
197
+ */
198
+ commercial_subscribed?: boolean | null;
131
199
  /**
132
200
  * An object where the key is the workflow key and the values are the preference
133
201
  * settings for that workflow.
@@ -146,10 +214,38 @@ export declare namespace PreferenceSetRequest {
146
214
  * Channel type preferences.
147
215
  */
148
216
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
217
+ /**
218
+ * Channel preferences.
219
+ */
220
+ channels?: {
221
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
222
+ } | null;
149
223
  /**
150
224
  * A list of conditions to apply to a channel type.
151
225
  */
152
- conditions?: Array<SharedAPI.Condition> | null;
226
+ conditions?: Array<Shared.Condition> | null;
227
+ }
228
+ namespace PreferenceSetWorkflowCategorySettingObject {
229
+ /**
230
+ * A set of settings for a specific channel. Currently, this can only be a list of
231
+ * conditions to apply.
232
+ */
233
+ interface PreferenceSetChannelSetting {
234
+ /**
235
+ * A list of conditions to apply to a specific channel.
236
+ */
237
+ conditions: Array<Shared.Condition>;
238
+ }
239
+ }
240
+ /**
241
+ * A set of settings for a specific channel. Currently, this can only be a list of
242
+ * conditions to apply.
243
+ */
244
+ interface PreferenceSetChannelSetting {
245
+ /**
246
+ * A list of conditions to apply to a specific channel.
247
+ */
248
+ conditions: Array<Shared.Condition>;
153
249
  }
154
250
  /**
155
251
  * The settings object for a workflow or category, where you can specify channel
@@ -160,10 +256,28 @@ export declare namespace PreferenceSetRequest {
160
256
  * Channel type preferences.
161
257
  */
162
258
  channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
259
+ /**
260
+ * Channel preferences.
261
+ */
262
+ channels?: {
263
+ [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
264
+ } | null;
163
265
  /**
164
266
  * A list of conditions to apply to a channel type.
165
267
  */
166
- conditions?: Array<SharedAPI.Condition> | null;
268
+ conditions?: Array<Shared.Condition> | null;
269
+ }
270
+ namespace PreferenceSetWorkflowCategorySettingObject {
271
+ /**
272
+ * A set of settings for a specific channel. Currently, this can only be a list of
273
+ * conditions to apply.
274
+ */
275
+ interface PreferenceSetChannelSetting {
276
+ /**
277
+ * A list of conditions to apply to a specific channel.
278
+ */
279
+ conditions: Array<Shared.Condition>;
280
+ }
167
281
  }
168
282
  }
169
283
  export declare namespace Preferences {