@knocklabs/node 1.32.0 → 1.33.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 (307) hide show
  1. package/CHANGELOG.md +67 -0
  2. package/api-promise.d.mts +1 -0
  3. package/api-promise.d.mts.map +1 -1
  4. package/api-promise.d.ts +1 -0
  5. package/api-promise.d.ts.map +1 -1
  6. package/api-promise.mjs +1 -0
  7. package/api-promise.mjs.map +1 -1
  8. package/client.d.mts.map +1 -1
  9. package/client.d.ts.map +1 -1
  10. package/client.js +20 -1
  11. package/client.js.map +1 -1
  12. package/client.mjs +20 -1
  13. package/client.mjs.map +1 -1
  14. package/core/api-promise.d.mts.map +1 -1
  15. package/core/api-promise.d.ts.map +1 -1
  16. package/core/api-promise.mjs.map +1 -1
  17. package/core/error.mjs.map +1 -1
  18. package/core/pagination.d.mts.map +1 -1
  19. package/core/pagination.d.ts.map +1 -1
  20. package/core/pagination.mjs.map +1 -1
  21. package/core/resource.d.mts.map +1 -1
  22. package/core/resource.d.ts.map +1 -1
  23. package/core/uploads.d.mts.map +1 -1
  24. package/core/uploads.d.ts.map +1 -1
  25. package/core/uploads.mjs.map +1 -1
  26. package/error.d.mts +1 -0
  27. package/error.d.mts.map +1 -1
  28. package/error.d.ts +1 -0
  29. package/error.d.ts.map +1 -1
  30. package/error.mjs +1 -0
  31. package/error.mjs.map +1 -1
  32. package/index.d.mts.map +1 -1
  33. package/index.d.ts.map +1 -1
  34. package/index.mjs +1 -0
  35. package/index.mjs.map +1 -1
  36. package/internal/detect-platform.mjs.map +1 -1
  37. package/internal/headers.mjs.map +1 -1
  38. package/internal/parse.d.mts.map +1 -1
  39. package/internal/parse.d.ts.map +1 -1
  40. package/internal/parse.mjs.map +1 -1
  41. package/internal/qs/formats.d.mts.map +1 -1
  42. package/internal/qs/formats.d.ts.map +1 -1
  43. package/internal/qs/index.d.mts +2 -2
  44. package/internal/qs/index.d.mts.map +1 -1
  45. package/internal/qs/index.d.ts +2 -2
  46. package/internal/qs/index.d.ts.map +1 -1
  47. package/internal/qs/index.mjs.map +1 -1
  48. package/internal/qs/stringify.d.mts.map +1 -1
  49. package/internal/qs/stringify.d.ts.map +1 -1
  50. package/internal/qs/stringify.mjs.map +1 -1
  51. package/internal/qs/utils.d.mts.map +1 -1
  52. package/internal/qs/utils.d.ts.map +1 -1
  53. package/internal/qs/utils.mjs.map +1 -1
  54. package/internal/request-options.d.mts.map +1 -1
  55. package/internal/request-options.d.ts.map +1 -1
  56. package/internal/shims.d.mts +6 -0
  57. package/internal/shims.d.mts.map +1 -1
  58. package/internal/shims.d.ts +6 -0
  59. package/internal/shims.d.ts.map +1 -1
  60. package/internal/to-file.d.mts.map +1 -1
  61. package/internal/to-file.d.ts.map +1 -1
  62. package/internal/to-file.mjs.map +1 -1
  63. package/internal/types.d.mts +10 -10
  64. package/internal/types.d.mts.map +1 -1
  65. package/internal/types.d.ts +10 -10
  66. package/internal/types.d.ts.map +1 -1
  67. package/internal/uploads.d.mts.map +1 -1
  68. package/internal/uploads.d.ts.map +1 -1
  69. package/internal/uploads.mjs.map +1 -1
  70. package/internal/utils/base64.mjs.map +1 -1
  71. package/internal/utils/log.d.mts.map +1 -1
  72. package/internal/utils/log.d.ts.map +1 -1
  73. package/internal/utils/log.js +2 -0
  74. package/internal/utils/log.js.map +1 -1
  75. package/internal/utils/log.mjs +2 -0
  76. package/internal/utils/log.mjs.map +1 -1
  77. package/internal/utils/path.mjs.map +1 -1
  78. package/internal/utils/query.d.mts +1 -6
  79. package/internal/utils/query.d.mts.map +1 -1
  80. package/internal/utils/query.d.ts +1 -6
  81. package/internal/utils/query.d.ts.map +1 -1
  82. package/internal/utils/query.js +7 -28
  83. package/internal/utils/query.js.map +1 -1
  84. package/internal/utils/query.mjs +5 -26
  85. package/internal/utils/query.mjs.map +1 -1
  86. package/internal/utils/values.mjs.map +1 -1
  87. package/internal/utils.d.mts.map +1 -1
  88. package/internal/utils.d.ts.map +1 -1
  89. package/internal/utils.mjs.map +1 -1
  90. package/lib/index.d.mts.map +1 -1
  91. package/lib/index.d.ts.map +1 -1
  92. package/lib/index.mjs.map +1 -1
  93. package/lib/stringifyQuery.d.mts +19 -0
  94. package/lib/stringifyQuery.d.mts.map +1 -0
  95. package/lib/stringifyQuery.d.ts +19 -0
  96. package/lib/stringifyQuery.d.ts.map +1 -0
  97. package/lib/stringifyQuery.js +43 -0
  98. package/lib/stringifyQuery.js.map +1 -0
  99. package/lib/stringifyQuery.mjs +39 -0
  100. package/lib/stringifyQuery.mjs.map +1 -0
  101. package/lib/tokenSigner.d.mts.map +1 -1
  102. package/lib/tokenSigner.d.ts.map +1 -1
  103. package/lib/tokenSigner.mjs.map +1 -1
  104. package/package.json +1 -1
  105. package/pagination.d.mts +1 -0
  106. package/pagination.d.mts.map +1 -1
  107. package/pagination.d.ts +1 -0
  108. package/pagination.d.ts.map +1 -1
  109. package/pagination.mjs +1 -0
  110. package/pagination.mjs.map +1 -1
  111. package/resource.d.mts +1 -0
  112. package/resource.d.mts.map +1 -1
  113. package/resource.d.ts +1 -0
  114. package/resource.d.ts.map +1 -1
  115. package/resource.mjs +1 -0
  116. package/resource.mjs.map +1 -1
  117. package/resources/audiences.d.mts.map +1 -1
  118. package/resources/audiences.d.ts.map +1 -1
  119. package/resources/audiences.mjs.map +1 -1
  120. package/resources/bulk-operations.d.mts.map +1 -1
  121. package/resources/bulk-operations.d.ts.map +1 -1
  122. package/resources/bulk-operations.mjs.map +1 -1
  123. package/resources/channels/bulk.d.mts.map +1 -1
  124. package/resources/channels/bulk.d.ts.map +1 -1
  125. package/resources/channels/bulk.mjs.map +1 -1
  126. package/resources/channels/channels.d.mts.map +1 -1
  127. package/resources/channels/channels.d.ts.map +1 -1
  128. package/resources/channels/channels.mjs.map +1 -1
  129. package/resources/channels/index.d.mts.map +1 -1
  130. package/resources/channels/index.d.ts.map +1 -1
  131. package/resources/channels/index.mjs.map +1 -1
  132. package/resources/channels.d.mts.map +1 -1
  133. package/resources/channels.d.ts.map +1 -1
  134. package/resources/channels.mjs.map +1 -1
  135. package/resources/index.d.mts.map +1 -1
  136. package/resources/index.d.ts.map +1 -1
  137. package/resources/index.mjs.map +1 -1
  138. package/resources/integrations/census.d.mts.map +1 -1
  139. package/resources/integrations/census.d.ts.map +1 -1
  140. package/resources/integrations/census.mjs.map +1 -1
  141. package/resources/integrations/hightouch.d.mts.map +1 -1
  142. package/resources/integrations/hightouch.d.ts.map +1 -1
  143. package/resources/integrations/hightouch.mjs.map +1 -1
  144. package/resources/integrations/index.d.mts.map +1 -1
  145. package/resources/integrations/index.d.ts.map +1 -1
  146. package/resources/integrations/index.mjs.map +1 -1
  147. package/resources/integrations/integrations.d.mts.map +1 -1
  148. package/resources/integrations/integrations.d.ts.map +1 -1
  149. package/resources/integrations/integrations.mjs.map +1 -1
  150. package/resources/integrations.d.mts.map +1 -1
  151. package/resources/integrations.d.ts.map +1 -1
  152. package/resources/integrations.mjs.map +1 -1
  153. package/resources/messages/batch.d.mts.map +1 -1
  154. package/resources/messages/batch.d.ts.map +1 -1
  155. package/resources/messages/batch.mjs.map +1 -1
  156. package/resources/messages/index.d.mts.map +1 -1
  157. package/resources/messages/index.d.ts.map +1 -1
  158. package/resources/messages/index.mjs.map +1 -1
  159. package/resources/messages/messages.d.mts +20 -1
  160. package/resources/messages/messages.d.mts.map +1 -1
  161. package/resources/messages/messages.d.ts +20 -1
  162. package/resources/messages/messages.d.ts.map +1 -1
  163. package/resources/messages/messages.js.map +1 -1
  164. package/resources/messages/messages.mjs.map +1 -1
  165. package/resources/messages.d.mts.map +1 -1
  166. package/resources/messages.d.ts.map +1 -1
  167. package/resources/messages.mjs.map +1 -1
  168. package/resources/objects/bulk.d.mts.map +1 -1
  169. package/resources/objects/bulk.d.ts.map +1 -1
  170. package/resources/objects/bulk.mjs.map +1 -1
  171. package/resources/objects/index.d.mts.map +1 -1
  172. package/resources/objects/index.d.ts.map +1 -1
  173. package/resources/objects/index.mjs.map +1 -1
  174. package/resources/objects/objects.d.mts.map +1 -1
  175. package/resources/objects/objects.d.ts.map +1 -1
  176. package/resources/objects/objects.mjs.map +1 -1
  177. package/resources/objects.d.mts.map +1 -1
  178. package/resources/objects.d.ts.map +1 -1
  179. package/resources/objects.mjs.map +1 -1
  180. package/resources/providers/index.d.mts.map +1 -1
  181. package/resources/providers/index.d.ts.map +1 -1
  182. package/resources/providers/index.mjs.map +1 -1
  183. package/resources/providers/ms-teams.d.mts +4 -0
  184. package/resources/providers/ms-teams.d.mts.map +1 -1
  185. package/resources/providers/ms-teams.d.ts +4 -0
  186. package/resources/providers/ms-teams.d.ts.map +1 -1
  187. package/resources/providers/ms-teams.mjs.map +1 -1
  188. package/resources/providers/providers.d.mts.map +1 -1
  189. package/resources/providers/providers.d.ts.map +1 -1
  190. package/resources/providers/providers.mjs.map +1 -1
  191. package/resources/providers/slack.d.mts.map +1 -1
  192. package/resources/providers/slack.d.ts.map +1 -1
  193. package/resources/providers/slack.mjs.map +1 -1
  194. package/resources/providers.d.mts.map +1 -1
  195. package/resources/providers.d.ts.map +1 -1
  196. package/resources/providers.mjs.map +1 -1
  197. package/resources/recipients/channel-data.d.mts +13 -2
  198. package/resources/recipients/channel-data.d.mts.map +1 -1
  199. package/resources/recipients/channel-data.d.ts +13 -2
  200. package/resources/recipients/channel-data.d.ts.map +1 -1
  201. package/resources/recipients/channel-data.mjs.map +1 -1
  202. package/resources/recipients/index.d.mts.map +1 -1
  203. package/resources/recipients/index.d.ts.map +1 -1
  204. package/resources/recipients/index.mjs.map +1 -1
  205. package/resources/recipients/preferences.d.mts.map +1 -1
  206. package/resources/recipients/preferences.d.ts.map +1 -1
  207. package/resources/recipients/preferences.mjs.map +1 -1
  208. package/resources/recipients/recipients.d.mts.map +1 -1
  209. package/resources/recipients/recipients.d.ts.map +1 -1
  210. package/resources/recipients/recipients.mjs.map +1 -1
  211. package/resources/recipients/subscriptions.d.mts.map +1 -1
  212. package/resources/recipients/subscriptions.d.ts.map +1 -1
  213. package/resources/recipients/subscriptions.mjs.map +1 -1
  214. package/resources/recipients.d.mts.map +1 -1
  215. package/resources/recipients.d.ts.map +1 -1
  216. package/resources/recipients.mjs.map +1 -1
  217. package/resources/schedules/bulk.d.mts.map +1 -1
  218. package/resources/schedules/bulk.d.ts.map +1 -1
  219. package/resources/schedules/bulk.mjs.map +1 -1
  220. package/resources/schedules/index.d.mts.map +1 -1
  221. package/resources/schedules/index.d.ts.map +1 -1
  222. package/resources/schedules/index.mjs.map +1 -1
  223. package/resources/schedules/schedules.d.mts.map +1 -1
  224. package/resources/schedules/schedules.d.ts.map +1 -1
  225. package/resources/schedules/schedules.mjs.map +1 -1
  226. package/resources/schedules.d.mts.map +1 -1
  227. package/resources/schedules.d.ts.map +1 -1
  228. package/resources/schedules.mjs.map +1 -1
  229. package/resources/shared.d.mts +1 -1
  230. package/resources/shared.d.mts.map +1 -1
  231. package/resources/shared.d.ts +1 -1
  232. package/resources/shared.d.ts.map +1 -1
  233. package/resources/tenants/bulk.d.mts.map +1 -1
  234. package/resources/tenants/bulk.d.ts.map +1 -1
  235. package/resources/tenants/bulk.mjs.map +1 -1
  236. package/resources/tenants/index.d.mts.map +1 -1
  237. package/resources/tenants/index.d.ts.map +1 -1
  238. package/resources/tenants/index.mjs.map +1 -1
  239. package/resources/tenants/tenants.d.mts +36 -0
  240. package/resources/tenants/tenants.d.mts.map +1 -1
  241. package/resources/tenants/tenants.d.ts +36 -0
  242. package/resources/tenants/tenants.d.ts.map +1 -1
  243. package/resources/tenants/tenants.js.map +1 -1
  244. package/resources/tenants/tenants.mjs.map +1 -1
  245. package/resources/tenants.d.mts.map +1 -1
  246. package/resources/tenants.d.ts.map +1 -1
  247. package/resources/tenants.mjs.map +1 -1
  248. package/resources/users/bulk.d.mts +88 -3
  249. package/resources/users/bulk.d.mts.map +1 -1
  250. package/resources/users/bulk.d.ts +88 -3
  251. package/resources/users/bulk.d.ts.map +1 -1
  252. package/resources/users/bulk.js +1 -1
  253. package/resources/users/bulk.js.map +1 -1
  254. package/resources/users/bulk.mjs +1 -1
  255. package/resources/users/bulk.mjs.map +1 -1
  256. package/resources/users/feeds.d.mts.map +1 -1
  257. package/resources/users/feeds.d.ts.map +1 -1
  258. package/resources/users/feeds.mjs.map +1 -1
  259. package/resources/users/guides.d.mts.map +1 -1
  260. package/resources/users/guides.d.ts.map +1 -1
  261. package/resources/users/guides.mjs.map +1 -1
  262. package/resources/users/index.d.mts.map +1 -1
  263. package/resources/users/index.d.ts.map +1 -1
  264. package/resources/users/index.mjs.map +1 -1
  265. package/resources/users/users.d.mts.map +1 -1
  266. package/resources/users/users.d.ts.map +1 -1
  267. package/resources/users/users.mjs.map +1 -1
  268. package/resources/users.d.mts.map +1 -1
  269. package/resources/users.d.ts.map +1 -1
  270. package/resources/users.mjs.map +1 -1
  271. package/resources/workflow-recipient-runs.d.mts.map +1 -1
  272. package/resources/workflow-recipient-runs.d.ts.map +1 -1
  273. package/resources/workflow-recipient-runs.mjs.map +1 -1
  274. package/resources/workflows.d.mts +33 -10
  275. package/resources/workflows.d.mts.map +1 -1
  276. package/resources/workflows.d.ts +33 -10
  277. package/resources/workflows.d.ts.map +1 -1
  278. package/resources/workflows.js +1 -0
  279. package/resources/workflows.js.map +1 -1
  280. package/resources/workflows.mjs +1 -0
  281. package/resources/workflows.mjs.map +1 -1
  282. package/resources.d.mts.map +1 -1
  283. package/resources.d.ts.map +1 -1
  284. package/resources.mjs.map +1 -1
  285. package/src/client.ts +21 -1
  286. package/src/internal/types.ts +6 -8
  287. package/src/internal/utils/log.ts +2 -0
  288. package/src/internal/utils/query.ts +5 -29
  289. package/src/lib/stringifyQuery.ts +41 -0
  290. package/src/resources/messages/messages.ts +33 -11
  291. package/src/resources/providers/ms-teams.ts +5 -0
  292. package/src/resources/recipients/channel-data.ts +14 -2
  293. package/src/resources/shared.ts +1 -0
  294. package/src/resources/tenants/tenants.ts +44 -0
  295. package/src/resources/users/bulk.ts +90 -3
  296. package/src/resources/workflows.ts +36 -10
  297. package/src/version.ts +1 -1
  298. package/uploads.d.mts +1 -0
  299. package/uploads.d.mts.map +1 -1
  300. package/uploads.d.ts +1 -0
  301. package/uploads.d.ts.map +1 -1
  302. package/uploads.mjs +1 -0
  303. package/uploads.mjs.map +1 -1
  304. package/version.d.mts +1 -1
  305. package/version.d.ts +1 -1
  306. package/version.js +1 -1
  307. package/version.mjs +1 -1
@@ -58,6 +58,7 @@ export class Workflows extends APIResource {
58
58
  * severity: 'critical',
59
59
  * system_status: 'fences_failing',
60
60
  * },
61
+ * settings: { sandbox_mode: true, skip_delay: true },
61
62
  * tenant: 'ingen_isla_nublar',
62
63
  * });
63
64
  * ```
@@ -84,11 +85,11 @@ export interface WorkflowTriggerResponse {
84
85
 
85
86
  export interface WorkflowCancelParams {
86
87
  /**
87
- * An optional key that is used to reference a specific workflow trigger request
88
- * when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
89
- * request. Must be provided while triggering a workflow in order to enable
90
- * subsequent cancellation. Should be unique across trigger requests to avoid
91
- * unintentional cancellations.
88
+ * A key that is used to reference a specific workflow trigger request when issuing
89
+ * a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
90
+ * be provided while triggering a workflow in order to enable subsequent
91
+ * cancellation. Should be unique across trigger requests to avoid unintentional
92
+ * cancellations.
92
93
  */
93
94
  cancellation_key: string;
94
95
 
@@ -114,11 +115,11 @@ export interface WorkflowTriggerParams {
114
115
  actor?: RecipientsAPI.RecipientRequest | null;
115
116
 
116
117
  /**
117
- * An optional key that is used to reference a specific workflow trigger request
118
- * when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
119
- * request. Must be provided while triggering a workflow in order to enable
120
- * subsequent cancellation. Should be unique across trigger requests to avoid
121
- * unintentional cancellations.
118
+ * A key that is used to reference a specific workflow trigger request when issuing
119
+ * a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
120
+ * be provided while triggering a workflow in order to enable subsequent
121
+ * cancellation. Should be unique across trigger requests to avoid unintentional
122
+ * cancellations.
122
123
  */
123
124
  cancellation_key?: string | null;
124
125
 
@@ -130,12 +131,37 @@ export interface WorkflowTriggerParams {
130
131
  */
131
132
  data?: { [key: string]: unknown } | null;
132
133
 
134
+ /**
135
+ * Optional settings that control how this workflow trigger is executed.
136
+ */
137
+ settings?: WorkflowTriggerParams.Settings | null;
138
+
133
139
  /**
134
140
  * An request to set a tenant inline.
135
141
  */
136
142
  tenant?: TenantsAPI.InlineTenantRequest | null;
137
143
  }
138
144
 
145
+ export namespace WorkflowTriggerParams {
146
+ /**
147
+ * Optional settings that control how this workflow trigger is executed.
148
+ */
149
+ export interface Settings {
150
+ /**
151
+ * When set to true, overrides the sandbox mode for all channels in this workflow
152
+ * run, messages are not delivered to the underlying providers. If false or not
153
+ * set, the workflow delivers messages normally.
154
+ */
155
+ sandbox_mode?: boolean | null;
156
+
157
+ /**
158
+ * When set to true, skips all delay steps in the workflow for this trigger
159
+ * request. If false or not set, delay steps execute normally.
160
+ */
161
+ skip_delay?: boolean | null;
162
+ }
163
+ }
164
+
139
165
  export declare namespace Workflows {
140
166
  export {
141
167
  type WorkflowTriggerResponse as WorkflowTriggerResponse,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.32.0'; // x-release-please-version
1
+ export const VERSION = '1.33.0'; // x-release-please-version
package/uploads.d.mts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/uploads instead */
1
2
  export * from "./core/uploads.mjs";
2
3
  //# sourceMappingURL=uploads.d.mts.map
package/uploads.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}
package/uploads.d.ts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/uploads instead */
1
2
  export * from "./core/uploads.js";
2
3
  //# sourceMappingURL=uploads.d.ts.map
package/uploads.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,kCAA+B"}
package/uploads.mjs CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/uploads instead */
1
2
  export * from "./core/uploads.mjs";
2
3
  //# sourceMappingURL=uploads.mjs.map
package/uploads.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.32.0";
1
+ export declare const VERSION = "1.33.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.32.0";
1
+ export declare const VERSION = "1.33.0";
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 = '1.32.0'; // x-release-please-version
4
+ exports.VERSION = '1.33.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '1.32.0'; // x-release-please-version
1
+ export const VERSION = '1.33.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map