@knocklabs/node 1.7.0 → 1.8.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 (58) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +48 -0
  3. package/internal/uploads.js.map +1 -1
  4. package/internal/uploads.mjs.map +1 -1
  5. package/lib/tokenSigner.d.mts.map +1 -1
  6. package/lib/tokenSigner.d.ts.map +1 -1
  7. package/lib/tokenSigner.js +40 -31
  8. package/lib/tokenSigner.js.map +1 -1
  9. package/lib/tokenSigner.mjs +7 -30
  10. package/lib/tokenSigner.mjs.map +1 -1
  11. package/package.json +9 -2
  12. package/resources/objects/bulk.d.mts +2 -0
  13. package/resources/objects/bulk.d.mts.map +1 -1
  14. package/resources/objects/bulk.d.ts +2 -0
  15. package/resources/objects/bulk.d.ts.map +1 -1
  16. package/resources/objects/objects.d.mts +4 -0
  17. package/resources/objects/objects.d.mts.map +1 -1
  18. package/resources/objects/objects.d.ts +4 -0
  19. package/resources/objects/objects.d.ts.map +1 -1
  20. package/resources/objects/objects.js.map +1 -1
  21. package/resources/objects/objects.mjs.map +1 -1
  22. package/resources/recipients/preferences.d.mts +2 -0
  23. package/resources/recipients/preferences.d.mts.map +1 -1
  24. package/resources/recipients/preferences.d.ts +2 -0
  25. package/resources/recipients/preferences.d.ts.map +1 -1
  26. package/resources/tenants/tenants.d.mts +2 -0
  27. package/resources/tenants/tenants.d.mts.map +1 -1
  28. package/resources/tenants/tenants.d.ts +2 -0
  29. package/resources/tenants/tenants.d.ts.map +1 -1
  30. package/resources/tenants/tenants.js.map +1 -1
  31. package/resources/tenants/tenants.mjs.map +1 -1
  32. package/resources/users/bulk.d.mts +8 -7
  33. package/resources/users/bulk.d.mts.map +1 -1
  34. package/resources/users/bulk.d.ts +8 -7
  35. package/resources/users/bulk.d.ts.map +1 -1
  36. package/resources/users/bulk.js +8 -7
  37. package/resources/users/bulk.js.map +1 -1
  38. package/resources/users/bulk.mjs +8 -7
  39. package/resources/users/bulk.mjs.map +1 -1
  40. package/resources/users/users.d.mts +6 -0
  41. package/resources/users/users.d.mts.map +1 -1
  42. package/resources/users/users.d.ts +6 -0
  43. package/resources/users/users.d.ts.map +1 -1
  44. package/resources/users/users.js.map +1 -1
  45. package/resources/users/users.mjs.map +1 -1
  46. package/src/internal/uploads.ts +1 -1
  47. package/src/lib/tokenSigner.ts +16 -39
  48. package/src/resources/objects/bulk.ts +2 -0
  49. package/src/resources/objects/objects.ts +4 -0
  50. package/src/resources/recipients/preferences.ts +2 -0
  51. package/src/resources/tenants/tenants.ts +2 -0
  52. package/src/resources/users/bulk.ts +8 -7
  53. package/src/resources/users/users.ts +6 -0
  54. package/src/version.ts +1 -1
  55. package/version.d.mts +1 -1
  56. package/version.d.ts +1 -1
  57. package/version.js +1 -1
  58. package/version.mjs +1 -1
@@ -9,8 +9,7 @@ import { RequestOptions } from '../../internal/request-options';
9
9
 
10
10
  export class Bulk extends APIResource {
11
11
  /**
12
- * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
13
- * delete and returns a bulk operation that can be queried for progress.
12
+ * Permanently deletes up to 1,000 users at a time.
14
13
  *
15
14
  * @example
16
15
  * ```ts
@@ -25,8 +24,8 @@ export class Bulk extends APIResource {
25
24
 
26
25
  /**
27
26
  * Identifies multiple users in a single operation. Allows creating or updating up
28
- * to 100 users in a single batch with various properties, preferences, and channel
29
- * data.
27
+ * to 1,000 users in a single batch with various properties, preferences, and
28
+ * channel data.
30
29
  *
31
30
  * @example
32
31
  * ```ts
@@ -47,9 +46,11 @@ export class Bulk extends APIResource {
47
46
  }
48
47
 
49
48
  /**
50
- * Sets preferences for multiple users in a single operation. Supports either
51
- * setting the same preferences for multiple users or specific preferences for each
52
- * user.
49
+ * Bulk sets the preferences for up to 1,000 users at a time. The preference
50
+ * set `:id` can be either `default` or a `tenant.id`. Learn more
51
+ * about [per-tenant preferences](/preferences/tenant-preferences). Note that this
52
+ * is a destructive operation and will replace any existing users' preferences with
53
+ * the preferences sent.
53
54
  *
54
55
  * @example
55
56
  * ```ts
@@ -389,6 +389,8 @@ export interface IdentifyUserRequest {
389
389
 
390
390
  /**
391
391
  * Inline set preferences for a recipient, where the key is the preference set id.
392
+ * Preferences that are set inline will be merged into any existing preferences
393
+ * rather than replacing them.
392
394
  */
393
395
  preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
394
396
 
@@ -453,6 +455,8 @@ export interface InlineIdentifyUserRequest {
453
455
 
454
456
  /**
455
457
  * Inline set preferences for a recipient, where the key is the preference set id.
458
+ * Preferences that are set inline will be merged into any existing preferences
459
+ * rather than replacing them.
456
460
  */
457
461
  preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
458
462
 
@@ -579,6 +583,8 @@ export interface UserUpdateParams {
579
583
 
580
584
  /**
581
585
  * Inline set preferences for a recipient, where the key is the preference set id.
586
+ * Preferences that are set inline will be merged into any existing preferences
587
+ * rather than replacing them.
582
588
  */
583
589
  preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
584
590
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.7.0'; // x-release-please-version
1
+ export const VERSION = '1.8.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.7.0";
1
+ export declare const VERSION = "1.8.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.7.0";
1
+ export declare const VERSION = "1.8.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.7.0'; // x-release-please-version
4
+ exports.VERSION = '1.8.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '1.7.0'; // x-release-please-version
1
+ export const VERSION = '1.8.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map