@trycourier/courier 7.20.0 → 7.22.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/client.d.mts +57 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +57 -3
- package/client.d.ts.map +1 -1
- package/client.js +57 -3
- package/client.js.map +1 -1
- package/client.mjs +57 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/audiences.d.mts +13 -5
- package/resources/audiences.d.mts.map +1 -1
- package/resources/audiences.d.ts +13 -5
- package/resources/audiences.d.ts.map +1 -1
- package/resources/audiences.js +13 -5
- package/resources/audiences.js.map +1 -1
- package/resources/audiences.mjs +13 -5
- package/resources/audiences.mjs.map +1 -1
- package/resources/audit-events.d.mts +7 -2
- package/resources/audit-events.d.mts.map +1 -1
- package/resources/audit-events.d.ts +7 -2
- package/resources/audit-events.d.ts.map +1 -1
- package/resources/audit-events.js +7 -2
- package/resources/audit-events.js.map +1 -1
- package/resources/audit-events.mjs +7 -2
- package/resources/audit-events.mjs.map +1 -1
- package/resources/auth.d.mts +5 -1
- package/resources/auth.d.mts.map +1 -1
- package/resources/auth.d.ts +5 -1
- package/resources/auth.d.ts.map +1 -1
- package/resources/auth.js +5 -1
- package/resources/auth.js.map +1 -1
- package/resources/auth.mjs +5 -1
- package/resources/auth.mjs.map +1 -1
- package/resources/automations/automations.d.mts +5 -1
- package/resources/automations/automations.d.mts.map +1 -1
- package/resources/automations/automations.d.ts +5 -1
- package/resources/automations/automations.d.ts.map +1 -1
- package/resources/automations/automations.js +5 -1
- package/resources/automations/automations.js.map +1 -1
- package/resources/automations/automations.mjs +5 -1
- package/resources/automations/automations.mjs.map +1 -1
- package/resources/automations/invoke.d.mts +74 -7
- package/resources/automations/invoke.d.mts.map +1 -1
- package/resources/automations/invoke.d.ts +74 -7
- package/resources/automations/invoke.d.ts.map +1 -1
- package/resources/automations/invoke.js +38 -9
- package/resources/automations/invoke.js.map +1 -1
- package/resources/automations/invoke.mjs +38 -9
- package/resources/automations/invoke.mjs.map +1 -1
- package/resources/brands.d.mts +42 -7
- package/resources/brands.d.mts.map +1 -1
- package/resources/brands.d.ts +42 -7
- package/resources/brands.d.ts.map +1 -1
- package/resources/brands.js +28 -8
- package/resources/brands.js.map +1 -1
- package/resources/brands.mjs +28 -8
- package/resources/brands.mjs.map +1 -1
- package/resources/digests/schedules.d.mts +5 -3
- package/resources/digests/schedules.d.mts.map +1 -1
- package/resources/digests/schedules.d.ts +5 -3
- package/resources/digests/schedules.d.ts.map +1 -1
- package/resources/digests/schedules.js +5 -3
- package/resources/digests/schedules.js.map +1 -1
- package/resources/digests/schedules.mjs +5 -3
- package/resources/digests/schedules.mjs.map +1 -1
- package/resources/inbound.d.mts +5 -1
- package/resources/inbound.d.mts.map +1 -1
- package/resources/inbound.d.ts +5 -1
- package/resources/inbound.d.ts.map +1 -1
- package/resources/inbound.js +5 -1
- package/resources/inbound.js.map +1 -1
- package/resources/inbound.mjs +5 -1
- package/resources/inbound.mjs.map +1 -1
- package/resources/inbox/inbox.d.mts +10 -0
- package/resources/inbox/inbox.d.mts.map +1 -0
- package/resources/inbox/inbox.d.ts +10 -0
- package/resources/inbox/inbox.d.ts.map +1 -0
- package/resources/inbox/inbox.js +17 -0
- package/resources/inbox/inbox.js.map +1 -0
- package/resources/inbox/inbox.mjs +12 -0
- package/resources/inbox/inbox.mjs.map +1 -0
- package/resources/inbox/index.d.mts +3 -0
- package/resources/inbox/index.d.mts.map +1 -0
- package/resources/inbox/index.d.ts +3 -0
- package/resources/inbox/index.d.ts.map +1 -0
- package/resources/inbox/index.js +9 -0
- package/resources/inbox/index.js.map +1 -0
- package/resources/inbox/index.mjs +4 -0
- package/resources/inbox/index.mjs.map +1 -0
- package/resources/inbox/messages.d.mts +23 -0
- package/resources/inbox/messages.d.mts.map +1 -0
- package/resources/inbox/messages.d.ts +23 -0
- package/resources/inbox/messages.d.ts.map +1 -0
- package/resources/inbox/messages.js +34 -0
- package/resources/inbox/messages.js.map +1 -0
- package/resources/inbox/messages.mjs +30 -0
- package/resources/inbox/messages.mjs.map +1 -0
- package/resources/inbox.d.mts +2 -0
- package/resources/inbox.d.mts.map +1 -0
- package/resources/inbox.d.ts +2 -0
- package/resources/inbox.d.ts.map +1 -0
- package/resources/inbox.js +6 -0
- package/resources/inbox.js.map +1 -0
- package/resources/inbox.mjs +3 -0
- package/resources/inbox.mjs.map +1 -0
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/journeys/journeys.d.mts +130 -39
- package/resources/journeys/journeys.d.mts.map +1 -1
- package/resources/journeys/journeys.d.ts +130 -39
- package/resources/journeys/journeys.d.ts.map +1 -1
- package/resources/journeys/journeys.js +79 -34
- package/resources/journeys/journeys.js.map +1 -1
- package/resources/journeys/journeys.mjs +79 -34
- package/resources/journeys/journeys.mjs.map +1 -1
- package/resources/journeys/templates.d.mts +60 -17
- package/resources/journeys/templates.d.mts.map +1 -1
- package/resources/journeys/templates.d.ts +60 -17
- package/resources/journeys/templates.d.ts.map +1 -1
- package/resources/journeys/templates.js +41 -20
- package/resources/journeys/templates.js.map +1 -1
- package/resources/journeys/templates.mjs +41 -20
- package/resources/journeys/templates.mjs.map +1 -1
- package/resources/lists/lists.d.mts +40 -5
- package/resources/lists/lists.d.mts.map +1 -1
- package/resources/lists/lists.d.ts +40 -5
- package/resources/lists/lists.d.ts.map +1 -1
- package/resources/lists/lists.js +40 -5
- package/resources/lists/lists.js.map +1 -1
- package/resources/lists/lists.mjs +40 -5
- package/resources/lists/lists.mjs.map +1 -1
- package/resources/lists/subscriptions.d.mts +65 -5
- package/resources/lists/subscriptions.d.mts.map +1 -1
- package/resources/lists/subscriptions.d.ts +65 -5
- package/resources/lists/subscriptions.d.ts.map +1 -1
- package/resources/lists/subscriptions.js +57 -6
- package/resources/lists/subscriptions.js.map +1 -1
- package/resources/lists/subscriptions.mjs +57 -6
- package/resources/lists/subscriptions.mjs.map +1 -1
- package/resources/messages.d.mts +15 -14
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +15 -14
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +15 -14
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +15 -14
- package/resources/messages.mjs.map +1 -1
- package/resources/notifications/checks.d.mts +9 -3
- package/resources/notifications/checks.d.mts.map +1 -1
- package/resources/notifications/checks.d.ts +9 -3
- package/resources/notifications/checks.d.ts.map +1 -1
- package/resources/notifications/checks.js +9 -3
- package/resources/notifications/checks.js.map +1 -1
- package/resources/notifications/checks.mjs +9 -3
- package/resources/notifications/checks.mjs.map +1 -1
- package/resources/notifications/notifications.d.mts +62 -29
- package/resources/notifications/notifications.d.mts.map +1 -1
- package/resources/notifications/notifications.d.ts +62 -29
- package/resources/notifications/notifications.d.ts.map +1 -1
- package/resources/notifications/notifications.js +49 -26
- package/resources/notifications/notifications.js.map +1 -1
- package/resources/notifications/notifications.mjs +49 -26
- package/resources/notifications/notifications.mjs.map +1 -1
- package/resources/profiles/lists.d.mts +49 -5
- package/resources/profiles/lists.d.mts.map +1 -1
- package/resources/profiles/lists.d.ts +49 -5
- package/resources/profiles/lists.d.ts.map +1 -1
- package/resources/profiles/lists.js +45 -6
- package/resources/profiles/lists.js.map +1 -1
- package/resources/profiles/lists.mjs +45 -6
- package/resources/profiles/lists.mjs.map +1 -1
- package/resources/profiles/profiles.d.mts +70 -11
- package/resources/profiles/profiles.d.mts.map +1 -1
- package/resources/profiles/profiles.d.ts +70 -11
- package/resources/profiles/profiles.d.ts.map +1 -1
- package/resources/profiles/profiles.js +65 -12
- package/resources/profiles/profiles.js.map +1 -1
- package/resources/profiles/profiles.mjs +65 -12
- package/resources/profiles/profiles.mjs.map +1 -1
- package/resources/providers/catalog.d.mts +10 -4
- package/resources/providers/catalog.d.mts.map +1 -1
- package/resources/providers/catalog.d.ts +10 -4
- package/resources/providers/catalog.d.ts.map +1 -1
- package/resources/providers/catalog.js +10 -4
- package/resources/providers/catalog.js.map +1 -1
- package/resources/providers/catalog.mjs +10 -4
- package/resources/providers/catalog.mjs.map +1 -1
- package/resources/providers/providers.d.mts +68 -22
- package/resources/providers/providers.d.mts.map +1 -1
- package/resources/providers/providers.d.ts +68 -22
- package/resources/providers/providers.d.ts.map +1 -1
- package/resources/providers/providers.js +57 -14
- package/resources/providers/providers.js.map +1 -1
- package/resources/providers/providers.mjs +57 -14
- package/resources/providers/providers.mjs.map +1 -1
- package/resources/requests.d.mts +5 -1
- package/resources/requests.d.mts.map +1 -1
- package/resources/requests.d.ts +5 -1
- package/resources/requests.d.ts.map +1 -1
- package/resources/requests.js +5 -1
- package/resources/requests.js.map +1 -1
- package/resources/requests.mjs +5 -1
- package/resources/requests.mjs.map +1 -1
- package/resources/routing-strategies.d.mts +30 -11
- package/resources/routing-strategies.d.mts.map +1 -1
- package/resources/routing-strategies.d.ts +30 -11
- package/resources/routing-strategies.d.ts.map +1 -1
- package/resources/routing-strategies.js +22 -6
- package/resources/routing-strategies.js.map +1 -1
- package/resources/routing-strategies.mjs +22 -6
- package/resources/routing-strategies.mjs.map +1 -1
- package/resources/send.d.mts +24 -4
- package/resources/send.d.mts.map +1 -1
- package/resources/send.d.ts +24 -4
- package/resources/send.d.ts.map +1 -1
- package/resources/send.js +21 -3
- package/resources/send.js.map +1 -1
- package/resources/send.mjs +21 -3
- package/resources/send.mjs.map +1 -1
- package/resources/tenants/preferences/items.d.mts +7 -2
- package/resources/tenants/preferences/items.d.mts.map +1 -1
- package/resources/tenants/preferences/items.d.ts +7 -2
- package/resources/tenants/preferences/items.d.ts.map +1 -1
- package/resources/tenants/preferences/items.js +7 -2
- package/resources/tenants/preferences/items.js.map +1 -1
- package/resources/tenants/preferences/items.mjs +7 -2
- package/resources/tenants/preferences/items.mjs.map +1 -1
- package/resources/tenants/templates/templates.d.mts +13 -19
- package/resources/tenants/templates/templates.d.mts.map +1 -1
- package/resources/tenants/templates/templates.d.ts +13 -19
- package/resources/tenants/templates/templates.d.ts.map +1 -1
- package/resources/tenants/templates/templates.js +13 -19
- package/resources/tenants/templates/templates.js.map +1 -1
- package/resources/tenants/templates/templates.mjs +13 -19
- package/resources/tenants/templates/templates.mjs.map +1 -1
- package/resources/tenants/templates/versions.d.mts +5 -7
- package/resources/tenants/templates/versions.d.mts.map +1 -1
- package/resources/tenants/templates/versions.d.ts +5 -7
- package/resources/tenants/templates/versions.d.ts.map +1 -1
- package/resources/tenants/templates/versions.js +5 -7
- package/resources/tenants/templates/versions.js.map +1 -1
- package/resources/tenants/templates/versions.mjs +5 -7
- package/resources/tenants/templates/versions.mjs.map +1 -1
- package/resources/tenants/tenants.d.mts +13 -5
- package/resources/tenants/tenants.d.mts.map +1 -1
- package/resources/tenants/tenants.d.ts +13 -5
- package/resources/tenants/tenants.d.ts.map +1 -1
- package/resources/tenants/tenants.js +13 -5
- package/resources/tenants/tenants.js.map +1 -1
- package/resources/tenants/tenants.mjs +13 -5
- package/resources/tenants/tenants.mjs.map +1 -1
- package/resources/translations.d.mts +7 -2
- package/resources/translations.d.mts.map +1 -1
- package/resources/translations.d.ts +7 -2
- package/resources/translations.d.ts.map +1 -1
- package/resources/translations.js +7 -2
- package/resources/translations.js.map +1 -1
- package/resources/translations.mjs +7 -2
- package/resources/translations.mjs.map +1 -1
- package/resources/users/preferences.d.mts +64 -42
- package/resources/users/preferences.d.mts.map +1 -1
- package/resources/users/preferences.d.ts +64 -42
- package/resources/users/preferences.d.ts.map +1 -1
- package/resources/users/preferences.js +30 -42
- package/resources/users/preferences.js.map +1 -1
- package/resources/users/preferences.mjs +30 -42
- package/resources/users/preferences.mjs.map +1 -1
- package/resources/users/tenants.d.mts +13 -10
- package/resources/users/tenants.d.mts.map +1 -1
- package/resources/users/tenants.d.ts +13 -10
- package/resources/users/tenants.d.ts.map +1 -1
- package/resources/users/tenants.js +13 -10
- package/resources/users/tenants.js.map +1 -1
- package/resources/users/tenants.mjs +13 -10
- package/resources/users/tenants.mjs.map +1 -1
- package/resources/users/tokens.d.mts +15 -6
- package/resources/users/tokens.d.mts.map +1 -1
- package/resources/users/tokens.d.ts +15 -6
- package/resources/users/tokens.d.ts.map +1 -1
- package/resources/users/tokens.js +15 -6
- package/resources/users/tokens.js.map +1 -1
- package/resources/users/tokens.mjs +15 -6
- package/resources/users/tokens.mjs.map +1 -1
- package/resources/workspace-preferences/topics.d.mts +40 -18
- package/resources/workspace-preferences/topics.d.mts.map +1 -1
- package/resources/workspace-preferences/topics.d.ts +40 -18
- package/resources/workspace-preferences/topics.d.ts.map +1 -1
- package/resources/workspace-preferences/topics.js +26 -11
- package/resources/workspace-preferences/topics.js.map +1 -1
- package/resources/workspace-preferences/topics.mjs +26 -11
- package/resources/workspace-preferences/topics.mjs.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.d.mts +56 -19
- package/resources/workspace-preferences/workspace-preferences.d.mts.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.d.ts +56 -19
- package/resources/workspace-preferences/workspace-preferences.d.ts.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.js +41 -13
- package/resources/workspace-preferences/workspace-preferences.js.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.mjs +41 -13
- package/resources/workspace-preferences/workspace-preferences.mjs.map +1 -1
- package/src/client.ts +59 -25
- package/src/resources/audiences.ts +13 -5
- package/src/resources/audit-events.ts +7 -2
- package/src/resources/auth.ts +5 -1
- package/src/resources/automations/automations.ts +5 -1
- package/src/resources/automations/invoke.ts +115 -9
- package/src/resources/brands.ts +62 -8
- package/src/resources/digests/schedules.ts +5 -3
- package/src/resources/inbound.ts +5 -1
- package/src/resources/inbox/inbox.ts +15 -0
- package/src/resources/inbox/index.ts +4 -0
- package/src/resources/inbox/messages.ts +40 -0
- package/src/resources/inbox.ts +3 -0
- package/src/resources/index.ts +1 -11
- package/src/resources/journeys/journeys.ts +212 -43
- package/src/resources/journeys/templates.ts +98 -20
- package/src/resources/lists/lists.ts +40 -5
- package/src/resources/lists/subscriptions.ts +82 -6
- package/src/resources/messages.ts +15 -14
- package/src/resources/notifications/checks.ts +9 -3
- package/src/resources/notifications/notifications.ts +102 -31
- package/src/resources/profiles/lists.ts +70 -6
- package/src/resources/profiles/profiles.ts +90 -12
- package/src/resources/providers/catalog.ts +10 -4
- package/src/resources/providers/providers.ts +86 -21
- package/src/resources/requests.ts +5 -1
- package/src/resources/routing-strategies.ts +50 -12
- package/src/resources/send.ts +45 -5
- package/src/resources/tenants/preferences/items.ts +7 -2
- package/src/resources/tenants/templates/templates.ts +13 -19
- package/src/resources/tenants/templates/versions.ts +5 -7
- package/src/resources/tenants/tenants.ts +13 -5
- package/src/resources/translations.ts +7 -2
- package/src/resources/users/preferences.ts +86 -44
- package/src/resources/users/tenants.ts +13 -10
- package/src/resources/users/tokens.ts +15 -6
- package/src/resources/workspace-preferences/topics.ts +60 -19
- package/src/resources/workspace-preferences/workspace-preferences.ts +96 -21
- package/src/version.ts +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/resources/bulk.d.mts +0 -155
- package/resources/bulk.d.mts.map +0 -1
- package/resources/bulk.d.ts +0 -155
- package/resources/bulk.d.ts.map +0 -1
- package/resources/bulk.js +0 -58
- package/resources/bulk.js.map +0 -1
- package/resources/bulk.mjs +0 -54
- package/resources/bulk.mjs.map +0 -1
- package/src/resources/bulk.ts +0 -210
|
@@ -2,11 +2,13 @@
|
|
|
2
2
|
import { APIResource } from "../../core/resource.mjs";
|
|
3
3
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
4
|
import { path } from "../../internal/utils/path.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
|
|
7
|
+
*/
|
|
5
8
|
export class Topics extends APIResource {
|
|
6
9
|
/**
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* returned.
|
|
10
|
+
* Creates a subscription topic inside a workspace preference. The default status
|
|
11
|
+
* sets whether users start opted in, opted out, or required.
|
|
10
12
|
*
|
|
11
13
|
* @example
|
|
12
14
|
* ```ts
|
|
@@ -17,13 +19,25 @@ export class Topics extends APIResource {
|
|
|
17
19
|
* );
|
|
18
20
|
* ```
|
|
19
21
|
*/
|
|
20
|
-
create(sectionID,
|
|
21
|
-
|
|
22
|
+
create(sectionID, params, options) {
|
|
23
|
+
const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
|
|
24
|
+
return this._client.post(path `/preferences/sections/${sectionID}/topics`, {
|
|
25
|
+
body,
|
|
26
|
+
...options,
|
|
27
|
+
headers: buildHeaders([
|
|
28
|
+
{
|
|
29
|
+
...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
|
|
30
|
+
...(xIdempotencyExpiration != null ?
|
|
31
|
+
{ 'x-idempotency-expiration': xIdempotencyExpiration }
|
|
32
|
+
: undefined),
|
|
33
|
+
},
|
|
34
|
+
options?.headers,
|
|
35
|
+
]),
|
|
36
|
+
});
|
|
22
37
|
}
|
|
23
38
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* different workspace preference.
|
|
39
|
+
* Returns one subscription topic with its default status, routing options, allowed
|
|
40
|
+
* preferences, and unsubscribe header setting.
|
|
27
41
|
*
|
|
28
42
|
* @example
|
|
29
43
|
* ```ts
|
|
@@ -39,7 +53,8 @@ export class Topics extends APIResource {
|
|
|
39
53
|
return this._client.get(path `/preferences/sections/${section_id}/topics/${topicID}`, options);
|
|
40
54
|
}
|
|
41
55
|
/**
|
|
42
|
-
*
|
|
56
|
+
* Returns the subscription topics inside a workspace preference, each with its
|
|
57
|
+
* default status and routing options.
|
|
43
58
|
*
|
|
44
59
|
* @example
|
|
45
60
|
* ```ts
|
|
@@ -53,8 +68,8 @@ export class Topics extends APIResource {
|
|
|
53
68
|
return this._client.get(path `/preferences/sections/${sectionID}/topics`, options);
|
|
54
69
|
}
|
|
55
70
|
/**
|
|
56
|
-
*
|
|
57
|
-
*
|
|
71
|
+
* Archives a subscription topic and removes it from its workspace preference,
|
|
72
|
+
* addressed by section id and topic id.
|
|
58
73
|
*
|
|
59
74
|
* @example
|
|
60
75
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topics.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"topics.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAyB,EACzB,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,SAAS,SAAS,EAAE;YACxE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,SAAS,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAe,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACtF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CACL,OAAe,EACf,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -4,12 +4,14 @@ import * as TopicsAPI from "./topics.mjs";
|
|
|
4
4
|
import { TopicArchiveParams, TopicCreateParams, TopicReplaceParams, TopicRetrieveParams, Topics } from "./topics.mjs";
|
|
5
5
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
6
6
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
/**
|
|
8
|
+
* Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
|
|
9
|
+
*/
|
|
7
10
|
export declare class WorkspacePreferences extends APIResource {
|
|
8
11
|
topics: TopicsAPI.Topics;
|
|
9
12
|
/**
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
* /preferences/sections/{section_id}/topics.
|
|
13
|
+
* Creates a workspace preference and returns its generated id. Add subscription
|
|
14
|
+
* topics to it afterwards with the topics endpoint.
|
|
13
15
|
*
|
|
14
16
|
* @example
|
|
15
17
|
* ```ts
|
|
@@ -19,9 +21,10 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
19
21
|
* });
|
|
20
22
|
* ```
|
|
21
23
|
*/
|
|
22
|
-
create(
|
|
24
|
+
create(params: WorkspacePreferenceCreateParams, options?: RequestOptions): APIPromise<WorkspacePreferenceGetResponse>;
|
|
23
25
|
/**
|
|
24
|
-
*
|
|
26
|
+
* Returns one workspace preference by id, including its subscription topics,
|
|
27
|
+
* routing options, and custom routing flag.
|
|
25
28
|
*
|
|
26
29
|
* @example
|
|
27
30
|
* ```ts
|
|
@@ -31,8 +34,8 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
31
34
|
*/
|
|
32
35
|
retrieve(sectionID: string, options?: RequestOptions): APIPromise<WorkspacePreferenceGetResponse>;
|
|
33
36
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
37
|
+
* Returns the workspace's preferences, each embedding its subscription topics,
|
|
38
|
+
* routing options, and whether custom routing is allowed.
|
|
36
39
|
*
|
|
37
40
|
* @example
|
|
38
41
|
* ```ts
|
|
@@ -52,9 +55,8 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
52
55
|
*/
|
|
53
56
|
archive(sectionID: string, options?: RequestOptions): APIPromise<void>;
|
|
54
57
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* state visible on the hosted preferences page (non-draft).
|
|
58
|
+
* Publishes the workspace preference page, snapshotting every preference and
|
|
59
|
+
* topic, and returns the page id and a preview URL.
|
|
58
60
|
*
|
|
59
61
|
* @example
|
|
60
62
|
* ```ts
|
|
@@ -62,7 +64,7 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
62
64
|
* await client.workspacePreferences.publish();
|
|
63
65
|
* ```
|
|
64
66
|
*/
|
|
65
|
-
publish(
|
|
67
|
+
publish(params?: WorkspacePreferencePublishParams | null | undefined, options?: RequestOptions): APIPromise<PublishPreferencesResponse>;
|
|
66
68
|
/**
|
|
67
69
|
* Replace a workspace preference. Full document replacement; missing optional
|
|
68
70
|
* fields are cleared. Topics attached to the workspace preference are unaffected.
|
|
@@ -353,36 +355,71 @@ export interface WorkspacePreferenceTopicReplaceRequest {
|
|
|
353
355
|
}
|
|
354
356
|
export interface WorkspacePreferenceCreateParams {
|
|
355
357
|
/**
|
|
356
|
-
* Human-readable name for the workspace preference.
|
|
358
|
+
* Body param: Human-readable name for the workspace preference.
|
|
357
359
|
*/
|
|
358
360
|
name: string;
|
|
359
361
|
/**
|
|
360
|
-
* Optional description shown under the section on the hosted
|
|
362
|
+
* Body param: Optional description shown under the section on the hosted
|
|
363
|
+
* preferences page.
|
|
361
364
|
*/
|
|
362
365
|
description?: string | null;
|
|
363
366
|
/**
|
|
364
|
-
* Whether the workspace preference defines custom routing for its
|
|
367
|
+
* Body param: Whether the workspace preference defines custom routing for its
|
|
368
|
+
* topics.
|
|
365
369
|
*/
|
|
366
370
|
has_custom_routing?: boolean | null;
|
|
367
371
|
/**
|
|
368
|
-
* Default channels for the workspace preference. Defaults to empty if
|
|
372
|
+
* Body param: Default channels for the workspace preference. Defaults to empty if
|
|
373
|
+
* omitted.
|
|
369
374
|
*/
|
|
370
375
|
routing_options?: Array<Shared.ChannelClassification> | null;
|
|
376
|
+
/**
|
|
377
|
+
* Header param: A unique key that makes this request idempotent. If Courier
|
|
378
|
+
* receives another request with the same `Idempotency-Key`, it returns the stored
|
|
379
|
+
* response from the first request without performing the operation again
|
|
380
|
+
* (including the original status code and any error). Use it to safely retry
|
|
381
|
+
* `POST` requests after network failures without risking duplicate sends. The key
|
|
382
|
+
* is scoped to this endpoint.
|
|
383
|
+
*/
|
|
384
|
+
'Idempotency-Key'?: string;
|
|
385
|
+
/**
|
|
386
|
+
* Header param: How long the idempotency key remains valid, as a Unix epoch
|
|
387
|
+
* timestamp in seconds or an ISO 8601 date string. Only applies when
|
|
388
|
+
* `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
|
|
389
|
+
* maximum is 1 year.
|
|
390
|
+
*/
|
|
391
|
+
'x-idempotency-expiration'?: string;
|
|
371
392
|
}
|
|
372
393
|
export interface WorkspacePreferencePublishParams {
|
|
373
394
|
/**
|
|
374
|
-
* Brand for the hosted page - "default" (workspace default brand),
|
|
375
|
-
* brand), or a specific brand id. Defaults to "default".
|
|
395
|
+
* Body param: Brand for the hosted page - "default" (workspace default brand),
|
|
396
|
+
* "none" (no brand), or a specific brand id. Defaults to "default".
|
|
376
397
|
*/
|
|
377
398
|
brand_id?: string | null;
|
|
378
399
|
/**
|
|
379
|
-
* Description shown under the heading on the hosted preferences page.
|
|
400
|
+
* Body param: Description shown under the heading on the hosted preferences page.
|
|
380
401
|
*/
|
|
381
402
|
description?: string | null;
|
|
382
403
|
/**
|
|
383
|
-
* Heading shown at the top of the hosted preferences page.
|
|
404
|
+
* Body param: Heading shown at the top of the hosted preferences page.
|
|
384
405
|
*/
|
|
385
406
|
heading?: string | null;
|
|
407
|
+
/**
|
|
408
|
+
* Header param: A unique key that makes this request idempotent. If Courier
|
|
409
|
+
* receives another request with the same `Idempotency-Key`, it returns the stored
|
|
410
|
+
* response from the first request without performing the operation again
|
|
411
|
+
* (including the original status code and any error). Use it to safely retry
|
|
412
|
+
* `POST` requests after network failures without risking duplicate sends. The key
|
|
413
|
+
* is scoped to this endpoint.
|
|
414
|
+
*/
|
|
415
|
+
'Idempotency-Key'?: string;
|
|
416
|
+
/**
|
|
417
|
+
* Header param: How long the idempotency key remains valid, as a Unix epoch
|
|
418
|
+
* timestamp in seconds or an ISO 8601 date string. Only applies when
|
|
419
|
+
* `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
|
|
420
|
+
* maximum is 1 year.
|
|
421
|
+
*/
|
|
422
|
+
'x-idempotency-expiration'?: string;
|
|
386
423
|
}
|
|
387
424
|
export interface WorkspacePreferenceReplaceParams {
|
|
388
425
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace-preferences.d.mts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,qBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D
|
|
1
|
+
{"version":3,"file":"workspace-preferences.d.mts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,qBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;OASG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAC;IAE7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,OAAO,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -4,12 +4,14 @@ import * as TopicsAPI from "./topics.js";
|
|
|
4
4
|
import { TopicArchiveParams, TopicCreateParams, TopicReplaceParams, TopicRetrieveParams, Topics } from "./topics.js";
|
|
5
5
|
import { APIPromise } from "../../core/api-promise.js";
|
|
6
6
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
7
|
+
/**
|
|
8
|
+
* Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
|
|
9
|
+
*/
|
|
7
10
|
export declare class WorkspacePreferences extends APIResource {
|
|
8
11
|
topics: TopicsAPI.Topics;
|
|
9
12
|
/**
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
* /preferences/sections/{section_id}/topics.
|
|
13
|
+
* Creates a workspace preference and returns its generated id. Add subscription
|
|
14
|
+
* topics to it afterwards with the topics endpoint.
|
|
13
15
|
*
|
|
14
16
|
* @example
|
|
15
17
|
* ```ts
|
|
@@ -19,9 +21,10 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
19
21
|
* });
|
|
20
22
|
* ```
|
|
21
23
|
*/
|
|
22
|
-
create(
|
|
24
|
+
create(params: WorkspacePreferenceCreateParams, options?: RequestOptions): APIPromise<WorkspacePreferenceGetResponse>;
|
|
23
25
|
/**
|
|
24
|
-
*
|
|
26
|
+
* Returns one workspace preference by id, including its subscription topics,
|
|
27
|
+
* routing options, and custom routing flag.
|
|
25
28
|
*
|
|
26
29
|
* @example
|
|
27
30
|
* ```ts
|
|
@@ -31,8 +34,8 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
31
34
|
*/
|
|
32
35
|
retrieve(sectionID: string, options?: RequestOptions): APIPromise<WorkspacePreferenceGetResponse>;
|
|
33
36
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
37
|
+
* Returns the workspace's preferences, each embedding its subscription topics,
|
|
38
|
+
* routing options, and whether custom routing is allowed.
|
|
36
39
|
*
|
|
37
40
|
* @example
|
|
38
41
|
* ```ts
|
|
@@ -52,9 +55,8 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
52
55
|
*/
|
|
53
56
|
archive(sectionID: string, options?: RequestOptions): APIPromise<void>;
|
|
54
57
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* state visible on the hosted preferences page (non-draft).
|
|
58
|
+
* Publishes the workspace preference page, snapshotting every preference and
|
|
59
|
+
* topic, and returns the page id and a preview URL.
|
|
58
60
|
*
|
|
59
61
|
* @example
|
|
60
62
|
* ```ts
|
|
@@ -62,7 +64,7 @@ export declare class WorkspacePreferences extends APIResource {
|
|
|
62
64
|
* await client.workspacePreferences.publish();
|
|
63
65
|
* ```
|
|
64
66
|
*/
|
|
65
|
-
publish(
|
|
67
|
+
publish(params?: WorkspacePreferencePublishParams | null | undefined, options?: RequestOptions): APIPromise<PublishPreferencesResponse>;
|
|
66
68
|
/**
|
|
67
69
|
* Replace a workspace preference. Full document replacement; missing optional
|
|
68
70
|
* fields are cleared. Topics attached to the workspace preference are unaffected.
|
|
@@ -353,36 +355,71 @@ export interface WorkspacePreferenceTopicReplaceRequest {
|
|
|
353
355
|
}
|
|
354
356
|
export interface WorkspacePreferenceCreateParams {
|
|
355
357
|
/**
|
|
356
|
-
* Human-readable name for the workspace preference.
|
|
358
|
+
* Body param: Human-readable name for the workspace preference.
|
|
357
359
|
*/
|
|
358
360
|
name: string;
|
|
359
361
|
/**
|
|
360
|
-
* Optional description shown under the section on the hosted
|
|
362
|
+
* Body param: Optional description shown under the section on the hosted
|
|
363
|
+
* preferences page.
|
|
361
364
|
*/
|
|
362
365
|
description?: string | null;
|
|
363
366
|
/**
|
|
364
|
-
* Whether the workspace preference defines custom routing for its
|
|
367
|
+
* Body param: Whether the workspace preference defines custom routing for its
|
|
368
|
+
* topics.
|
|
365
369
|
*/
|
|
366
370
|
has_custom_routing?: boolean | null;
|
|
367
371
|
/**
|
|
368
|
-
* Default channels for the workspace preference. Defaults to empty if
|
|
372
|
+
* Body param: Default channels for the workspace preference. Defaults to empty if
|
|
373
|
+
* omitted.
|
|
369
374
|
*/
|
|
370
375
|
routing_options?: Array<Shared.ChannelClassification> | null;
|
|
376
|
+
/**
|
|
377
|
+
* Header param: A unique key that makes this request idempotent. If Courier
|
|
378
|
+
* receives another request with the same `Idempotency-Key`, it returns the stored
|
|
379
|
+
* response from the first request without performing the operation again
|
|
380
|
+
* (including the original status code and any error). Use it to safely retry
|
|
381
|
+
* `POST` requests after network failures without risking duplicate sends. The key
|
|
382
|
+
* is scoped to this endpoint.
|
|
383
|
+
*/
|
|
384
|
+
'Idempotency-Key'?: string;
|
|
385
|
+
/**
|
|
386
|
+
* Header param: How long the idempotency key remains valid, as a Unix epoch
|
|
387
|
+
* timestamp in seconds or an ISO 8601 date string. Only applies when
|
|
388
|
+
* `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
|
|
389
|
+
* maximum is 1 year.
|
|
390
|
+
*/
|
|
391
|
+
'x-idempotency-expiration'?: string;
|
|
371
392
|
}
|
|
372
393
|
export interface WorkspacePreferencePublishParams {
|
|
373
394
|
/**
|
|
374
|
-
* Brand for the hosted page - "default" (workspace default brand),
|
|
375
|
-
* brand), or a specific brand id. Defaults to "default".
|
|
395
|
+
* Body param: Brand for the hosted page - "default" (workspace default brand),
|
|
396
|
+
* "none" (no brand), or a specific brand id. Defaults to "default".
|
|
376
397
|
*/
|
|
377
398
|
brand_id?: string | null;
|
|
378
399
|
/**
|
|
379
|
-
* Description shown under the heading on the hosted preferences page.
|
|
400
|
+
* Body param: Description shown under the heading on the hosted preferences page.
|
|
380
401
|
*/
|
|
381
402
|
description?: string | null;
|
|
382
403
|
/**
|
|
383
|
-
* Heading shown at the top of the hosted preferences page.
|
|
404
|
+
* Body param: Heading shown at the top of the hosted preferences page.
|
|
384
405
|
*/
|
|
385
406
|
heading?: string | null;
|
|
407
|
+
/**
|
|
408
|
+
* Header param: A unique key that makes this request idempotent. If Courier
|
|
409
|
+
* receives another request with the same `Idempotency-Key`, it returns the stored
|
|
410
|
+
* response from the first request without performing the operation again
|
|
411
|
+
* (including the original status code and any error). Use it to safely retry
|
|
412
|
+
* `POST` requests after network failures without risking duplicate sends. The key
|
|
413
|
+
* is scoped to this endpoint.
|
|
414
|
+
*/
|
|
415
|
+
'Idempotency-Key'?: string;
|
|
416
|
+
/**
|
|
417
|
+
* Header param: How long the idempotency key remains valid, as a Unix epoch
|
|
418
|
+
* timestamp in seconds or an ISO 8601 date string. Only applies when
|
|
419
|
+
* `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
|
|
420
|
+
* maximum is 1 year.
|
|
421
|
+
*/
|
|
422
|
+
'x-idempotency-expiration'?: string;
|
|
386
423
|
}
|
|
387
424
|
export interface WorkspacePreferenceReplaceParams {
|
|
388
425
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D
|
|
1
|
+
{"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;OASG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAC;IAE7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,OAAO,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -8,15 +8,17 @@ const TopicsAPI = tslib_1.__importStar(require("./topics.js"));
|
|
|
8
8
|
const topics_1 = require("./topics.js");
|
|
9
9
|
const headers_1 = require("../../internal/headers.js");
|
|
10
10
|
const path_1 = require("../../internal/utils/path.js");
|
|
11
|
+
/**
|
|
12
|
+
* Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
|
|
13
|
+
*/
|
|
11
14
|
class WorkspacePreferences extends resource_1.APIResource {
|
|
12
15
|
constructor() {
|
|
13
16
|
super(...arguments);
|
|
14
17
|
this.topics = new TopicsAPI.Topics(this._client);
|
|
15
18
|
}
|
|
16
19
|
/**
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* /preferences/sections/{section_id}/topics.
|
|
20
|
+
* Creates a workspace preference and returns its generated id. Add subscription
|
|
21
|
+
* topics to it afterwards with the topics endpoint.
|
|
20
22
|
*
|
|
21
23
|
* @example
|
|
22
24
|
* ```ts
|
|
@@ -26,11 +28,25 @@ class WorkspacePreferences extends resource_1.APIResource {
|
|
|
26
28
|
* });
|
|
27
29
|
* ```
|
|
28
30
|
*/
|
|
29
|
-
create(
|
|
30
|
-
|
|
31
|
+
create(params, options) {
|
|
32
|
+
const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
|
|
33
|
+
return this._client.post('/preferences/sections', {
|
|
34
|
+
body,
|
|
35
|
+
...options,
|
|
36
|
+
headers: (0, headers_1.buildHeaders)([
|
|
37
|
+
{
|
|
38
|
+
...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
|
|
39
|
+
...(xIdempotencyExpiration != null ?
|
|
40
|
+
{ 'x-idempotency-expiration': xIdempotencyExpiration }
|
|
41
|
+
: undefined),
|
|
42
|
+
},
|
|
43
|
+
options?.headers,
|
|
44
|
+
]),
|
|
45
|
+
});
|
|
31
46
|
}
|
|
32
47
|
/**
|
|
33
|
-
*
|
|
48
|
+
* Returns one workspace preference by id, including its subscription topics,
|
|
49
|
+
* routing options, and custom routing flag.
|
|
34
50
|
*
|
|
35
51
|
* @example
|
|
36
52
|
* ```ts
|
|
@@ -42,8 +58,8 @@ class WorkspacePreferences extends resource_1.APIResource {
|
|
|
42
58
|
return this._client.get((0, path_1.path) `/preferences/sections/${sectionID}`, options);
|
|
43
59
|
}
|
|
44
60
|
/**
|
|
45
|
-
*
|
|
46
|
-
*
|
|
61
|
+
* Returns the workspace's preferences, each embedding its subscription topics,
|
|
62
|
+
* routing options, and whether custom routing is allowed.
|
|
47
63
|
*
|
|
48
64
|
* @example
|
|
49
65
|
* ```ts
|
|
@@ -70,9 +86,8 @@ class WorkspacePreferences extends resource_1.APIResource {
|
|
|
70
86
|
});
|
|
71
87
|
}
|
|
72
88
|
/**
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
* state visible on the hosted preferences page (non-draft).
|
|
89
|
+
* Publishes the workspace preference page, snapshotting every preference and
|
|
90
|
+
* topic, and returns the page id and a preview URL.
|
|
76
91
|
*
|
|
77
92
|
* @example
|
|
78
93
|
* ```ts
|
|
@@ -80,8 +95,21 @@ class WorkspacePreferences extends resource_1.APIResource {
|
|
|
80
95
|
* await client.workspacePreferences.publish();
|
|
81
96
|
* ```
|
|
82
97
|
*/
|
|
83
|
-
publish(
|
|
84
|
-
|
|
98
|
+
publish(params = {}, options) {
|
|
99
|
+
const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params ?? {};
|
|
100
|
+
return this._client.post('/preferences/publish', {
|
|
101
|
+
body,
|
|
102
|
+
...options,
|
|
103
|
+
headers: (0, headers_1.buildHeaders)([
|
|
104
|
+
{
|
|
105
|
+
...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
|
|
106
|
+
...(xIdempotencyExpiration != null ?
|
|
107
|
+
{ 'x-idempotency-expiration': xIdempotencyExpiration }
|
|
108
|
+
: undefined),
|
|
109
|
+
},
|
|
110
|
+
options?.headers,
|
|
111
|
+
]),
|
|
112
|
+
});
|
|
85
113
|
}
|
|
86
114
|
/**
|
|
87
115
|
* Replace a workspace preference. Full document replacement; missing optional
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,+DAAsC;AACtC,wCAMkB;AAElB,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,oBAAqB,SAAQ,sBAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,+DAAsC;AACtC,wCAMkB;AAElB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,sBAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuIhE,CAAC;IArIC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,SAA8D,EAAE,EAChE,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAxID,oDAwIC;AA0aD,oBAAoB,CAAC,MAAM,GAAG,eAAM,CAAC"}
|
|
@@ -4,15 +4,17 @@ import * as TopicsAPI from "./topics.mjs";
|
|
|
4
4
|
import { Topics, } from "./topics.mjs";
|
|
5
5
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
6
6
|
import { path } from "../../internal/utils/path.mjs";
|
|
7
|
+
/**
|
|
8
|
+
* Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
|
|
9
|
+
*/
|
|
7
10
|
export class WorkspacePreferences extends APIResource {
|
|
8
11
|
constructor() {
|
|
9
12
|
super(...arguments);
|
|
10
13
|
this.topics = new TopicsAPI.Topics(this._client);
|
|
11
14
|
}
|
|
12
15
|
/**
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* /preferences/sections/{section_id}/topics.
|
|
16
|
+
* Creates a workspace preference and returns its generated id. Add subscription
|
|
17
|
+
* topics to it afterwards with the topics endpoint.
|
|
16
18
|
*
|
|
17
19
|
* @example
|
|
18
20
|
* ```ts
|
|
@@ -22,11 +24,25 @@ export class WorkspacePreferences extends APIResource {
|
|
|
22
24
|
* });
|
|
23
25
|
* ```
|
|
24
26
|
*/
|
|
25
|
-
create(
|
|
26
|
-
|
|
27
|
+
create(params, options) {
|
|
28
|
+
const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
|
|
29
|
+
return this._client.post('/preferences/sections', {
|
|
30
|
+
body,
|
|
31
|
+
...options,
|
|
32
|
+
headers: buildHeaders([
|
|
33
|
+
{
|
|
34
|
+
...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
|
|
35
|
+
...(xIdempotencyExpiration != null ?
|
|
36
|
+
{ 'x-idempotency-expiration': xIdempotencyExpiration }
|
|
37
|
+
: undefined),
|
|
38
|
+
},
|
|
39
|
+
options?.headers,
|
|
40
|
+
]),
|
|
41
|
+
});
|
|
27
42
|
}
|
|
28
43
|
/**
|
|
29
|
-
*
|
|
44
|
+
* Returns one workspace preference by id, including its subscription topics,
|
|
45
|
+
* routing options, and custom routing flag.
|
|
30
46
|
*
|
|
31
47
|
* @example
|
|
32
48
|
* ```ts
|
|
@@ -38,8 +54,8 @@ export class WorkspacePreferences extends APIResource {
|
|
|
38
54
|
return this._client.get(path `/preferences/sections/${sectionID}`, options);
|
|
39
55
|
}
|
|
40
56
|
/**
|
|
41
|
-
*
|
|
42
|
-
*
|
|
57
|
+
* Returns the workspace's preferences, each embedding its subscription topics,
|
|
58
|
+
* routing options, and whether custom routing is allowed.
|
|
43
59
|
*
|
|
44
60
|
* @example
|
|
45
61
|
* ```ts
|
|
@@ -66,9 +82,8 @@ export class WorkspacePreferences extends APIResource {
|
|
|
66
82
|
});
|
|
67
83
|
}
|
|
68
84
|
/**
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
* state visible on the hosted preferences page (non-draft).
|
|
85
|
+
* Publishes the workspace preference page, snapshotting every preference and
|
|
86
|
+
* topic, and returns the page id and a preview URL.
|
|
72
87
|
*
|
|
73
88
|
* @example
|
|
74
89
|
* ```ts
|
|
@@ -76,8 +91,21 @@ export class WorkspacePreferences extends APIResource {
|
|
|
76
91
|
* await client.workspacePreferences.publish();
|
|
77
92
|
* ```
|
|
78
93
|
*/
|
|
79
|
-
publish(
|
|
80
|
-
|
|
94
|
+
publish(params = {}, options) {
|
|
95
|
+
const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params ?? {};
|
|
96
|
+
return this._client.post('/preferences/publish', {
|
|
97
|
+
body,
|
|
98
|
+
...options,
|
|
99
|
+
headers: buildHeaders([
|
|
100
|
+
{
|
|
101
|
+
...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
|
|
102
|
+
...(xIdempotencyExpiration != null ?
|
|
103
|
+
{ 'x-idempotency-expiration': xIdempotencyExpiration }
|
|
104
|
+
: undefined),
|
|
105
|
+
},
|
|
106
|
+
options?.headers,
|
|
107
|
+
]),
|
|
108
|
+
});
|
|
81
109
|
}
|
|
82
110
|
/**
|
|
83
111
|
* Replace a workspace preference. Full document replacement; missing optional
|