@knocklabs/node 1.21.0 → 1.22.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 (84) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/client.d.mts +21 -1
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +21 -1
  5. package/client.d.ts.map +1 -1
  6. package/client.js +43 -2
  7. package/client.js.map +1 -1
  8. package/client.mjs +43 -2
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/objects/bulk.d.mts +5 -19
  12. package/resources/objects/bulk.d.mts.map +1 -1
  13. package/resources/objects/bulk.d.ts +5 -19
  14. package/resources/objects/bulk.d.ts.map +1 -1
  15. package/resources/objects/bulk.js +1 -19
  16. package/resources/objects/bulk.js.map +1 -1
  17. package/resources/objects/bulk.mjs +1 -19
  18. package/resources/objects/bulk.mjs.map +1 -1
  19. package/resources/objects/objects.d.mts +13 -68
  20. package/resources/objects/objects.d.mts.map +1 -1
  21. package/resources/objects/objects.d.ts +13 -68
  22. package/resources/objects/objects.d.ts.map +1 -1
  23. package/resources/objects/objects.js +1 -0
  24. package/resources/objects/objects.js.map +1 -1
  25. package/resources/objects/objects.mjs +1 -0
  26. package/resources/objects/objects.mjs.map +1 -1
  27. package/resources/recipients/channel-data.d.mts +94 -73
  28. package/resources/recipients/channel-data.d.mts.map +1 -1
  29. package/resources/recipients/channel-data.d.ts +94 -73
  30. package/resources/recipients/channel-data.d.ts.map +1 -1
  31. package/resources/recipients/index.d.mts +2 -2
  32. package/resources/recipients/index.d.mts.map +1 -1
  33. package/resources/recipients/index.d.ts +2 -2
  34. package/resources/recipients/index.d.ts.map +1 -1
  35. package/resources/recipients/index.js.map +1 -1
  36. package/resources/recipients/index.mjs.map +1 -1
  37. package/resources/recipients/preferences.d.mts +17 -75
  38. package/resources/recipients/preferences.d.mts.map +1 -1
  39. package/resources/recipients/preferences.d.ts +17 -75
  40. package/resources/recipients/preferences.d.ts.map +1 -1
  41. package/resources/recipients/recipients.d.mts +4 -4
  42. package/resources/recipients/recipients.d.mts.map +1 -1
  43. package/resources/recipients/recipients.d.ts +4 -4
  44. package/resources/recipients/recipients.d.ts.map +1 -1
  45. package/resources/recipients/recipients.js.map +1 -1
  46. package/resources/recipients/recipients.mjs.map +1 -1
  47. package/resources/tenants/bulk.d.mts +1 -1
  48. package/resources/tenants/bulk.d.ts +1 -1
  49. package/resources/tenants/bulk.js +1 -1
  50. package/resources/tenants/bulk.mjs +1 -1
  51. package/resources/tenants/tenants.d.mts +9 -0
  52. package/resources/tenants/tenants.d.mts.map +1 -1
  53. package/resources/tenants/tenants.d.ts +9 -0
  54. package/resources/tenants/tenants.d.ts.map +1 -1
  55. package/resources/tenants/tenants.js +1 -0
  56. package/resources/tenants/tenants.js.map +1 -1
  57. package/resources/tenants/tenants.mjs +1 -0
  58. package/resources/tenants/tenants.mjs.map +1 -1
  59. package/resources/users/feeds.d.mts +7 -0
  60. package/resources/users/feeds.d.mts.map +1 -1
  61. package/resources/users/feeds.d.ts +7 -0
  62. package/resources/users/feeds.d.ts.map +1 -1
  63. package/resources/users/users.d.mts +4 -68
  64. package/resources/users/users.d.mts.map +1 -1
  65. package/resources/users/users.d.ts +4 -68
  66. package/resources/users/users.d.ts.map +1 -1
  67. package/resources/users/users.js.map +1 -1
  68. package/resources/users/users.mjs.map +1 -1
  69. package/src/client.ts +52 -1
  70. package/src/resources/objects/bulk.ts +6 -19
  71. package/src/resources/objects/objects.ts +19 -80
  72. package/src/resources/recipients/channel-data.ts +117 -83
  73. package/src/resources/recipients/index.ts +6 -0
  74. package/src/resources/recipients/preferences.ts +17 -87
  75. package/src/resources/recipients/recipients.ts +12 -0
  76. package/src/resources/tenants/bulk.ts +1 -1
  77. package/src/resources/tenants/tenants.ts +11 -0
  78. package/src/resources/users/feeds.ts +8 -0
  79. package/src/resources/users/users.ts +8 -80
  80. package/src/version.ts +1 -1
  81. package/version.d.mts +1 -1
  82. package/version.d.ts +1 -1
  83. package/version.js +1 -1
  84. package/version.mjs +1 -1
@@ -66,6 +66,7 @@ export class Tenants extends APIResource {
66
66
  * @example
67
67
  * ```ts
68
68
  * const tenant = await client.tenants.set('id', {
69
+ * name: 'Jurassic Park',
69
70
  * settings: {
70
71
  * branding: {
71
72
  * icon_url:
@@ -179,6 +180,11 @@ export interface TenantRequest {
179
180
  */
180
181
  channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
181
182
 
183
+ /**
184
+ * An optional name for the tenant.
185
+ */
186
+ name?: string | null;
187
+
182
188
  /**
183
189
  * Inline set preferences for a recipient, where the key is the preference set id.
184
190
  * Preferences that are set inline will be merged into any existing preferences
@@ -258,6 +264,11 @@ export interface TenantSetParams {
258
264
  */
259
265
  channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
260
266
 
267
+ /**
268
+ * An optional name for the tenant.
269
+ */
270
+ name?: string | null;
271
+
261
272
  /**
262
273
  * The settings for the tenant. Includes branding and preference set.
263
274
  */
@@ -291,6 +291,14 @@ export interface FeedListItemsParams extends EntriesCursorParams {
291
291
  */
292
292
  has_tenant?: boolean;
293
293
 
294
+ /**
295
+ * The locale to render the feed items in. Must be in the IETF 5646 format (e.g.
296
+ * `en-US`). When not provided, will default to the locale that the feed items were
297
+ * rendered in. Only available for enterprise plan customers using custom
298
+ * translations.
299
+ */
300
+ locale?: string;
301
+
294
302
  /**
295
303
  * The workflow key associated with the message in the feed.
296
304
  */
@@ -748,47 +748,16 @@ export interface UserSetChannelDataParams {
748
748
  * Channel data for a given channel type.
749
749
  */
750
750
  data:
751
- | UserSetChannelDataParams.PushChannelDataTokensOnly
752
- | UserSetChannelDataParams.AwssnsPushChannelDataTargetArNsOnly
753
- | UserSetChannelDataParams.OneSignalChannelDataPlayerIDsOnly
751
+ | ChannelDataAPI.PushChannelDataTokensOnly
752
+ | ChannelDataAPI.PushChannelDataDevicesOnly
753
+ | ChannelDataAPI.AwsSnsPushChannelDataTargetArnsOnly
754
+ | ChannelDataAPI.AwsSnsPushChannelDataDevicesOnly
755
+ | ChannelDataAPI.OneSignalChannelDataPlayerIDsOnly
754
756
  | ChannelDataAPI.SlackChannelData
755
757
  | ChannelDataAPI.MsTeamsChannelData
756
758
  | ChannelDataAPI.DiscordChannelData;
757
759
  }
758
760
 
759
- export namespace UserSetChannelDataParams {
760
- /**
761
- * Push channel data.
762
- */
763
- export interface PushChannelDataTokensOnly {
764
- /**
765
- * A list of push channel tokens.
766
- */
767
- tokens: Array<string>;
768
- }
769
-
770
- /**
771
- * AWS SNS push channel data.
772
- */
773
- export interface AwssnsPushChannelDataTargetArNsOnly {
774
- /**
775
- * A list of platform endpoint ARNs. See
776
- * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
777
- */
778
- target_arns: Array<string>;
779
- }
780
-
781
- /**
782
- * OneSignal channel data.
783
- */
784
- export interface OneSignalChannelDataPlayerIDsOnly {
785
- /**
786
- * A list of OneSignal player IDs.
787
- */
788
- player_ids: Array<string>;
789
- }
790
- }
791
-
792
761
  export interface UserSetPreferencesParams {
793
762
  /**
794
763
  * Controls how the preference set is persisted. 'replace' will completely replace
@@ -812,7 +781,7 @@ export interface UserSetPreferencesParams {
812
781
  /**
813
782
  * Channel preferences.
814
783
  */
815
- channels?: { [key: string]: boolean | UserSetPreferencesParams.PreferenceSetChannelSetting } | null;
784
+ channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
816
785
 
817
786
  /**
818
787
  * Whether the recipient is subscribed to commercial communications. When false,
@@ -843,9 +812,7 @@ export namespace UserSetPreferencesParams {
843
812
  /**
844
813
  * Channel preferences.
845
814
  */
846
- channels?: {
847
- [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
848
- } | null;
815
+ channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
849
816
 
850
817
  /**
851
818
  * A list of conditions to apply to a channel type.
@@ -853,30 +820,6 @@ export namespace UserSetPreferencesParams {
853
820
  conditions?: Array<Shared.Condition> | null;
854
821
  }
855
822
 
856
- export namespace PreferenceSetWorkflowCategorySettingObject {
857
- /**
858
- * A set of settings for a specific channel. Currently, this can only be a list of
859
- * conditions to apply.
860
- */
861
- export interface PreferenceSetChannelSetting {
862
- /**
863
- * A list of conditions to apply to a specific channel.
864
- */
865
- conditions: Array<Shared.Condition>;
866
- }
867
- }
868
-
869
- /**
870
- * A set of settings for a specific channel. Currently, this can only be a list of
871
- * conditions to apply.
872
- */
873
- export interface PreferenceSetChannelSetting {
874
- /**
875
- * A list of conditions to apply to a specific channel.
876
- */
877
- conditions: Array<Shared.Condition>;
878
- }
879
-
880
823
  /**
881
824
  * The settings object for a workflow or category, where you can specify channel
882
825
  * types or conditions.
@@ -890,28 +833,13 @@ export namespace UserSetPreferencesParams {
890
833
  /**
891
834
  * Channel preferences.
892
835
  */
893
- channels?: {
894
- [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
895
- } | null;
836
+ channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
896
837
 
897
838
  /**
898
839
  * A list of conditions to apply to a channel type.
899
840
  */
900
841
  conditions?: Array<Shared.Condition> | null;
901
842
  }
902
-
903
- export namespace PreferenceSetWorkflowCategorySettingObject {
904
- /**
905
- * A set of settings for a specific channel. Currently, this can only be a list of
906
- * conditions to apply.
907
- */
908
- export interface PreferenceSetChannelSetting {
909
- /**
910
- * A list of conditions to apply to a specific channel.
911
- */
912
- conditions: Array<Shared.Condition>;
913
- }
914
- }
915
843
  }
916
844
 
917
845
  Users.Feeds = Feeds;
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.21.0'; // x-release-please-version
1
+ export const VERSION = '1.22.1'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.21.0";
1
+ export declare const VERSION = "1.22.1";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.21.0";
1
+ export declare const VERSION = "1.22.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 = '1.21.0'; // x-release-please-version
4
+ exports.VERSION = '1.22.1'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '1.21.0'; // x-release-please-version
1
+ export const VERSION = '1.22.1'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map