@knocklabs/node 1.0.0 → 1.2.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.
- package/CHANGELOG.md +38 -0
- package/README.md +1 -1
- package/api-promise.js +2 -15
- package/api-promise.js.map +1 -1
- package/client.d.mts +4 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -1
- package/client.d.ts.map +1 -1
- package/client.js +27 -44
- package/client.js.map +1 -1
- package/client.mjs +18 -12
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts +0 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts +0 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.js +4 -14
- package/core/api-promise.js.map +1 -1
- package/core/api-promise.mjs +1 -11
- package/core/api-promise.mjs.map +1 -1
- package/core/error.d.mts +0 -1
- package/core/error.d.mts.map +1 -1
- package/core/error.d.ts +0 -1
- package/core/error.d.ts.map +1 -1
- package/core/error.js.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/pagination.d.mts +0 -1
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts +0 -1
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.js +3 -13
- package/core/pagination.js.map +1 -1
- package/core/pagination.mjs +1 -11
- package/core/pagination.mjs.map +1 -1
- package/error.js +2 -15
- package/error.js.map +1 -1
- package/internal/builtin-types.d.mts +0 -2
- package/internal/builtin-types.d.mts.map +1 -1
- package/internal/builtin-types.d.ts +0 -2
- package/internal/builtin-types.d.ts.map +1 -1
- package/internal/detect-platform.js.map +1 -1
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/errors.d.mts.map +1 -1
- package/internal/errors.d.ts.map +1 -1
- package/internal/errors.js +2 -2
- package/internal/errors.js.map +1 -1
- package/internal/errors.mjs.map +1 -1
- package/internal/headers.d.mts +0 -1
- package/internal/headers.d.mts.map +1 -1
- package/internal/headers.d.ts +0 -1
- package/internal/headers.d.ts.map +1 -1
- package/internal/headers.js +1 -1
- package/internal/headers.js.map +1 -1
- package/internal/headers.mjs +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts +0 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts +0 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +1 -2
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/stringify.js +1 -2
- package/internal/qs/stringify.js.map +1 -1
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/utils.js +9 -9
- package/internal/qs/utils.js.map +1 -1
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts +0 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts +0 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.js +5 -6
- package/internal/shims.js.map +1 -1
- package/internal/shims.mjs.map +1 -1
- package/internal/to-file.d.mts +0 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts +0 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.js +4 -4
- package/internal/to-file.js.map +1 -1
- package/internal/to-file.mjs +3 -2
- package/internal/to-file.mjs.map +1 -1
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +0 -1
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +0 -1
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts +1 -3
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts +1 -3
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.js +16 -6
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs +12 -3
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.d.mts.map +1 -1
- package/internal/utils/base64.d.ts.map +1 -1
- package/internal/utils/base64.js.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/bytes.d.mts +1 -1
- package/internal/utils/bytes.d.mts.map +1 -1
- package/internal/utils/bytes.d.ts +1 -1
- package/internal/utils/bytes.d.ts.map +1 -1
- package/internal/utils/bytes.js +3 -4
- package/internal/utils/bytes.js.map +1 -1
- package/internal/utils/bytes.mjs.map +1 -1
- package/internal/utils/env.d.mts.map +1 -1
- package/internal/utils/env.d.ts.map +1 -1
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs.map +1 -1
- package/internal/utils/log.d.mts +0 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts +0 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +2 -2
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.d.mts.map +1 -1
- package/internal/utils/path.d.ts.map +1 -1
- package/internal/utils/path.js +2 -2
- package/internal/utils/path.js.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/sleep.d.mts.map +1 -1
- package/internal/utils/sleep.d.ts.map +1 -1
- package/internal/utils/uuid.d.mts +1 -1
- package/internal/utils/uuid.d.mts.map +1 -1
- package/internal/utils/uuid.d.ts +1 -1
- package/internal/utils/uuid.d.ts.map +1 -1
- package/internal/utils/uuid.js +1 -2
- package/internal/utils/uuid.js.map +1 -1
- package/internal/utils/uuid.mjs +1 -2
- package/internal/utils/uuid.mjs.map +1 -1
- package/internal/utils/values.d.mts.map +1 -1
- package/internal/utils/values.d.ts.map +1 -1
- package/internal/utils/values.js +5 -5
- package/internal/utils/values.js.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.js +7 -20
- package/internal/utils.js.map +1 -1
- package/lib/index.js +3 -16
- package/lib/index.js.map +1 -1
- package/lib/tokenSigner.js +5 -28
- package/lib/tokenSigner.js.map +1 -1
- package/lib/tokenSigner.mjs.map +1 -1
- package/lib/userTokens.js +1 -1
- package/lib/userTokens.js.map +1 -1
- package/package.json +2 -6
- package/pagination.js +2 -15
- package/pagination.js.map +1 -1
- package/resource.js +2 -15
- package/resource.js.map +1 -1
- package/resources/audiences.d.mts +37 -0
- package/resources/audiences.d.mts.map +1 -1
- package/resources/audiences.d.ts +37 -0
- package/resources/audiences.d.ts.map +1 -1
- package/resources/audiences.js +25 -0
- package/resources/audiences.js.map +1 -1
- package/resources/audiences.mjs +25 -0
- package/resources/audiences.mjs.map +1 -1
- package/resources/bulk-operations.d.mts +7 -0
- package/resources/bulk-operations.d.mts.map +1 -1
- package/resources/bulk-operations.d.ts +7 -0
- package/resources/bulk-operations.d.ts.map +1 -1
- package/resources/bulk-operations.js +7 -0
- package/resources/bulk-operations.js.map +1 -1
- package/resources/bulk-operations.mjs +7 -0
- package/resources/bulk-operations.mjs.map +1 -1
- package/resources/channels/bulk.d.mts +21 -0
- package/resources/channels/bulk.d.mts.map +1 -1
- package/resources/channels/bulk.d.ts +21 -0
- package/resources/channels/bulk.d.ts.map +1 -1
- package/resources/channels/bulk.js +21 -0
- package/resources/channels/bulk.js.map +1 -1
- package/resources/channels/bulk.mjs +21 -0
- package/resources/channels/bulk.mjs.map +1 -1
- package/resources/channels/channels.js +2 -24
- package/resources/channels/channels.js.map +1 -1
- package/resources/channels.js +2 -15
- package/resources/channels.js.map +1 -1
- package/resources/integrations/integrations.js +3 -25
- package/resources/integrations/integrations.js.map +1 -1
- package/resources/integrations.js +2 -15
- package/resources/integrations.js.map +1 -1
- package/resources/messages/batch.d.mts +76 -0
- package/resources/messages/batch.d.mts.map +1 -1
- package/resources/messages/batch.d.ts +76 -0
- package/resources/messages/batch.d.ts.map +1 -1
- package/resources/messages/batch.js +76 -0
- package/resources/messages/batch.js.map +1 -1
- package/resources/messages/batch.mjs +76 -0
- package/resources/messages/batch.mjs.map +1 -1
- package/resources/messages/index.d.mts +0 -1
- package/resources/messages/index.d.mts.map +1 -1
- package/resources/messages/index.d.ts +0 -1
- package/resources/messages/index.d.ts.map +1 -1
- package/resources/messages/index.js +1 -3
- package/resources/messages/index.js.map +1 -1
- package/resources/messages/index.mjs +0 -1
- package/resources/messages/index.mjs.map +1 -1
- package/resources/messages/messages.d.mts +101 -4
- package/resources/messages/messages.d.mts.map +1 -1
- package/resources/messages/messages.d.ts +101 -4
- package/resources/messages/messages.d.ts.map +1 -1
- package/resources/messages/messages.js +103 -28
- package/resources/messages/messages.js.map +1 -1
- package/resources/messages/messages.mjs +101 -4
- package/resources/messages/messages.mjs.map +1 -1
- package/resources/messages.js +2 -15
- package/resources/messages.js.map +1 -1
- package/resources/objects/bulk.d.mts +49 -0
- package/resources/objects/bulk.d.mts.map +1 -1
- package/resources/objects/bulk.d.ts +49 -0
- package/resources/objects/bulk.d.ts.map +1 -1
- package/resources/objects/bulk.js +49 -0
- package/resources/objects/bulk.js.map +1 -1
- package/resources/objects/bulk.mjs +49 -0
- package/resources/objects/bulk.mjs.map +1 -1
- package/resources/objects/objects.d.mts +179 -5
- package/resources/objects/objects.d.mts.map +1 -1
- package/resources/objects/objects.d.ts +179 -5
- package/resources/objects/objects.d.ts.map +1 -1
- package/resources/objects/objects.js +173 -24
- package/resources/objects/objects.js.map +1 -1
- package/resources/objects/objects.mjs +171 -0
- package/resources/objects/objects.mjs.map +1 -1
- package/resources/objects.js +2 -15
- package/resources/objects.js.map +1 -1
- package/resources/providers/ms-teams.d.mts +40 -0
- package/resources/providers/ms-teams.d.mts.map +1 -1
- package/resources/providers/ms-teams.d.ts +40 -0
- package/resources/providers/ms-teams.d.ts.map +1 -1
- package/resources/providers/ms-teams.js +40 -0
- package/resources/providers/ms-teams.js.map +1 -1
- package/resources/providers/ms-teams.mjs +40 -0
- package/resources/providers/ms-teams.mjs.map +1 -1
- package/resources/providers/providers.js +3 -25
- package/resources/providers/providers.js.map +1 -1
- package/resources/providers/slack.d.mts +27 -0
- package/resources/providers/slack.d.mts.map +1 -1
- package/resources/providers/slack.d.ts +27 -0
- package/resources/providers/slack.d.ts.map +1 -1
- package/resources/providers/slack.js +27 -0
- package/resources/providers/slack.js.map +1 -1
- package/resources/providers/slack.mjs +27 -0
- package/resources/providers/slack.mjs.map +1 -1
- package/resources/providers.js +2 -15
- package/resources/providers.js.map +1 -1
- package/resources/recipients/channel-data.d.mts +1 -1
- package/resources/recipients/channel-data.d.mts.map +1 -1
- package/resources/recipients/channel-data.d.ts +1 -1
- package/resources/recipients/channel-data.d.ts.map +1 -1
- package/resources/recipients/recipients.js +4 -26
- package/resources/recipients/recipients.js.map +1 -1
- package/resources/recipients.js +2 -15
- package/resources/recipients.js.map +1 -1
- package/resources/schedules/bulk.d.mts +30 -0
- package/resources/schedules/bulk.d.mts.map +1 -1
- package/resources/schedules/bulk.d.ts +30 -0
- package/resources/schedules/bulk.d.ts.map +1 -1
- package/resources/schedules/bulk.js +30 -0
- package/resources/schedules/bulk.js.map +1 -1
- package/resources/schedules/bulk.mjs +30 -0
- package/resources/schedules/bulk.mjs.map +1 -1
- package/resources/schedules/schedules.d.mts +75 -2
- package/resources/schedules/schedules.d.mts.map +1 -1
- package/resources/schedules/schedules.d.ts +75 -2
- package/resources/schedules/schedules.d.ts.map +1 -1
- package/resources/schedules/schedules.js +76 -24
- package/resources/schedules/schedules.js.map +1 -1
- package/resources/schedules/schedules.mjs +74 -0
- package/resources/schedules/schedules.mjs.map +1 -1
- package/resources/schedules.js +2 -15
- package/resources/schedules.js.map +1 -1
- package/resources/tenants/bulk.d.mts +14 -0
- package/resources/tenants/bulk.d.mts.map +1 -1
- package/resources/tenants/bulk.d.ts +14 -0
- package/resources/tenants/bulk.d.ts.map +1 -1
- package/resources/tenants/bulk.js +14 -0
- package/resources/tenants/bulk.js.map +1 -1
- package/resources/tenants/bulk.mjs +14 -0
- package/resources/tenants/bulk.mjs.map +1 -1
- package/resources/tenants/tenants.d.mts +33 -0
- package/resources/tenants/tenants.d.mts.map +1 -1
- package/resources/tenants/tenants.d.ts +33 -0
- package/resources/tenants/tenants.d.ts.map +1 -1
- package/resources/tenants/tenants.js +35 -24
- package/resources/tenants/tenants.js.map +1 -1
- package/resources/tenants/tenants.mjs +33 -0
- package/resources/tenants/tenants.mjs.map +1 -1
- package/resources/tenants.js +2 -15
- package/resources/tenants.js.map +1 -1
- package/resources/users/bulk.d.mts +41 -0
- package/resources/users/bulk.d.mts.map +1 -1
- package/resources/users/bulk.d.ts +41 -0
- package/resources/users/bulk.d.ts.map +1 -1
- package/resources/users/bulk.js +41 -0
- package/resources/users/bulk.js.map +1 -1
- package/resources/users/bulk.mjs +41 -0
- package/resources/users/bulk.mjs.map +1 -1
- package/resources/users/feeds.d.mts +19 -0
- package/resources/users/feeds.d.mts.map +1 -1
- package/resources/users/feeds.d.ts +19 -0
- package/resources/users/feeds.d.ts.map +1 -1
- package/resources/users/feeds.js +19 -0
- package/resources/users/feeds.js.map +1 -1
- package/resources/users/feeds.mjs +19 -0
- package/resources/users/feeds.mjs.map +1 -1
- package/resources/users/guides.d.mts +68 -0
- package/resources/users/guides.d.mts.map +1 -1
- package/resources/users/guides.d.ts +68 -0
- package/resources/users/guides.d.ts.map +1 -1
- package/resources/users/guides.js +68 -0
- package/resources/users/guides.js.map +1 -1
- package/resources/users/guides.mjs +68 -0
- package/resources/users/guides.mjs.map +1 -1
- package/resources/users/users.d.mts +182 -15
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +182 -15
- package/resources/users/users.d.ts.map +1 -1
- package/resources/users/users.js +143 -26
- package/resources/users/users.js.map +1 -1
- package/resources/users/users.mjs +139 -0
- package/resources/users/users.mjs.map +1 -1
- package/resources/users.js +2 -15
- package/resources/users.js.map +1 -1
- package/resources/workflows.d.mts +30 -0
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +30 -0
- package/resources/workflows.d.ts.map +1 -1
- package/resources/workflows.js +30 -0
- package/resources/workflows.js.map +1 -1
- package/resources/workflows.mjs +30 -0
- package/resources/workflows.mjs.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/client.ts +17 -0
- package/src/internal/headers.ts +1 -1
- package/src/internal/to-file.ts +4 -2
- package/src/internal/uploads.ts +16 -4
- package/src/internal/utils/uuid.ts +1 -3
- package/src/resources/audiences.ts +37 -0
- package/src/resources/bulk-operations.ts +7 -0
- package/src/resources/channels/bulk.ts +21 -0
- package/src/resources/messages/batch.ts +76 -0
- package/src/resources/messages/index.ts +0 -1
- package/src/resources/messages/messages.ts +101 -6
- package/src/resources/objects/bulk.ts +49 -0
- package/src/resources/objects/objects.ts +179 -5
- package/src/resources/providers/ms-teams.ts +40 -0
- package/src/resources/providers/slack.ts +27 -0
- package/src/resources/recipients/channel-data.ts +4 -1
- package/src/resources/schedules/bulk.ts +30 -0
- package/src/resources/schedules/schedules.ts +75 -2
- package/src/resources/tenants/bulk.ts +14 -0
- package/src/resources/tenants/tenants.ts +33 -0
- package/src/resources/users/bulk.ts +41 -0
- package/src/resources/users/feeds.ts +19 -0
- package/src/resources/users/guides.ts +68 -0
- package/src/resources/users/users.ts +188 -15
- package/src/resources/workflows.ts +30 -0
- package/src/version.ts +1 -1
- package/uploads.js +2 -15
- package/uploads.js.map +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/internal/shims/crypto.d.mts +0 -13
- package/internal/shims/crypto.d.mts.map +0 -1
- package/internal/shims/crypto.d.ts +0 -13
- package/internal/shims/crypto.d.ts.map +0 -1
- package/internal/shims/crypto.js +0 -13
- package/internal/shims/crypto.js.map +0 -1
- package/internal/shims/crypto.mjs +0 -9
- package/internal/shims/crypto.mjs.map +0 -1
- package/internal/shims/file.d.mts +0 -23
- package/internal/shims/file.d.mts.map +0 -1
- package/internal/shims/file.d.ts +0 -23
- package/internal/shims/file.d.ts.map +0 -1
- package/internal/shims/file.js +0 -16
- package/internal/shims/file.js.map +0 -1
- package/internal/shims/file.mjs +0 -12
- package/internal/shims/file.mjs.map +0 -1
- package/internal/shims/getBuiltinModule.d.mts +0 -11
- package/internal/shims/getBuiltinModule.d.mts.map +0 -1
- package/internal/shims/getBuiltinModule.d.ts +0 -11
- package/internal/shims/getBuiltinModule.d.ts.map +0 -1
- package/internal/shims/getBuiltinModule.js +0 -71
- package/internal/shims/getBuiltinModule.js.map +0 -1
- package/internal/shims/getBuiltinModule.mjs +0 -67
- package/internal/shims/getBuiltinModule.mjs.map +0 -1
- package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
- package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
- package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
- package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
- package/internal/shims/nullGetBuiltinModule.js +0 -5
- package/internal/shims/nullGetBuiltinModule.js.map +0 -1
- package/internal/shims/nullGetBuiltinModule.mjs +0 -2
- package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
- package/resources/messages/activities.d.mts +0 -22
- package/resources/messages/activities.d.mts.map +0 -1
- package/resources/messages/activities.d.ts +0 -22
- package/resources/messages/activities.d.ts.map +0 -1
- package/resources/messages/activities.js +0 -17
- package/resources/messages/activities.js.map +0 -1
- package/resources/messages/activities.mjs +0 -13
- package/resources/messages/activities.mjs.map +0 -1
- package/src/internal/shims/crypto.ts +0 -18
- package/src/internal/shims/file.ts +0 -32
- package/src/internal/shims/getBuiltinModule.ts +0 -66
- package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
- package/src/resources/messages/activities.ts +0 -38
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,WAAW;OAChB,EAAE,qBAAqB,EAAE;OACzB,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,gBAAgB;OACrB,EAAE,0BAA0B,EAAE;OAC9B,KAAK,YAAY;OACjB,EAAE,sBAAsB,EAAE;OAC1B,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,wBAAwB,EAAE;OACxE,KAAK,QAAQ;OACb,EACL,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,mCAAmC,EACnC,KAAK,EACN;OACM,KAAK,SAAS;OACd,EACL,qBAAqB,EACrB,uBAAuB,EACvB,gCAAgC,EAChC,kCAAkC,EAClC,kCAAkC,EAClC,oCAAoC,EACpC,4BAA4B,EAC5B,8BAA8B,EAC9B,MAAM,EACP;OACM,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD
|
|
1
|
+
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,WAAW;OAChB,EAAE,qBAAqB,EAAE;OACzB,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,gBAAgB;OACrB,EAAE,0BAA0B,EAAE;OAC9B,KAAK,YAAY;OACjB,EAAE,sBAAsB,EAAE;OAC1B,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,wBAAwB,EAAE;OACxE,KAAK,QAAQ;OACb,EACL,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,mCAAmC,EACnC,KAAK,EACN;OACM,KAAK,SAAS;OACd,EACL,qBAAqB,EACrB,uBAAuB,EACvB,gCAAgC,EAChC,kCAAkC,EAClC,kCAAkC,EAClC,oCAAoC,EACpC,4BAA4B,EAC5B,8BAA8B,EAC9B,MAAM,EACP;OACM,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAIxC;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIpE;;;;;;;OAOG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI/D;;;;;;;;;;OAUG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAIzC;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAI3C;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,WAAW,CAAC,OAAO,CAAC;IAO1D;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,YAAY,CAAC,QAAQ,CAAC;IAQ7D;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAQzE;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIxF;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC;IAIzC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC;IAI3C;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGlG;AAED,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAElD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,UAAU,CAAC,CAAC;IAExF,WAAW,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAEhD;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACZ,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,oBAAoB,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAChG,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EACA,cAAc,CAAC,eAAe,GAC9B,cAAc,CAAC,oBAAoB,GACnC,cAAc,CAAC,gBAAgB,GAC/B,cAAc,CAAC,kBAAkB,GACjC,cAAc,CAAC,kBAAkB,CAAC;CACvC;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN,OAAO,GAAG,wBAAwB,CAAC,0CAA0C,CAC9E,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAChB,MAAM,EACN,OAAO,GAAG,wBAAwB,CAAC,0CAA0C,CAC9E,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;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;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,KAAK,0BAA0B,EAAE,CAAC"}
|
package/resources/users/users.js
CHANGED
|
@@ -1,36 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
-
if (k2 === undefined) k2 = k;
|
|
5
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
-
}
|
|
9
|
-
Object.defineProperty(o, k2, desc);
|
|
10
|
-
}) : (function(o, m, k, k2) {
|
|
11
|
-
if (k2 === undefined) k2 = k;
|
|
12
|
-
o[k2] = m[k];
|
|
13
|
-
}));
|
|
14
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
-
}) : function(o, v) {
|
|
17
|
-
o["default"] = v;
|
|
18
|
-
});
|
|
19
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
20
|
-
if (mod && mod.__esModule) return mod;
|
|
21
|
-
var result = {};
|
|
22
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
23
|
-
__setModuleDefault(result, mod);
|
|
24
|
-
return result;
|
|
25
|
-
};
|
|
26
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
4
|
exports.Users = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
28
6
|
const resource_1 = require("../../core/resource.js");
|
|
29
|
-
const BulkAPI = __importStar(require("./bulk.js"));
|
|
7
|
+
const BulkAPI = tslib_1.__importStar(require("./bulk.js"));
|
|
30
8
|
const bulk_1 = require("./bulk.js");
|
|
31
|
-
const FeedsAPI = __importStar(require("./feeds.js"));
|
|
9
|
+
const FeedsAPI = tslib_1.__importStar(require("./feeds.js"));
|
|
32
10
|
const feeds_1 = require("./feeds.js");
|
|
33
|
-
const GuidesAPI = __importStar(require("./guides.js"));
|
|
11
|
+
const GuidesAPI = tslib_1.__importStar(require("./guides.js"));
|
|
34
12
|
const guides_1 = require("./guides.js");
|
|
35
13
|
const pagination_1 = require("../../core/pagination.js");
|
|
36
14
|
const path_1 = require("../../internal/utils/path.js");
|
|
@@ -45,6 +23,30 @@ class Users extends resource_1.APIResource {
|
|
|
45
23
|
* Create or update a user with the provided identification data. When you identify
|
|
46
24
|
* an existing user, the system merges the properties you specific with what is
|
|
47
25
|
* currently set on the user, updating only the fields included in your requests.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* const user = await client.users.update('user_id', {
|
|
30
|
+
* channel_data: {
|
|
31
|
+
* '97c5837d-c65c-4d54-aa39-080eeb81c69d': {
|
|
32
|
+
* tokens: ['push_token_123'],
|
|
33
|
+
* },
|
|
34
|
+
* },
|
|
35
|
+
* email: 'ian.malcolm@chaos.theory',
|
|
36
|
+
* name: 'Dr. Ian Malcolm',
|
|
37
|
+
* preferences: {
|
|
38
|
+
* default: {
|
|
39
|
+
* channel_types: { email: true },
|
|
40
|
+
* workflows: {
|
|
41
|
+
* 'dinosaurs-loose': {
|
|
42
|
+
* channel_types: { email: true },
|
|
43
|
+
* },
|
|
44
|
+
* },
|
|
45
|
+
* },
|
|
46
|
+
* },
|
|
47
|
+
* timezone: 'America/New_York',
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
48
50
|
*/
|
|
49
51
|
update(userID, body, options) {
|
|
50
52
|
return this._client.put((0, path_1.path) `/v1/users/${userID}`, { body, ...options });
|
|
@@ -52,24 +54,50 @@ class Users extends resource_1.APIResource {
|
|
|
52
54
|
/**
|
|
53
55
|
* Retrieve a paginated list of users in the environment. Defaults to 50 users per
|
|
54
56
|
* page.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* // Automatically fetches more pages as needed.
|
|
61
|
+
* for await (const user of client.users.list()) {
|
|
62
|
+
* // ...
|
|
63
|
+
* }
|
|
64
|
+
* ```
|
|
55
65
|
*/
|
|
56
66
|
list(query = {}, options) {
|
|
57
67
|
return this._client.getAPIList('/v1/users', (pagination_1.EntriesCursor), { query, ...options });
|
|
58
68
|
}
|
|
59
69
|
/**
|
|
60
70
|
* Permanently delete a user and all associated data.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* const user = await client.users.delete('user_id');
|
|
75
|
+
* ```
|
|
61
76
|
*/
|
|
62
77
|
delete(userID, options) {
|
|
63
78
|
return this._client.delete((0, path_1.path) `/v1/users/${userID}`, options);
|
|
64
79
|
}
|
|
65
80
|
/**
|
|
66
81
|
* Retrieve a specific user by their ID.
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```ts
|
|
85
|
+
* const user = await client.users.get('user_id');
|
|
86
|
+
* ```
|
|
67
87
|
*/
|
|
68
88
|
get(userID, options) {
|
|
69
89
|
return this._client.get((0, path_1.path) `/v1/users/${userID}`, options);
|
|
70
90
|
}
|
|
71
91
|
/**
|
|
72
92
|
* Retrieves the channel data for a specific user and channel ID.
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* const channelData = await client.users.getChannelData(
|
|
97
|
+
* 'user_id',
|
|
98
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
99
|
+
* );
|
|
100
|
+
* ```
|
|
73
101
|
*/
|
|
74
102
|
getChannelData(userID, channelID, options) {
|
|
75
103
|
return this._client.get((0, path_1.path) `/v1/users/${userID}/channel_data/${channelID}`, options);
|
|
@@ -77,6 +105,14 @@ class Users extends resource_1.APIResource {
|
|
|
77
105
|
/**
|
|
78
106
|
* Retrieves a specific preference set for a user identified by the preference set
|
|
79
107
|
* ID.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```ts
|
|
111
|
+
* const preferenceSet = await client.users.getPreferences(
|
|
112
|
+
* 'user_id',
|
|
113
|
+
* 'default',
|
|
114
|
+
* );
|
|
115
|
+
* ```
|
|
80
116
|
*/
|
|
81
117
|
getPreferences(userID, id, query = {}, options) {
|
|
82
118
|
return this._client.get((0, path_1.path) `/v1/users/${userID}/preferences/${id}`, { query, ...options });
|
|
@@ -85,6 +121,16 @@ class Users extends resource_1.APIResource {
|
|
|
85
121
|
* Returns a paginated list of messages for a specific user. Allows filtering by
|
|
86
122
|
* message status and provides various sorting options. Messages outside the
|
|
87
123
|
* account's retention window will not be included in the results.
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```ts
|
|
127
|
+
* // Automatically fetches more pages as needed.
|
|
128
|
+
* for await (const message of client.users.listMessages(
|
|
129
|
+
* 'user-123',
|
|
130
|
+
* )) {
|
|
131
|
+
* // ...
|
|
132
|
+
* }
|
|
133
|
+
* ```
|
|
88
134
|
*/
|
|
89
135
|
listMessages(userID, query = {}, options) {
|
|
90
136
|
return this._client.getAPIList((0, path_1.path) `/v1/users/${userID}/messages`, (pagination_1.EntriesCursor), {
|
|
@@ -94,12 +140,29 @@ class Users extends resource_1.APIResource {
|
|
|
94
140
|
}
|
|
95
141
|
/**
|
|
96
142
|
* Retrieves a list of all preference sets for a specific user.
|
|
143
|
+
*
|
|
144
|
+
* @example
|
|
145
|
+
* ```ts
|
|
146
|
+
* const preferenceSets = await client.users.listPreferences(
|
|
147
|
+
* 'user_id',
|
|
148
|
+
* );
|
|
149
|
+
* ```
|
|
97
150
|
*/
|
|
98
151
|
listPreferences(userID, options) {
|
|
99
152
|
return this._client.get((0, path_1.path) `/v1/users/${userID}/preferences`, options);
|
|
100
153
|
}
|
|
101
154
|
/**
|
|
102
155
|
* Returns a paginated list of schedules for a specific user, in descending order.
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* ```ts
|
|
159
|
+
* // Automatically fetches more pages as needed.
|
|
160
|
+
* for await (const schedule of client.users.listSchedules(
|
|
161
|
+
* 'user_id',
|
|
162
|
+
* )) {
|
|
163
|
+
* // ...
|
|
164
|
+
* }
|
|
165
|
+
* ```
|
|
103
166
|
*/
|
|
104
167
|
listSchedules(userID, query = {}, options) {
|
|
105
168
|
return this._client.getAPIList((0, path_1.path) `/v1/users/${userID}/schedules`, (pagination_1.EntriesCursor), { query, ...options });
|
|
@@ -107,6 +170,16 @@ class Users extends resource_1.APIResource {
|
|
|
107
170
|
/**
|
|
108
171
|
* Retrieves a paginated list of subscriptions for a specific user, in descending
|
|
109
172
|
* order.
|
|
173
|
+
*
|
|
174
|
+
* @example
|
|
175
|
+
* ```ts
|
|
176
|
+
* // Automatically fetches more pages as needed.
|
|
177
|
+
* for await (const subscription of client.users.listSubscriptions(
|
|
178
|
+
* 'user_id',
|
|
179
|
+
* )) {
|
|
180
|
+
* // ...
|
|
181
|
+
* }
|
|
182
|
+
* ```
|
|
110
183
|
*/
|
|
111
184
|
listSubscriptions(userID, query = {}, options) {
|
|
112
185
|
return this._client.getAPIList((0, path_1.path) `/v1/users/${userID}/subscriptions`, (pagination_1.EntriesCursor), { query, ...options });
|
|
@@ -114,12 +187,28 @@ class Users extends resource_1.APIResource {
|
|
|
114
187
|
/**
|
|
115
188
|
* Merge two users together, where the user specified with the `from_user_id` param
|
|
116
189
|
* will be merged into the user specified by `user_id`.
|
|
190
|
+
*
|
|
191
|
+
* @example
|
|
192
|
+
* ```ts
|
|
193
|
+
* const user = await client.users.merge('user_id', {
|
|
194
|
+
* from_user_id: 'user_1',
|
|
195
|
+
* });
|
|
196
|
+
* ```
|
|
117
197
|
*/
|
|
118
198
|
merge(userID, body, options) {
|
|
119
199
|
return this._client.post((0, path_1.path) `/v1/users/${userID}/merge`, { body, ...options });
|
|
120
200
|
}
|
|
121
201
|
/**
|
|
122
202
|
* Updates or creates channel data for a specific user and channel ID.
|
|
203
|
+
*
|
|
204
|
+
* @example
|
|
205
|
+
* ```ts
|
|
206
|
+
* const channelData = await client.users.setChannelData(
|
|
207
|
+
* 'user_id',
|
|
208
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
209
|
+
* { data: { tokens: ['push_token_1'] } },
|
|
210
|
+
* );
|
|
211
|
+
* ```
|
|
123
212
|
*/
|
|
124
213
|
setChannelData(userID, channelID, body, options) {
|
|
125
214
|
return this._client.put((0, path_1.path) `/v1/users/${userID}/channel_data/${channelID}`, { body, ...options });
|
|
@@ -127,12 +216,40 @@ class Users extends resource_1.APIResource {
|
|
|
127
216
|
/**
|
|
128
217
|
* Updates a complete preference set for a user. This is a destructive operation
|
|
129
218
|
* that will replace the existing preference set for the user.
|
|
219
|
+
*
|
|
220
|
+
* @example
|
|
221
|
+
* ```ts
|
|
222
|
+
* const preferenceSet = await client.users.setPreferences(
|
|
223
|
+
* 'user_id',
|
|
224
|
+
* 'default',
|
|
225
|
+
* {
|
|
226
|
+
* categories: {
|
|
227
|
+
* marketing: false,
|
|
228
|
+
* transactional: { channel_types: { email: false } },
|
|
229
|
+
* },
|
|
230
|
+
* channel_types: { email: true },
|
|
231
|
+
* workflows: {
|
|
232
|
+
* 'dinosaurs-loose': {
|
|
233
|
+
* channel_types: { email: false },
|
|
234
|
+
* },
|
|
235
|
+
* },
|
|
236
|
+
* },
|
|
237
|
+
* );
|
|
238
|
+
* ```
|
|
130
239
|
*/
|
|
131
240
|
setPreferences(userID, id, body, options) {
|
|
132
241
|
return this._client.put((0, path_1.path) `/v1/users/${userID}/preferences/${id}`, { body, ...options });
|
|
133
242
|
}
|
|
134
243
|
/**
|
|
135
244
|
* Deletes channel data for a specific user and channel ID.
|
|
245
|
+
*
|
|
246
|
+
* @example
|
|
247
|
+
* ```ts
|
|
248
|
+
* const response = await client.users.unsetChannelData(
|
|
249
|
+
* 'user_id',
|
|
250
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
251
|
+
* );
|
|
252
|
+
* ```
|
|
136
253
|
*/
|
|
137
254
|
unsetChannelData(userID, channelID, options) {
|
|
138
255
|
return this._client.delete((0, path_1.path) `/v1/users/${userID}/channel_data/${channelID}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":";AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAUlD,2DAAkC;AAClC,oCAA8F;AAC9F,6DAAoC;AACpC,sCAMiB;AACjB,+DAAsC;AACtC,wCAUkB;AAElB,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoStD,CAAC;IAlSC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,0BAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,WAAW,EAAE,CAAA,0BAAkC,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAc,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,cAAc,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,MAAc,EACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,aAAa,MAAM,YAAY,EACnC,CAAA,0BAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,MAAc,EACd,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,aAAa,MAAM,gBAAgB,EACvC,CAAA,0BAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAc,EAAE,IAAqB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AAvSD,sBAuSC;AAocD,KAAK,CAAC,KAAK,GAAG,aAAK,CAAC;AACpB,KAAK,CAAC,MAAM,GAAG,eAAM,CAAC;AACtB,KAAK,CAAC,IAAI,GAAG,WAAI,CAAC"}
|
|
@@ -19,6 +19,30 @@ export class Users extends APIResource {
|
|
|
19
19
|
* Create or update a user with the provided identification data. When you identify
|
|
20
20
|
* an existing user, the system merges the properties you specific with what is
|
|
21
21
|
* currently set on the user, updating only the fields included in your requests.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const user = await client.users.update('user_id', {
|
|
26
|
+
* channel_data: {
|
|
27
|
+
* '97c5837d-c65c-4d54-aa39-080eeb81c69d': {
|
|
28
|
+
* tokens: ['push_token_123'],
|
|
29
|
+
* },
|
|
30
|
+
* },
|
|
31
|
+
* email: 'ian.malcolm@chaos.theory',
|
|
32
|
+
* name: 'Dr. Ian Malcolm',
|
|
33
|
+
* preferences: {
|
|
34
|
+
* default: {
|
|
35
|
+
* channel_types: { email: true },
|
|
36
|
+
* workflows: {
|
|
37
|
+
* 'dinosaurs-loose': {
|
|
38
|
+
* channel_types: { email: true },
|
|
39
|
+
* },
|
|
40
|
+
* },
|
|
41
|
+
* },
|
|
42
|
+
* },
|
|
43
|
+
* timezone: 'America/New_York',
|
|
44
|
+
* });
|
|
45
|
+
* ```
|
|
22
46
|
*/
|
|
23
47
|
update(userID, body, options) {
|
|
24
48
|
return this._client.put(path `/v1/users/${userID}`, { body, ...options });
|
|
@@ -26,24 +50,50 @@ export class Users extends APIResource {
|
|
|
26
50
|
/**
|
|
27
51
|
* Retrieve a paginated list of users in the environment. Defaults to 50 users per
|
|
28
52
|
* page.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* // Automatically fetches more pages as needed.
|
|
57
|
+
* for await (const user of client.users.list()) {
|
|
58
|
+
* // ...
|
|
59
|
+
* }
|
|
60
|
+
* ```
|
|
29
61
|
*/
|
|
30
62
|
list(query = {}, options) {
|
|
31
63
|
return this._client.getAPIList('/v1/users', (EntriesCursor), { query, ...options });
|
|
32
64
|
}
|
|
33
65
|
/**
|
|
34
66
|
* Permanently delete a user and all associated data.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const user = await client.users.delete('user_id');
|
|
71
|
+
* ```
|
|
35
72
|
*/
|
|
36
73
|
delete(userID, options) {
|
|
37
74
|
return this._client.delete(path `/v1/users/${userID}`, options);
|
|
38
75
|
}
|
|
39
76
|
/**
|
|
40
77
|
* Retrieve a specific user by their ID.
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```ts
|
|
81
|
+
* const user = await client.users.get('user_id');
|
|
82
|
+
* ```
|
|
41
83
|
*/
|
|
42
84
|
get(userID, options) {
|
|
43
85
|
return this._client.get(path `/v1/users/${userID}`, options);
|
|
44
86
|
}
|
|
45
87
|
/**
|
|
46
88
|
* Retrieves the channel data for a specific user and channel ID.
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* ```ts
|
|
92
|
+
* const channelData = await client.users.getChannelData(
|
|
93
|
+
* 'user_id',
|
|
94
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
95
|
+
* );
|
|
96
|
+
* ```
|
|
47
97
|
*/
|
|
48
98
|
getChannelData(userID, channelID, options) {
|
|
49
99
|
return this._client.get(path `/v1/users/${userID}/channel_data/${channelID}`, options);
|
|
@@ -51,6 +101,14 @@ export class Users extends APIResource {
|
|
|
51
101
|
/**
|
|
52
102
|
* Retrieves a specific preference set for a user identified by the preference set
|
|
53
103
|
* ID.
|
|
104
|
+
*
|
|
105
|
+
* @example
|
|
106
|
+
* ```ts
|
|
107
|
+
* const preferenceSet = await client.users.getPreferences(
|
|
108
|
+
* 'user_id',
|
|
109
|
+
* 'default',
|
|
110
|
+
* );
|
|
111
|
+
* ```
|
|
54
112
|
*/
|
|
55
113
|
getPreferences(userID, id, query = {}, options) {
|
|
56
114
|
return this._client.get(path `/v1/users/${userID}/preferences/${id}`, { query, ...options });
|
|
@@ -59,6 +117,16 @@ export class Users extends APIResource {
|
|
|
59
117
|
* Returns a paginated list of messages for a specific user. Allows filtering by
|
|
60
118
|
* message status and provides various sorting options. Messages outside the
|
|
61
119
|
* account's retention window will not be included in the results.
|
|
120
|
+
*
|
|
121
|
+
* @example
|
|
122
|
+
* ```ts
|
|
123
|
+
* // Automatically fetches more pages as needed.
|
|
124
|
+
* for await (const message of client.users.listMessages(
|
|
125
|
+
* 'user-123',
|
|
126
|
+
* )) {
|
|
127
|
+
* // ...
|
|
128
|
+
* }
|
|
129
|
+
* ```
|
|
62
130
|
*/
|
|
63
131
|
listMessages(userID, query = {}, options) {
|
|
64
132
|
return this._client.getAPIList(path `/v1/users/${userID}/messages`, (EntriesCursor), {
|
|
@@ -68,12 +136,29 @@ export class Users extends APIResource {
|
|
|
68
136
|
}
|
|
69
137
|
/**
|
|
70
138
|
* Retrieves a list of all preference sets for a specific user.
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* ```ts
|
|
142
|
+
* const preferenceSets = await client.users.listPreferences(
|
|
143
|
+
* 'user_id',
|
|
144
|
+
* );
|
|
145
|
+
* ```
|
|
71
146
|
*/
|
|
72
147
|
listPreferences(userID, options) {
|
|
73
148
|
return this._client.get(path `/v1/users/${userID}/preferences`, options);
|
|
74
149
|
}
|
|
75
150
|
/**
|
|
76
151
|
* Returns a paginated list of schedules for a specific user, in descending order.
|
|
152
|
+
*
|
|
153
|
+
* @example
|
|
154
|
+
* ```ts
|
|
155
|
+
* // Automatically fetches more pages as needed.
|
|
156
|
+
* for await (const schedule of client.users.listSchedules(
|
|
157
|
+
* 'user_id',
|
|
158
|
+
* )) {
|
|
159
|
+
* // ...
|
|
160
|
+
* }
|
|
161
|
+
* ```
|
|
77
162
|
*/
|
|
78
163
|
listSchedules(userID, query = {}, options) {
|
|
79
164
|
return this._client.getAPIList(path `/v1/users/${userID}/schedules`, (EntriesCursor), { query, ...options });
|
|
@@ -81,6 +166,16 @@ export class Users extends APIResource {
|
|
|
81
166
|
/**
|
|
82
167
|
* Retrieves a paginated list of subscriptions for a specific user, in descending
|
|
83
168
|
* order.
|
|
169
|
+
*
|
|
170
|
+
* @example
|
|
171
|
+
* ```ts
|
|
172
|
+
* // Automatically fetches more pages as needed.
|
|
173
|
+
* for await (const subscription of client.users.listSubscriptions(
|
|
174
|
+
* 'user_id',
|
|
175
|
+
* )) {
|
|
176
|
+
* // ...
|
|
177
|
+
* }
|
|
178
|
+
* ```
|
|
84
179
|
*/
|
|
85
180
|
listSubscriptions(userID, query = {}, options) {
|
|
86
181
|
return this._client.getAPIList(path `/v1/users/${userID}/subscriptions`, (EntriesCursor), { query, ...options });
|
|
@@ -88,12 +183,28 @@ export class Users extends APIResource {
|
|
|
88
183
|
/**
|
|
89
184
|
* Merge two users together, where the user specified with the `from_user_id` param
|
|
90
185
|
* will be merged into the user specified by `user_id`.
|
|
186
|
+
*
|
|
187
|
+
* @example
|
|
188
|
+
* ```ts
|
|
189
|
+
* const user = await client.users.merge('user_id', {
|
|
190
|
+
* from_user_id: 'user_1',
|
|
191
|
+
* });
|
|
192
|
+
* ```
|
|
91
193
|
*/
|
|
92
194
|
merge(userID, body, options) {
|
|
93
195
|
return this._client.post(path `/v1/users/${userID}/merge`, { body, ...options });
|
|
94
196
|
}
|
|
95
197
|
/**
|
|
96
198
|
* Updates or creates channel data for a specific user and channel ID.
|
|
199
|
+
*
|
|
200
|
+
* @example
|
|
201
|
+
* ```ts
|
|
202
|
+
* const channelData = await client.users.setChannelData(
|
|
203
|
+
* 'user_id',
|
|
204
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
205
|
+
* { data: { tokens: ['push_token_1'] } },
|
|
206
|
+
* );
|
|
207
|
+
* ```
|
|
97
208
|
*/
|
|
98
209
|
setChannelData(userID, channelID, body, options) {
|
|
99
210
|
return this._client.put(path `/v1/users/${userID}/channel_data/${channelID}`, { body, ...options });
|
|
@@ -101,12 +212,40 @@ export class Users extends APIResource {
|
|
|
101
212
|
/**
|
|
102
213
|
* Updates a complete preference set for a user. This is a destructive operation
|
|
103
214
|
* that will replace the existing preference set for the user.
|
|
215
|
+
*
|
|
216
|
+
* @example
|
|
217
|
+
* ```ts
|
|
218
|
+
* const preferenceSet = await client.users.setPreferences(
|
|
219
|
+
* 'user_id',
|
|
220
|
+
* 'default',
|
|
221
|
+
* {
|
|
222
|
+
* categories: {
|
|
223
|
+
* marketing: false,
|
|
224
|
+
* transactional: { channel_types: { email: false } },
|
|
225
|
+
* },
|
|
226
|
+
* channel_types: { email: true },
|
|
227
|
+
* workflows: {
|
|
228
|
+
* 'dinosaurs-loose': {
|
|
229
|
+
* channel_types: { email: false },
|
|
230
|
+
* },
|
|
231
|
+
* },
|
|
232
|
+
* },
|
|
233
|
+
* );
|
|
234
|
+
* ```
|
|
104
235
|
*/
|
|
105
236
|
setPreferences(userID, id, body, options) {
|
|
106
237
|
return this._client.put(path `/v1/users/${userID}/preferences/${id}`, { body, ...options });
|
|
107
238
|
}
|
|
108
239
|
/**
|
|
109
240
|
* Deletes channel data for a specific user and channel ID.
|
|
241
|
+
*
|
|
242
|
+
* @example
|
|
243
|
+
* ```ts
|
|
244
|
+
* const response = await client.users.unsetChannelData(
|
|
245
|
+
* 'user_id',
|
|
246
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
247
|
+
* );
|
|
248
|
+
* ```
|
|
110
249
|
*/
|
|
111
250
|
unsetChannelData(userID, channelID, options) {
|
|
112
251
|
return this._client.delete(path `/v1/users/${userID}/channel_data/${channelID}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAUf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAkE;OACxE,KAAK,QAAQ;OACb,EAKL,KAAK,GACN;OACM,KAAK,SAAS;OACd,EASL,MAAM,GACP;OAEM,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAUf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAkE;OACxE,KAAK,QAAQ;OACb,EAKL,KAAK,GACN;OACM,KAAK,SAAS;OACd,EASL,MAAM,GACP;OAEM,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoStD,CAAC;IAlSC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,aAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,MAAM,WAAW,EAAE,CAAA,aAAkC,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAc,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,cAAc,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,MAAc,EACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,YAAY,EACnC,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,MAAc,EACd,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,gBAAgB,EACvC,CAAA,aAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAc,EAAE,IAAqB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,MAAM,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AAocD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;AACpB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;AACtB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC"}
|
package/resources/users.js
CHANGED
|
@@ -1,19 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
-
if (k2 === undefined) k2 = k;
|
|
5
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
-
}
|
|
9
|
-
Object.defineProperty(o, k2, desc);
|
|
10
|
-
}) : (function(o, m, k, k2) {
|
|
11
|
-
if (k2 === undefined) k2 = k;
|
|
12
|
-
o[k2] = m[k];
|
|
13
|
-
}));
|
|
14
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
-
};
|
|
17
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
|
|
4
|
+
const tslib_1 = require("../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./users/index.js"), exports);
|
|
19
6
|
//# sourceMappingURL=users.js.map
|
package/resources/users.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2DAA8B"}
|
|
@@ -8,6 +8,14 @@ export declare class Workflows extends APIResource {
|
|
|
8
8
|
* When invoked for a workflow using a specific workflow key and cancellation key,
|
|
9
9
|
* will cancel any queued workflow runs associated with that key/cancellation key
|
|
10
10
|
* pair. Can optionally be provided one or more recipients to scope the request to.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const response = await client.workflows.cancel('key', {
|
|
15
|
+
* cancellation_key: 'cancel-workflow-123',
|
|
16
|
+
* recipients: ['jhammond'],
|
|
17
|
+
* });
|
|
18
|
+
* ```
|
|
11
19
|
*/
|
|
12
20
|
cancel(key: string, body: WorkflowCancelParams, options?: RequestOptions): APIPromise<string>;
|
|
13
21
|
/**
|
|
@@ -16,6 +24,28 @@ export declare class Workflows extends APIResource {
|
|
|
16
24
|
* workflow runs are executed asynchronously. This endpoint also handles
|
|
17
25
|
* [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
|
|
18
26
|
* for the `actor`, `recipient`, and `tenant` fields.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const response = await client.workflows.trigger('key', {
|
|
31
|
+
* recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
|
|
32
|
+
* actor: 'mr_dna',
|
|
33
|
+
* cancellation_key: 'isla_nublar_incident_1993',
|
|
34
|
+
* data: {
|
|
35
|
+
* affected_areas: [
|
|
36
|
+
* 'visitor_center',
|
|
37
|
+
* 'raptor_pen',
|
|
38
|
+
* 'trex_paddock',
|
|
39
|
+
* ],
|
|
40
|
+
* attraction_id: 'paddock_rex_01',
|
|
41
|
+
* evacuation_protocol: 'active',
|
|
42
|
+
* message: 'Life finds a way',
|
|
43
|
+
* severity: 'critical',
|
|
44
|
+
* system_status: 'fences_failing',
|
|
45
|
+
* },
|
|
46
|
+
* tenant: 'ingen_isla_nublar',
|
|
47
|
+
* });
|
|
48
|
+
* ```
|
|
19
49
|
*/
|
|
20
50
|
trigger(key: string, body: WorkflowTriggerParams, options?: RequestOptions): APIPromise<WorkflowTriggerResponse>;
|
|
21
51
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflows.d.mts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC
|
|
1
|
+
{"version":3,"file":"workflows.d.mts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|