@knocklabs/node 1.0.0 → 1.1.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 +24 -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 +5 -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/activities.d.mts +10 -0
- package/resources/messages/activities.d.mts.map +1 -1
- package/resources/messages/activities.d.ts +10 -0
- package/resources/messages/activities.d.ts.map +1 -1
- package/resources/messages/activities.js +10 -0
- package/resources/messages/activities.js.map +1 -1
- package/resources/messages/activities.mjs +10 -0
- package/resources/messages/activities.mjs.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/messages.d.mts +101 -0
- package/resources/messages/messages.d.mts.map +1 -1
- package/resources/messages/messages.d.ts +101 -0
- package/resources/messages/messages.d.ts.map +1 -1
- package/resources/messages/messages.js +104 -25
- package/resources/messages/messages.js.map +1 -1
- package/resources/messages/messages.mjs +101 -0
- 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 +175 -4
- package/resources/objects/objects.d.mts.map +1 -1
- package/resources/objects/objects.d.ts +175 -4
- 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/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 +74 -0
- package/resources/schedules/schedules.d.mts.map +1 -1
- package/resources/schedules/schedules.d.ts +74 -0
- 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 +169 -15
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +169 -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/activities.ts +10 -0
- package/src/resources/messages/batch.ts +76 -0
- package/src/resources/messages/messages.ts +101 -0
- package/src/resources/objects/bulk.ts +49 -0
- package/src/resources/objects/objects.ts +175 -4
- package/src/resources/providers/ms-teams.ts +40 -0
- package/src/resources/providers/slack.ts +27 -0
- package/src/resources/schedules/bulk.ts +30 -0
- package/src/resources/schedules/schedules.ts +74 -0
- 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 +172 -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/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
|
@@ -14,6 +14,35 @@ export class Schedules extends APIResource {
|
|
|
14
14
|
* handles
|
|
15
15
|
* [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
|
|
16
16
|
* for the `actor`, `recipient`, and `tenant` fields.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const schedules = await client.schedules.create({
|
|
21
|
+
* recipients: ['user_123'],
|
|
22
|
+
* repeats: [
|
|
23
|
+
* {
|
|
24
|
+
* __typename: 'ScheduleRepeat',
|
|
25
|
+
* day_of_month: null,
|
|
26
|
+
* days: [
|
|
27
|
+
* 'mon',
|
|
28
|
+
* 'tue',
|
|
29
|
+
* 'wed',
|
|
30
|
+
* 'thu',
|
|
31
|
+
* 'fri',
|
|
32
|
+
* 'sat',
|
|
33
|
+
* 'sun',
|
|
34
|
+
* ],
|
|
35
|
+
* frequency: 'daily',
|
|
36
|
+
* hours: null,
|
|
37
|
+
* interval: 1,
|
|
38
|
+
* minutes: null,
|
|
39
|
+
* },
|
|
40
|
+
* ],
|
|
41
|
+
* workflow: 'comment-created',
|
|
42
|
+
* data: { key: 'value' },
|
|
43
|
+
* tenant: 'acme_corp',
|
|
44
|
+
* });
|
|
45
|
+
* ```
|
|
17
46
|
*/
|
|
18
47
|
create(body, options) {
|
|
19
48
|
return this._client.post('/v1/schedules', { body, ...options });
|
|
@@ -24,6 +53,34 @@ export class Schedules extends APIResource {
|
|
|
24
53
|
* This endpoint also handles
|
|
25
54
|
* [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
|
|
26
55
|
* for the `actor`, `recipient`, and `tenant` fields.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const schedules = await client.schedules.update({
|
|
60
|
+
* schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
|
|
61
|
+
* data: { key: 'value' },
|
|
62
|
+
* repeats: [
|
|
63
|
+
* {
|
|
64
|
+
* __typename: 'ScheduleRepeat',
|
|
65
|
+
* day_of_month: null,
|
|
66
|
+
* days: [
|
|
67
|
+
* 'mon',
|
|
68
|
+
* 'tue',
|
|
69
|
+
* 'wed',
|
|
70
|
+
* 'thu',
|
|
71
|
+
* 'fri',
|
|
72
|
+
* 'sat',
|
|
73
|
+
* 'sun',
|
|
74
|
+
* ],
|
|
75
|
+
* frequency: 'daily',
|
|
76
|
+
* hours: null,
|
|
77
|
+
* interval: 1,
|
|
78
|
+
* minutes: null,
|
|
79
|
+
* },
|
|
80
|
+
* ],
|
|
81
|
+
* tenant: 'acme_corp',
|
|
82
|
+
* });
|
|
83
|
+
* ```
|
|
27
84
|
*/
|
|
28
85
|
update(body, options) {
|
|
29
86
|
return this._client.put('/v1/schedules', { body, ...options });
|
|
@@ -31,6 +88,16 @@ export class Schedules extends APIResource {
|
|
|
31
88
|
/**
|
|
32
89
|
* Returns a paginated list of schedules for the current environment, filtered by
|
|
33
90
|
* workflow and optionally by recipients and tenant.
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* ```ts
|
|
94
|
+
* // Automatically fetches more pages as needed.
|
|
95
|
+
* for await (const schedule of client.schedules.list({
|
|
96
|
+
* workflow: 'workflow',
|
|
97
|
+
* })) {
|
|
98
|
+
* // ...
|
|
99
|
+
* }
|
|
100
|
+
* ```
|
|
34
101
|
*/
|
|
35
102
|
list(query, options) {
|
|
36
103
|
return this._client.getAPIList('/v1/schedules', (EntriesCursor), { query, ...options });
|
|
@@ -38,6 +105,13 @@ export class Schedules extends APIResource {
|
|
|
38
105
|
/**
|
|
39
106
|
* Permanently deletes one or more schedules identified by the provided schedule
|
|
40
107
|
* IDs. This operation cannot be undone.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```ts
|
|
111
|
+
* const schedules = await client.schedules.delete({
|
|
112
|
+
* schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
|
|
113
|
+
* });
|
|
114
|
+
* ```
|
|
41
115
|
*/
|
|
42
116
|
delete(body, options) {
|
|
43
117
|
return this._client.delete('/v1/schedules', { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schedules.mjs","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAoB;OAG1B,EAAE,aAAa,EAAyC;AAG/D,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"schedules.mjs","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAoB;OAG1B,EAAE,aAAa,EAAyC;AAG/D,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiHtD,CAAC;IA/GC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAyB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,aAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAkOD,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC"}
|
package/resources/schedules.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("./schedules/index.js"), exports);
|
|
19
6
|
//# sourceMappingURL=schedules.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../src/resources/schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../src/resources/schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,+DAAkC"}
|
|
@@ -6,10 +6,24 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
6
6
|
export declare class Bulk extends APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Delete multiple tenants in a single operation. This operation cannot be undone.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const bulkOperation = await client.tenants.bulk.delete({
|
|
13
|
+
* tenant_ids: ['string'],
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
9
16
|
*/
|
|
10
17
|
delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
11
18
|
/**
|
|
12
19
|
* Set or update up to 1,000 tenants in a single operation.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const bulkOperation = await client.tenants.bulk.set({
|
|
24
|
+
* tenants: ['[object Object]'],
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
13
27
|
*/
|
|
14
28
|
set(body: BulkSetParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
15
29
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC
|
|
1
|
+
{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAKvG;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGhG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAC3F"}
|
|
@@ -6,10 +6,24 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
6
6
|
export declare class Bulk extends APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Delete multiple tenants in a single operation. This operation cannot be undone.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const bulkOperation = await client.tenants.bulk.delete({
|
|
13
|
+
* tenant_ids: ['string'],
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
9
16
|
*/
|
|
10
17
|
delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
11
18
|
/**
|
|
12
19
|
* Set or update up to 1,000 tenants in a single operation.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const bulkOperation = await client.tenants.bulk.set({
|
|
24
|
+
* tenants: ['[object Object]'],
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
13
27
|
*/
|
|
14
28
|
set(body: BulkSetParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
|
|
15
29
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC
|
|
1
|
+
{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAKvG;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGhG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAC3F"}
|
|
@@ -6,6 +6,13 @@ const resource_1 = require("../../core/resource.js");
|
|
|
6
6
|
class Bulk extends resource_1.APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Delete multiple tenants in a single operation. This operation cannot be undone.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const bulkOperation = await client.tenants.bulk.delete({
|
|
13
|
+
* tenant_ids: ['string'],
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
9
16
|
*/
|
|
10
17
|
delete(params, options) {
|
|
11
18
|
const { tenant_ids } = params;
|
|
@@ -13,6 +20,13 @@ class Bulk extends resource_1.APIResource {
|
|
|
13
20
|
}
|
|
14
21
|
/**
|
|
15
22
|
* Set or update up to 1,000 tenants in a single operation.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const bulkOperation = await client.tenants.bulk.set({
|
|
27
|
+
* tenants: ['[object Object]'],
|
|
28
|
+
* });
|
|
29
|
+
* ```
|
|
16
30
|
*/
|
|
17
31
|
set(body, options) {
|
|
18
32
|
return this._client.post('/v1/tenants/bulk/set', { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,MAAa,IAAK,SAAQ,sBAAW;IACnC
|
|
1
|
+
{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA7BD,oBA6BC"}
|
|
@@ -3,6 +3,13 @@ import { APIResource } from "../../core/resource.mjs";
|
|
|
3
3
|
export class Bulk extends APIResource {
|
|
4
4
|
/**
|
|
5
5
|
* Delete multiple tenants in a single operation. This operation cannot be undone.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* const bulkOperation = await client.tenants.bulk.delete({
|
|
10
|
+
* tenant_ids: ['string'],
|
|
11
|
+
* });
|
|
12
|
+
* ```
|
|
6
13
|
*/
|
|
7
14
|
delete(params, options) {
|
|
8
15
|
const { tenant_ids } = params;
|
|
@@ -10,6 +17,13 @@ export class Bulk extends APIResource {
|
|
|
10
17
|
}
|
|
11
18
|
/**
|
|
12
19
|
* Set or update up to 1,000 tenants in a single operation.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const bulkOperation = await client.tenants.bulk.set({
|
|
24
|
+
* tenants: ['[object Object]'],
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
13
27
|
*/
|
|
14
28
|
set(body, options) {
|
|
15
29
|
return this._client.post('/v1/tenants/bulk/set', { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC
|
|
1
|
+
{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/tenants/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAmB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}
|
|
@@ -10,19 +10,52 @@ export declare class Tenants extends APIResource {
|
|
|
10
10
|
bulk: BulkAPI.Bulk;
|
|
11
11
|
/**
|
|
12
12
|
* List tenants for the current environment.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* // Automatically fetches more pages as needed.
|
|
17
|
+
* for await (const tenant of client.tenants.list()) {
|
|
18
|
+
* // ...
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
13
21
|
*/
|
|
14
22
|
list(query?: TenantListParams | null | undefined, options?: RequestOptions): PagePromise<TenantsEntriesCursor, Tenant>;
|
|
15
23
|
/**
|
|
16
24
|
* Delete a tenant and all associated data. This operation cannot be undone.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const tenant = await client.tenants.delete('id');
|
|
29
|
+
* ```
|
|
17
30
|
*/
|
|
18
31
|
delete(id: string, options?: RequestOptions): APIPromise<string>;
|
|
19
32
|
/**
|
|
20
33
|
* Get a tenant by ID.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const tenant = await client.tenants.get('id');
|
|
38
|
+
* ```
|
|
21
39
|
*/
|
|
22
40
|
get(id: string, options?: RequestOptions): APIPromise<Tenant>;
|
|
23
41
|
/**
|
|
24
42
|
* Sets a tenant within an environment, performing an upsert operation. Any
|
|
25
43
|
* existing properties will be merged with the incoming properties.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const tenant = await client.tenants.set('id', {
|
|
48
|
+
* settings: {
|
|
49
|
+
* branding: {
|
|
50
|
+
* icon_url:
|
|
51
|
+
* 'https://example.com/trex_silhouette_icon.png',
|
|
52
|
+
* logo_url: 'https://example.com/amber_fossil_logo.png',
|
|
53
|
+
* primary_color: '#DF1A22',
|
|
54
|
+
* primary_color_contrast: '#FFDE00',
|
|
55
|
+
* },
|
|
56
|
+
* },
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
26
59
|
*/
|
|
27
60
|
set(id: string, body: TenantSetParams, options?: RequestOptions): APIPromise<Tenant>;
|
|
28
61
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tenants.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD
|
|
1
|
+
{"version":3,"file":"tenants.d.mts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7D;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGrF;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzG"}
|
|
@@ -10,19 +10,52 @@ export declare class Tenants extends APIResource {
|
|
|
10
10
|
bulk: BulkAPI.Bulk;
|
|
11
11
|
/**
|
|
12
12
|
* List tenants for the current environment.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* // Automatically fetches more pages as needed.
|
|
17
|
+
* for await (const tenant of client.tenants.list()) {
|
|
18
|
+
* // ...
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
13
21
|
*/
|
|
14
22
|
list(query?: TenantListParams | null | undefined, options?: RequestOptions): PagePromise<TenantsEntriesCursor, Tenant>;
|
|
15
23
|
/**
|
|
16
24
|
* Delete a tenant and all associated data. This operation cannot be undone.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const tenant = await client.tenants.delete('id');
|
|
29
|
+
* ```
|
|
17
30
|
*/
|
|
18
31
|
delete(id: string, options?: RequestOptions): APIPromise<string>;
|
|
19
32
|
/**
|
|
20
33
|
* Get a tenant by ID.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const tenant = await client.tenants.get('id');
|
|
38
|
+
* ```
|
|
21
39
|
*/
|
|
22
40
|
get(id: string, options?: RequestOptions): APIPromise<Tenant>;
|
|
23
41
|
/**
|
|
24
42
|
* Sets a tenant within an environment, performing an upsert operation. Any
|
|
25
43
|
* existing properties will be merged with the incoming properties.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const tenant = await client.tenants.set('id', {
|
|
48
|
+
* settings: {
|
|
49
|
+
* branding: {
|
|
50
|
+
* icon_url:
|
|
51
|
+
* 'https://example.com/trex_silhouette_icon.png',
|
|
52
|
+
* logo_url: 'https://example.com/amber_fossil_logo.png',
|
|
53
|
+
* primary_color: '#DF1A22',
|
|
54
|
+
* primary_color_contrast: '#FFDE00',
|
|
55
|
+
* },
|
|
56
|
+
* },
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
26
59
|
*/
|
|
27
60
|
set(id: string, body: TenantSetParams, options?: RequestOptions): APIPromise<Tenant>;
|
|
28
61
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD
|
|
1
|
+
{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,cAAc;OACnB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE;OACzC,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIhE;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7D;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGrF;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,aAAa,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;IAElC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAC7D;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACxC;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzG"}
|
|
@@ -1,32 +1,10 @@
|
|
|
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.Tenants = 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
9
|
const pagination_1 = require("../../core/pagination.js");
|
|
32
10
|
const path_1 = require("../../internal/utils/path.js");
|
|
@@ -37,18 +15,36 @@ class Tenants extends resource_1.APIResource {
|
|
|
37
15
|
}
|
|
38
16
|
/**
|
|
39
17
|
* List tenants for the current environment.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* // Automatically fetches more pages as needed.
|
|
22
|
+
* for await (const tenant of client.tenants.list()) {
|
|
23
|
+
* // ...
|
|
24
|
+
* }
|
|
25
|
+
* ```
|
|
40
26
|
*/
|
|
41
27
|
list(query = {}, options) {
|
|
42
28
|
return this._client.getAPIList('/v1/tenants', (pagination_1.EntriesCursor), { query, ...options });
|
|
43
29
|
}
|
|
44
30
|
/**
|
|
45
31
|
* Delete a tenant and all associated data. This operation cannot be undone.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const tenant = await client.tenants.delete('id');
|
|
36
|
+
* ```
|
|
46
37
|
*/
|
|
47
38
|
delete(id, options) {
|
|
48
39
|
return this._client.delete((0, path_1.path) `/v1/tenants/${id}`, options);
|
|
49
40
|
}
|
|
50
41
|
/**
|
|
51
42
|
* Get a tenant by ID.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const tenant = await client.tenants.get('id');
|
|
47
|
+
* ```
|
|
52
48
|
*/
|
|
53
49
|
get(id, options) {
|
|
54
50
|
return this._client.get((0, path_1.path) `/v1/tenants/${id}`, options);
|
|
@@ -56,6 +52,21 @@ class Tenants extends resource_1.APIResource {
|
|
|
56
52
|
/**
|
|
57
53
|
* Sets a tenant within an environment, performing an upsert operation. Any
|
|
58
54
|
* existing properties will be merged with the incoming properties.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* const tenant = await client.tenants.set('id', {
|
|
59
|
+
* settings: {
|
|
60
|
+
* branding: {
|
|
61
|
+
* icon_url:
|
|
62
|
+
* 'https://example.com/trex_silhouette_icon.png',
|
|
63
|
+
* logo_url: 'https://example.com/amber_fossil_logo.png',
|
|
64
|
+
* primary_color: '#DF1A22',
|
|
65
|
+
* primary_color_contrast: '#FFDE00',
|
|
66
|
+
* },
|
|
67
|
+
* },
|
|
68
|
+
* });
|
|
69
|
+
* ```
|
|
59
70
|
*/
|
|
60
71
|
set(id, body, options) {
|
|
61
72
|
return this._client.put((0, path_1.path) `/v1/tenants/${id}`, { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,2DAAkC;AAClC,oCAA+D;AAE/D,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkEtD,CAAC;IAhEC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,0BAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAnED,0BAmEC;AA+OD,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC"}
|
|
@@ -11,18 +11,36 @@ export class Tenants extends APIResource {
|
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* List tenants for the current environment.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* // Automatically fetches more pages as needed.
|
|
18
|
+
* for await (const tenant of client.tenants.list()) {
|
|
19
|
+
* // ...
|
|
20
|
+
* }
|
|
21
|
+
* ```
|
|
14
22
|
*/
|
|
15
23
|
list(query = {}, options) {
|
|
16
24
|
return this._client.getAPIList('/v1/tenants', (EntriesCursor), { query, ...options });
|
|
17
25
|
}
|
|
18
26
|
/**
|
|
19
27
|
* Delete a tenant and all associated data. This operation cannot be undone.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const tenant = await client.tenants.delete('id');
|
|
32
|
+
* ```
|
|
20
33
|
*/
|
|
21
34
|
delete(id, options) {
|
|
22
35
|
return this._client.delete(path `/v1/tenants/${id}`, options);
|
|
23
36
|
}
|
|
24
37
|
/**
|
|
25
38
|
* Get a tenant by ID.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const tenant = await client.tenants.get('id');
|
|
43
|
+
* ```
|
|
26
44
|
*/
|
|
27
45
|
get(id, options) {
|
|
28
46
|
return this._client.get(path `/v1/tenants/${id}`, options);
|
|
@@ -30,6 +48,21 @@ export class Tenants extends APIResource {
|
|
|
30
48
|
/**
|
|
31
49
|
* Sets a tenant within an environment, performing an upsert operation. Any
|
|
32
50
|
* existing properties will be merged with the incoming properties.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const tenant = await client.tenants.set('id', {
|
|
55
|
+
* settings: {
|
|
56
|
+
* branding: {
|
|
57
|
+
* icon_url:
|
|
58
|
+
* 'https://example.com/trex_silhouette_icon.png',
|
|
59
|
+
* logo_url: 'https://example.com/amber_fossil_logo.png',
|
|
60
|
+
* primary_color: '#DF1A22',
|
|
61
|
+
* primary_color_contrast: '#FFDE00',
|
|
62
|
+
* },
|
|
63
|
+
* },
|
|
64
|
+
* });
|
|
65
|
+
* ```
|
|
33
66
|
*/
|
|
34
67
|
set(id, body, options) {
|
|
35
68
|
return this._client.put(path `/v1/tenants/${id}`, { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAmC;OAEzC,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAmC;OAEzC,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkEtD,CAAC;IAhEC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,aAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA+OD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC"}
|
package/resources/tenants.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("./tenants/index.js"), exports);
|
|
19
6
|
//# sourceMappingURL=tenants.js.map
|
package/resources/tenants.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6DAAgC"}
|