@knocklabs/node 1.28.0 → 1.29.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +55 -0
- package/client.d.mts +3 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -2
- package/client.d.ts.map +1 -1
- package/client.js +18 -3
- package/client.js.map +1 -1
- package/client.mjs +18 -3
- package/client.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +5 -0
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +5 -0
- package/internal/parse.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/audiences.d.mts +25 -31
- package/resources/audiences.d.mts.map +1 -1
- package/resources/audiences.d.ts +25 -31
- package/resources/audiences.d.ts.map +1 -1
- package/resources/audiences.js +9 -3
- package/resources/audiences.js.map +1 -1
- package/resources/audiences.mjs +9 -3
- package/resources/audiences.mjs.map +1 -1
- package/resources/messages/messages.d.mts +4 -4
- package/resources/messages/messages.d.ts +4 -4
- package/resources/objects/objects.d.mts +4 -4
- package/resources/objects/objects.d.ts +4 -4
- package/resources/shared.d.mts +1 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +1 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/users/feeds.d.mts +37 -0
- package/resources/users/feeds.d.mts.map +1 -1
- package/resources/users/feeds.d.ts +37 -0
- package/resources/users/feeds.d.ts.map +1 -1
- package/resources/users/feeds.js +3 -0
- package/resources/users/feeds.js.map +1 -1
- package/resources/users/feeds.mjs +3 -0
- package/resources/users/feeds.mjs.map +1 -1
- package/resources/users/guides.d.mts +5 -1
- package/resources/users/guides.d.mts.map +1 -1
- package/resources/users/guides.d.ts +5 -1
- package/resources/users/guides.d.ts.map +1 -1
- package/resources/users/users.d.mts +4 -4
- package/resources/users/users.d.ts +4 -4
- package/src/client.ts +26 -6
- package/src/internal/parse.ts +6 -0
- package/src/resources/audiences.ts +28 -33
- package/src/resources/messages/messages.ts +4 -4
- package/src/resources/objects/objects.ts +4 -4
- package/src/resources/shared.ts +5 -1
- package/src/resources/users/feeds.ts +44 -0
- package/src/resources/users/guides.ts +6 -1
- package/src/resources/users/users.ts +4 -4
- 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
|
@@ -13,13 +13,17 @@ export declare class Audiences extends APIResource {
|
|
|
13
13
|
* members: [
|
|
14
14
|
* {
|
|
15
15
|
* tenant: 'ingen_isla_nublar',
|
|
16
|
-
* user: {
|
|
16
|
+
* user: {
|
|
17
|
+
* email: 'ellie@ingen.net',
|
|
18
|
+
* id: 'dr_sattler',
|
|
19
|
+
* name: 'Dr. Ellie Sattler',
|
|
20
|
+
* },
|
|
17
21
|
* },
|
|
18
22
|
* ],
|
|
19
23
|
* });
|
|
20
24
|
* ```
|
|
21
25
|
*/
|
|
22
|
-
addMembers(key: string,
|
|
26
|
+
addMembers(key: string, params: AudienceAddMembersParams, options?: RequestOptions): APIPromise<void>;
|
|
23
27
|
/**
|
|
24
28
|
* Returns a paginated list of members for the specified audience.
|
|
25
29
|
*
|
|
@@ -35,7 +39,7 @@ export declare class Audiences extends APIResource {
|
|
|
35
39
|
* @example
|
|
36
40
|
* ```ts
|
|
37
41
|
* await client.audiences.removeMembers('key', {
|
|
38
|
-
* members: [{ user: {} }],
|
|
42
|
+
* members: [{ user: { id: 'dr_sattler' } }],
|
|
39
43
|
* });
|
|
40
44
|
* ```
|
|
41
45
|
*/
|
|
@@ -83,9 +87,14 @@ export interface AudienceListMembersResponse {
|
|
|
83
87
|
}
|
|
84
88
|
export interface AudienceAddMembersParams {
|
|
85
89
|
/**
|
|
86
|
-
* A list of audience members to add.
|
|
90
|
+
* Body param: A list of audience members to add. You can add up to 1,000 members
|
|
91
|
+
* per request.
|
|
87
92
|
*/
|
|
88
93
|
members: Array<AudienceAddMembersParams.Member>;
|
|
94
|
+
/**
|
|
95
|
+
* Query param: Create the audience if it does not exist.
|
|
96
|
+
*/
|
|
97
|
+
create_audience?: boolean;
|
|
89
98
|
}
|
|
90
99
|
export declare namespace AudienceAddMembersParams {
|
|
91
100
|
/**
|
|
@@ -93,29 +102,22 @@ export declare namespace AudienceAddMembersParams {
|
|
|
93
102
|
*/
|
|
94
103
|
interface Member {
|
|
95
104
|
/**
|
|
96
|
-
*
|
|
105
|
+
* A set of parameters to inline-identify a user with. Inline identifying the user
|
|
106
|
+
* will ensure that the user is available before the request is executed in Knock.
|
|
107
|
+
* It will perform an upsert for the user you're supplying, replacing any
|
|
108
|
+
* properties specified.
|
|
97
109
|
*/
|
|
98
|
-
user:
|
|
110
|
+
user: UsersAPI.InlineIdentifyUserRequest;
|
|
99
111
|
/**
|
|
100
112
|
* The unique identifier for the tenant.
|
|
101
113
|
*/
|
|
102
114
|
tenant?: string | null;
|
|
103
115
|
}
|
|
104
|
-
namespace Member {
|
|
105
|
-
/**
|
|
106
|
-
* An object containing the user's ID.
|
|
107
|
-
*/
|
|
108
|
-
interface User {
|
|
109
|
-
/**
|
|
110
|
-
* The unique identifier of the user.
|
|
111
|
-
*/
|
|
112
|
-
id?: string;
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
116
|
}
|
|
116
117
|
export interface AudienceRemoveMembersParams {
|
|
117
118
|
/**
|
|
118
|
-
* A list of audience members to remove.
|
|
119
|
+
* A list of audience members to remove. You can remove up to 1,000 members per
|
|
120
|
+
* request.
|
|
119
121
|
*/
|
|
120
122
|
members: Array<AudienceRemoveMembersParams.Member>;
|
|
121
123
|
}
|
|
@@ -125,25 +127,17 @@ export declare namespace AudienceRemoveMembersParams {
|
|
|
125
127
|
*/
|
|
126
128
|
interface Member {
|
|
127
129
|
/**
|
|
128
|
-
*
|
|
130
|
+
* A set of parameters to inline-identify a user with. Inline identifying the user
|
|
131
|
+
* will ensure that the user is available before the request is executed in Knock.
|
|
132
|
+
* It will perform an upsert for the user you're supplying, replacing any
|
|
133
|
+
* properties specified.
|
|
129
134
|
*/
|
|
130
|
-
user:
|
|
135
|
+
user: UsersAPI.InlineIdentifyUserRequest;
|
|
131
136
|
/**
|
|
132
137
|
* The unique identifier for the tenant.
|
|
133
138
|
*/
|
|
134
139
|
tenant?: string | null;
|
|
135
140
|
}
|
|
136
|
-
namespace Member {
|
|
137
|
-
/**
|
|
138
|
-
* An object containing the user's ID.
|
|
139
|
-
*/
|
|
140
|
-
interface User {
|
|
141
|
-
/**
|
|
142
|
-
* The unique identifier of the user.
|
|
143
|
-
*/
|
|
144
|
-
id?: string;
|
|
145
|
-
}
|
|
146
|
-
}
|
|
147
141
|
}
|
|
148
142
|
export declare namespace Audiences {
|
|
149
143
|
export { type AudienceMember as AudienceMember, type AudienceListMembersResponse as AudienceListMembersResponse, type AudienceAddMembersParams as AudienceAddMembersParams, type AudienceRemoveMembersParams as AudienceRemoveMembersParams, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"audiences.d.mts","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC
|
|
1
|
+
{"version":3,"file":"audiences.d.mts","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAUrG;;;;;;;OAOG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;;;;;;;;OASG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO1G;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,MAAM;QACrB;;;;;WAKG;QACH,IAAI,EAAE,QAAQ,CAAC,yBAAyB,CAAC;QAEzC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;CACpD;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,MAAM;QACrB;;;;;WAKG;QACH,IAAI,EAAE,QAAQ,CAAC,yBAAyB,CAAC;QAEzC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
package/resources/audiences.d.ts
CHANGED
|
@@ -13,13 +13,17 @@ export declare class Audiences extends APIResource {
|
|
|
13
13
|
* members: [
|
|
14
14
|
* {
|
|
15
15
|
* tenant: 'ingen_isla_nublar',
|
|
16
|
-
* user: {
|
|
16
|
+
* user: {
|
|
17
|
+
* email: 'ellie@ingen.net',
|
|
18
|
+
* id: 'dr_sattler',
|
|
19
|
+
* name: 'Dr. Ellie Sattler',
|
|
20
|
+
* },
|
|
17
21
|
* },
|
|
18
22
|
* ],
|
|
19
23
|
* });
|
|
20
24
|
* ```
|
|
21
25
|
*/
|
|
22
|
-
addMembers(key: string,
|
|
26
|
+
addMembers(key: string, params: AudienceAddMembersParams, options?: RequestOptions): APIPromise<void>;
|
|
23
27
|
/**
|
|
24
28
|
* Returns a paginated list of members for the specified audience.
|
|
25
29
|
*
|
|
@@ -35,7 +39,7 @@ export declare class Audiences extends APIResource {
|
|
|
35
39
|
* @example
|
|
36
40
|
* ```ts
|
|
37
41
|
* await client.audiences.removeMembers('key', {
|
|
38
|
-
* members: [{ user: {} }],
|
|
42
|
+
* members: [{ user: { id: 'dr_sattler' } }],
|
|
39
43
|
* });
|
|
40
44
|
* ```
|
|
41
45
|
*/
|
|
@@ -83,9 +87,14 @@ export interface AudienceListMembersResponse {
|
|
|
83
87
|
}
|
|
84
88
|
export interface AudienceAddMembersParams {
|
|
85
89
|
/**
|
|
86
|
-
* A list of audience members to add.
|
|
90
|
+
* Body param: A list of audience members to add. You can add up to 1,000 members
|
|
91
|
+
* per request.
|
|
87
92
|
*/
|
|
88
93
|
members: Array<AudienceAddMembersParams.Member>;
|
|
94
|
+
/**
|
|
95
|
+
* Query param: Create the audience if it does not exist.
|
|
96
|
+
*/
|
|
97
|
+
create_audience?: boolean;
|
|
89
98
|
}
|
|
90
99
|
export declare namespace AudienceAddMembersParams {
|
|
91
100
|
/**
|
|
@@ -93,29 +102,22 @@ export declare namespace AudienceAddMembersParams {
|
|
|
93
102
|
*/
|
|
94
103
|
interface Member {
|
|
95
104
|
/**
|
|
96
|
-
*
|
|
105
|
+
* A set of parameters to inline-identify a user with. Inline identifying the user
|
|
106
|
+
* will ensure that the user is available before the request is executed in Knock.
|
|
107
|
+
* It will perform an upsert for the user you're supplying, replacing any
|
|
108
|
+
* properties specified.
|
|
97
109
|
*/
|
|
98
|
-
user:
|
|
110
|
+
user: UsersAPI.InlineIdentifyUserRequest;
|
|
99
111
|
/**
|
|
100
112
|
* The unique identifier for the tenant.
|
|
101
113
|
*/
|
|
102
114
|
tenant?: string | null;
|
|
103
115
|
}
|
|
104
|
-
namespace Member {
|
|
105
|
-
/**
|
|
106
|
-
* An object containing the user's ID.
|
|
107
|
-
*/
|
|
108
|
-
interface User {
|
|
109
|
-
/**
|
|
110
|
-
* The unique identifier of the user.
|
|
111
|
-
*/
|
|
112
|
-
id?: string;
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
116
|
}
|
|
116
117
|
export interface AudienceRemoveMembersParams {
|
|
117
118
|
/**
|
|
118
|
-
* A list of audience members to remove.
|
|
119
|
+
* A list of audience members to remove. You can remove up to 1,000 members per
|
|
120
|
+
* request.
|
|
119
121
|
*/
|
|
120
122
|
members: Array<AudienceRemoveMembersParams.Member>;
|
|
121
123
|
}
|
|
@@ -125,25 +127,17 @@ export declare namespace AudienceRemoveMembersParams {
|
|
|
125
127
|
*/
|
|
126
128
|
interface Member {
|
|
127
129
|
/**
|
|
128
|
-
*
|
|
130
|
+
* A set of parameters to inline-identify a user with. Inline identifying the user
|
|
131
|
+
* will ensure that the user is available before the request is executed in Knock.
|
|
132
|
+
* It will perform an upsert for the user you're supplying, replacing any
|
|
133
|
+
* properties specified.
|
|
129
134
|
*/
|
|
130
|
-
user:
|
|
135
|
+
user: UsersAPI.InlineIdentifyUserRequest;
|
|
131
136
|
/**
|
|
132
137
|
* The unique identifier for the tenant.
|
|
133
138
|
*/
|
|
134
139
|
tenant?: string | null;
|
|
135
140
|
}
|
|
136
|
-
namespace Member {
|
|
137
|
-
/**
|
|
138
|
-
* An object containing the user's ID.
|
|
139
|
-
*/
|
|
140
|
-
interface User {
|
|
141
|
-
/**
|
|
142
|
-
* The unique identifier of the user.
|
|
143
|
-
*/
|
|
144
|
-
id?: string;
|
|
145
|
-
}
|
|
146
|
-
}
|
|
147
141
|
}
|
|
148
142
|
export declare namespace Audiences {
|
|
149
143
|
export { type AudienceMember as AudienceMember, type AudienceListMembersResponse as AudienceListMembersResponse, type AudienceAddMembersParams as AudienceAddMembersParams, type AudienceRemoveMembersParams as AudienceRemoveMembersParams, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"audiences.d.ts","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC
|
|
1
|
+
{"version":3,"file":"audiences.d.ts","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAUrG;;;;;;;OAOG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;;;;;;;;OASG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO1G;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,MAAM;QACrB;;;;;WAKG;QACH,IAAI,EAAE,QAAQ,CAAC,yBAAyB,CAAC;QAEzC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;CACpD;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,MAAM;QACrB;;;;;WAKG;QACH,IAAI,EAAE,QAAQ,CAAC,yBAAyB,CAAC;QAEzC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
package/resources/audiences.js
CHANGED
|
@@ -15,14 +15,20 @@ class Audiences extends resource_1.APIResource {
|
|
|
15
15
|
* members: [
|
|
16
16
|
* {
|
|
17
17
|
* tenant: 'ingen_isla_nublar',
|
|
18
|
-
* user: {
|
|
18
|
+
* user: {
|
|
19
|
+
* email: 'ellie@ingen.net',
|
|
20
|
+
* id: 'dr_sattler',
|
|
21
|
+
* name: 'Dr. Ellie Sattler',
|
|
22
|
+
* },
|
|
19
23
|
* },
|
|
20
24
|
* ],
|
|
21
25
|
* });
|
|
22
26
|
* ```
|
|
23
27
|
*/
|
|
24
|
-
addMembers(key,
|
|
28
|
+
addMembers(key, params, options) {
|
|
29
|
+
const { create_audience, ...body } = params;
|
|
25
30
|
return this._client.post((0, path_1.path) `/v1/audiences/${key}/members`, {
|
|
31
|
+
query: { create_audience },
|
|
26
32
|
body,
|
|
27
33
|
...options,
|
|
28
34
|
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
@@ -45,7 +51,7 @@ class Audiences extends resource_1.APIResource {
|
|
|
45
51
|
* @example
|
|
46
52
|
* ```ts
|
|
47
53
|
* await client.audiences.removeMembers('key', {
|
|
48
|
-
* members: [{ user: {} }],
|
|
54
|
+
* members: [{ user: { id: 'dr_sattler' } }],
|
|
49
55
|
* });
|
|
50
56
|
* ```
|
|
51
57
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"audiences.js","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC
|
|
1
|
+
{"version":3,"file":"audiences.js","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,GAAW,EAAE,MAAgC,EAAE,OAAwB;QAChF,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE;YAC3D,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,IAAI;YACJ,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;;;;;;;OAOG;IACH,WAAW,CAAC,GAAW,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CAAC,GAAW,EAAE,IAAiC,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE;YAC7D,IAAI;YACJ,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;CACF;AA3DD,8BA2DC"}
|
package/resources/audiences.mjs
CHANGED
|
@@ -12,14 +12,20 @@ export class Audiences extends APIResource {
|
|
|
12
12
|
* members: [
|
|
13
13
|
* {
|
|
14
14
|
* tenant: 'ingen_isla_nublar',
|
|
15
|
-
* user: {
|
|
15
|
+
* user: {
|
|
16
|
+
* email: 'ellie@ingen.net',
|
|
17
|
+
* id: 'dr_sattler',
|
|
18
|
+
* name: 'Dr. Ellie Sattler',
|
|
19
|
+
* },
|
|
16
20
|
* },
|
|
17
21
|
* ],
|
|
18
22
|
* });
|
|
19
23
|
* ```
|
|
20
24
|
*/
|
|
21
|
-
addMembers(key,
|
|
25
|
+
addMembers(key, params, options) {
|
|
26
|
+
const { create_audience, ...body } = params;
|
|
22
27
|
return this._client.post(path `/v1/audiences/${key}/members`, {
|
|
28
|
+
query: { create_audience },
|
|
23
29
|
body,
|
|
24
30
|
...options,
|
|
25
31
|
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
@@ -42,7 +48,7 @@ export class Audiences extends APIResource {
|
|
|
42
48
|
* @example
|
|
43
49
|
* ```ts
|
|
44
50
|
* await client.audiences.removeMembers('key', {
|
|
45
|
-
* members: [{ user: {} }],
|
|
51
|
+
* members: [{ user: { id: 'dr_sattler' } }],
|
|
46
52
|
* });
|
|
47
53
|
* ```
|
|
48
54
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"audiences.mjs","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC
|
|
1
|
+
{"version":3,"file":"audiences.mjs","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,GAAW,EAAE,MAAgC,EAAE,OAAwB;QAChF,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE;YAC3D,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,IAAI;YACJ,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;;;;;;;OAOG;IACH,WAAW,CAAC,GAAW,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CAAC,GAAW,EAAE,IAAiC,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -813,19 +813,19 @@ export interface MessageListParams extends ItemsCursorParams {
|
|
|
813
813
|
export declare namespace MessageListParams {
|
|
814
814
|
interface InsertedAt {
|
|
815
815
|
/**
|
|
816
|
-
* Limits the results to
|
|
816
|
+
* Limits the results to items inserted after the given date.
|
|
817
817
|
*/
|
|
818
818
|
gt?: string;
|
|
819
819
|
/**
|
|
820
|
-
* Limits the results to
|
|
820
|
+
* Limits the results to items inserted after or on the given date.
|
|
821
821
|
*/
|
|
822
822
|
gte?: string;
|
|
823
823
|
/**
|
|
824
|
-
* Limits the results to
|
|
824
|
+
* Limits the results to items inserted before the given date.
|
|
825
825
|
*/
|
|
826
826
|
lt?: string;
|
|
827
827
|
/**
|
|
828
|
-
* Limits the results to
|
|
828
|
+
* Limits the results to items inserted before or on the given date.
|
|
829
829
|
*/
|
|
830
830
|
lte?: string;
|
|
831
831
|
}
|
|
@@ -813,19 +813,19 @@ export interface MessageListParams extends ItemsCursorParams {
|
|
|
813
813
|
export declare namespace MessageListParams {
|
|
814
814
|
interface InsertedAt {
|
|
815
815
|
/**
|
|
816
|
-
* Limits the results to
|
|
816
|
+
* Limits the results to items inserted after the given date.
|
|
817
817
|
*/
|
|
818
818
|
gt?: string;
|
|
819
819
|
/**
|
|
820
|
-
* Limits the results to
|
|
820
|
+
* Limits the results to items inserted after or on the given date.
|
|
821
821
|
*/
|
|
822
822
|
gte?: string;
|
|
823
823
|
/**
|
|
824
|
-
* Limits the results to
|
|
824
|
+
* Limits the results to items inserted before the given date.
|
|
825
825
|
*/
|
|
826
826
|
lt?: string;
|
|
827
827
|
/**
|
|
828
|
-
* Limits the results to
|
|
828
|
+
* Limits the results to items inserted before or on the given date.
|
|
829
829
|
*/
|
|
830
830
|
lte?: string;
|
|
831
831
|
}
|
|
@@ -424,19 +424,19 @@ export interface ObjectListMessagesParams extends ItemsCursorParams {
|
|
|
424
424
|
export declare namespace ObjectListMessagesParams {
|
|
425
425
|
interface InsertedAt {
|
|
426
426
|
/**
|
|
427
|
-
* Limits the results to
|
|
427
|
+
* Limits the results to items inserted after the given date.
|
|
428
428
|
*/
|
|
429
429
|
gt?: string;
|
|
430
430
|
/**
|
|
431
|
-
* Limits the results to
|
|
431
|
+
* Limits the results to items inserted after or on the given date.
|
|
432
432
|
*/
|
|
433
433
|
gte?: string;
|
|
434
434
|
/**
|
|
435
|
-
* Limits the results to
|
|
435
|
+
* Limits the results to items inserted before the given date.
|
|
436
436
|
*/
|
|
437
437
|
lt?: string;
|
|
438
438
|
/**
|
|
439
|
-
* Limits the results to
|
|
439
|
+
* Limits the results to items inserted before or on the given date.
|
|
440
440
|
*/
|
|
441
441
|
lte?: string;
|
|
442
442
|
}
|
|
@@ -424,19 +424,19 @@ export interface ObjectListMessagesParams extends ItemsCursorParams {
|
|
|
424
424
|
export declare namespace ObjectListMessagesParams {
|
|
425
425
|
interface InsertedAt {
|
|
426
426
|
/**
|
|
427
|
-
* Limits the results to
|
|
427
|
+
* Limits the results to items inserted after the given date.
|
|
428
428
|
*/
|
|
429
429
|
gt?: string;
|
|
430
430
|
/**
|
|
431
|
-
* Limits the results to
|
|
431
|
+
* Limits the results to items inserted after or on the given date.
|
|
432
432
|
*/
|
|
433
433
|
gte?: string;
|
|
434
434
|
/**
|
|
435
|
-
* Limits the results to
|
|
435
|
+
* Limits the results to items inserted before the given date.
|
|
436
436
|
*/
|
|
437
437
|
lt?: string;
|
|
438
438
|
/**
|
|
439
|
-
* Limits the results to
|
|
439
|
+
* Limits the results to items inserted before or on the given date.
|
|
440
440
|
*/
|
|
441
441
|
lte?: string;
|
|
442
442
|
}
|
package/resources/shared.d.mts
CHANGED
|
@@ -9,7 +9,7 @@ export interface Condition {
|
|
|
9
9
|
/**
|
|
10
10
|
* The operator to use in the condition evaluation.
|
|
11
11
|
*/
|
|
12
|
-
operator: 'equal_to' | 'not_equal_to' | 'greater_than' | 'less_than' | 'greater_than_or_equal_to' | 'less_than_or_equal_to' | 'contains' | 'not_contains' | 'empty' | 'not_empty' | 'contains_all' | 'is_timestamp' | 'is_not_timestamp' | '
|
|
12
|
+
operator: 'equal_to' | 'not_equal_to' | 'greater_than' | 'less_than' | 'greater_than_or_equal_to' | 'less_than_or_equal_to' | 'contains' | 'not_contains' | 'empty' | 'not_empty' | 'exists' | 'not_exists' | 'contains_all' | 'is_timestamp' | 'is_not_timestamp' | 'is_timestamp_on_or_after' | 'is_timestamp_before' | 'is_timestamp_on_or_after_date' | 'is_timestamp_before_date' | 'is_timestamp_between' | 'is_audience_member' | 'is_not_audience_member';
|
|
13
13
|
/**
|
|
14
14
|
* The variable to be evaluated in the condition.
|
|
15
15
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EACJ,UAAU,GACV,cAAc,GACd,cAAc,GACd,WAAW,GACX,0BAA0B,GAC1B,uBAAuB,GACvB,UAAU,GACV,cAAc,GACd,OAAO,GACP,WAAW,GACX,cAAc,GACd,cAAc,GACd,kBAAkB,GAClB,
|
|
1
|
+
{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EACJ,UAAU,GACV,cAAc,GACd,cAAc,GACd,WAAW,GACX,0BAA0B,GAC1B,uBAAuB,GACvB,UAAU,GACV,cAAc,GACd,OAAO,GACP,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,cAAc,GACd,kBAAkB,GAClB,0BAA0B,GAC1B,qBAAqB,GACrB,+BAA+B,GAC/B,0BAA0B,GAC1B,sBAAsB,GACtB,oBAAoB,GACpB,wBAAwB,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB"}
|
package/resources/shared.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export interface Condition {
|
|
|
9
9
|
/**
|
|
10
10
|
* The operator to use in the condition evaluation.
|
|
11
11
|
*/
|
|
12
|
-
operator: 'equal_to' | 'not_equal_to' | 'greater_than' | 'less_than' | 'greater_than_or_equal_to' | 'less_than_or_equal_to' | 'contains' | 'not_contains' | 'empty' | 'not_empty' | 'contains_all' | 'is_timestamp' | 'is_not_timestamp' | '
|
|
12
|
+
operator: 'equal_to' | 'not_equal_to' | 'greater_than' | 'less_than' | 'greater_than_or_equal_to' | 'less_than_or_equal_to' | 'contains' | 'not_contains' | 'empty' | 'not_empty' | 'exists' | 'not_exists' | 'contains_all' | 'is_timestamp' | 'is_not_timestamp' | 'is_timestamp_on_or_after' | 'is_timestamp_before' | 'is_timestamp_on_or_after_date' | 'is_timestamp_before_date' | 'is_timestamp_between' | 'is_audience_member' | 'is_not_audience_member';
|
|
13
13
|
/**
|
|
14
14
|
* The variable to be evaluated in the condition.
|
|
15
15
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EACJ,UAAU,GACV,cAAc,GACd,cAAc,GACd,WAAW,GACX,0BAA0B,GAC1B,uBAAuB,GACvB,UAAU,GACV,cAAc,GACd,OAAO,GACP,WAAW,GACX,cAAc,GACd,cAAc,GACd,kBAAkB,GAClB,
|
|
1
|
+
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EACJ,UAAU,GACV,cAAc,GACd,cAAc,GACd,WAAW,GACX,0BAA0B,GAC1B,uBAAuB,GACvB,UAAU,GACV,cAAc,GACd,OAAO,GACP,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,cAAc,GACd,kBAAkB,GAClB,0BAA0B,GAC1B,qBAAqB,GACrB,+BAA+B,GAC/B,0BAA0B,GAC1B,sBAAsB,GACtB,oBAAoB,GACpB,wBAAwB,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB"}
|
|
@@ -32,6 +32,9 @@ export declare class Feeds extends APIResource {
|
|
|
32
32
|
* along with a user token.
|
|
33
33
|
* - This endpoint’s rate limit is always scoped per-user and per-environment. This
|
|
34
34
|
* is true even for requests made without a signed user token.
|
|
35
|
+
* - Any [attachments](/integrations/email/attachments) present in trigger data are
|
|
36
|
+
* automatically excluded from both the `data` and `activities` fields of
|
|
37
|
+
* `UserInAppFeedResponse`.
|
|
35
38
|
*
|
|
36
39
|
* @example
|
|
37
40
|
* ```ts
|
|
@@ -231,10 +234,17 @@ export interface FeedListItemsParams extends EntriesCursorParams {
|
|
|
231
234
|
* The archived status of the feed items.
|
|
232
235
|
*/
|
|
233
236
|
archived?: 'exclude' | 'include' | 'only';
|
|
237
|
+
/**
|
|
238
|
+
* Comma-separated list of field paths to exclude from the response. Use dot
|
|
239
|
+
* notation for nested fields (e.g., `entries.archived_at`). Limited to 3 levels
|
|
240
|
+
* deep.
|
|
241
|
+
*/
|
|
242
|
+
exclude?: string;
|
|
234
243
|
/**
|
|
235
244
|
* Whether the feed items have a tenant.
|
|
236
245
|
*/
|
|
237
246
|
has_tenant?: boolean;
|
|
247
|
+
inserted_at?: FeedListItemsParams.InsertedAt;
|
|
238
248
|
/**
|
|
239
249
|
* The locale to render the feed items in. Must be in the IETF 5646 format (e.g.
|
|
240
250
|
* `en-US`). When not provided, will default to the locale that the feed items were
|
|
@@ -242,6 +252,13 @@ export interface FeedListItemsParams extends EntriesCursorParams {
|
|
|
242
252
|
* translations.
|
|
243
253
|
*/
|
|
244
254
|
locale?: string;
|
|
255
|
+
/**
|
|
256
|
+
* The mode to render the feed items in. Can be `compact` or `rich`. Defaults to
|
|
257
|
+
* `rich`. When `mode` is `compact`, feed items will not have `activities` and
|
|
258
|
+
* `total_activities` fields; the `data` field will not include nested arrays and
|
|
259
|
+
* objects; and the `actors` field will only have up to one actor.
|
|
260
|
+
*/
|
|
261
|
+
mode?: 'compact' | 'rich';
|
|
245
262
|
/**
|
|
246
263
|
* The workflow key associated with the message in the feed.
|
|
247
264
|
*/
|
|
@@ -263,6 +280,26 @@ export interface FeedListItemsParams extends EntriesCursorParams {
|
|
|
263
280
|
*/
|
|
264
281
|
workflow_categories?: Array<string>;
|
|
265
282
|
}
|
|
283
|
+
export declare namespace FeedListItemsParams {
|
|
284
|
+
interface InsertedAt {
|
|
285
|
+
/**
|
|
286
|
+
* Limits the results to items inserted after the given date.
|
|
287
|
+
*/
|
|
288
|
+
gt?: string;
|
|
289
|
+
/**
|
|
290
|
+
* Limits the results to items inserted after or on the given date.
|
|
291
|
+
*/
|
|
292
|
+
gte?: string;
|
|
293
|
+
/**
|
|
294
|
+
* Limits the results to items inserted before the given date.
|
|
295
|
+
*/
|
|
296
|
+
lt?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Limits the results to items inserted before or on the given date.
|
|
299
|
+
*/
|
|
300
|
+
lte?: string;
|
|
301
|
+
}
|
|
302
|
+
}
|
|
266
303
|
export declare namespace Feeds {
|
|
267
304
|
export { type FeedGetSettingsResponse as FeedGetSettingsResponse, type FeedListItemsResponse as FeedListItemsResponse, type FeedListItemsResponsesEntriesCursor as FeedListItemsResponsesEntriesCursor, type FeedListItemsParams as FeedListItemsParams, };
|
|
268
305
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"feeds.d.mts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG
|
|
1
|
+
{"version":3,"file":"feeds.d.mts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,WAAW,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC;IAE7C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -32,6 +32,9 @@ export declare class Feeds extends APIResource {
|
|
|
32
32
|
* along with a user token.
|
|
33
33
|
* - This endpoint’s rate limit is always scoped per-user and per-environment. This
|
|
34
34
|
* is true even for requests made without a signed user token.
|
|
35
|
+
* - Any [attachments](/integrations/email/attachments) present in trigger data are
|
|
36
|
+
* automatically excluded from both the `data` and `activities` fields of
|
|
37
|
+
* `UserInAppFeedResponse`.
|
|
35
38
|
*
|
|
36
39
|
* @example
|
|
37
40
|
* ```ts
|
|
@@ -231,10 +234,17 @@ export interface FeedListItemsParams extends EntriesCursorParams {
|
|
|
231
234
|
* The archived status of the feed items.
|
|
232
235
|
*/
|
|
233
236
|
archived?: 'exclude' | 'include' | 'only';
|
|
237
|
+
/**
|
|
238
|
+
* Comma-separated list of field paths to exclude from the response. Use dot
|
|
239
|
+
* notation for nested fields (e.g., `entries.archived_at`). Limited to 3 levels
|
|
240
|
+
* deep.
|
|
241
|
+
*/
|
|
242
|
+
exclude?: string;
|
|
234
243
|
/**
|
|
235
244
|
* Whether the feed items have a tenant.
|
|
236
245
|
*/
|
|
237
246
|
has_tenant?: boolean;
|
|
247
|
+
inserted_at?: FeedListItemsParams.InsertedAt;
|
|
238
248
|
/**
|
|
239
249
|
* The locale to render the feed items in. Must be in the IETF 5646 format (e.g.
|
|
240
250
|
* `en-US`). When not provided, will default to the locale that the feed items were
|
|
@@ -242,6 +252,13 @@ export interface FeedListItemsParams extends EntriesCursorParams {
|
|
|
242
252
|
* translations.
|
|
243
253
|
*/
|
|
244
254
|
locale?: string;
|
|
255
|
+
/**
|
|
256
|
+
* The mode to render the feed items in. Can be `compact` or `rich`. Defaults to
|
|
257
|
+
* `rich`. When `mode` is `compact`, feed items will not have `activities` and
|
|
258
|
+
* `total_activities` fields; the `data` field will not include nested arrays and
|
|
259
|
+
* objects; and the `actors` field will only have up to one actor.
|
|
260
|
+
*/
|
|
261
|
+
mode?: 'compact' | 'rich';
|
|
245
262
|
/**
|
|
246
263
|
* The workflow key associated with the message in the feed.
|
|
247
264
|
*/
|
|
@@ -263,6 +280,26 @@ export interface FeedListItemsParams extends EntriesCursorParams {
|
|
|
263
280
|
*/
|
|
264
281
|
workflow_categories?: Array<string>;
|
|
265
282
|
}
|
|
283
|
+
export declare namespace FeedListItemsParams {
|
|
284
|
+
interface InsertedAt {
|
|
285
|
+
/**
|
|
286
|
+
* Limits the results to items inserted after the given date.
|
|
287
|
+
*/
|
|
288
|
+
gt?: string;
|
|
289
|
+
/**
|
|
290
|
+
* Limits the results to items inserted after or on the given date.
|
|
291
|
+
*/
|
|
292
|
+
gte?: string;
|
|
293
|
+
/**
|
|
294
|
+
* Limits the results to items inserted before the given date.
|
|
295
|
+
*/
|
|
296
|
+
lt?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Limits the results to items inserted before or on the given date.
|
|
299
|
+
*/
|
|
300
|
+
lte?: string;
|
|
301
|
+
}
|
|
302
|
+
}
|
|
266
303
|
export declare namespace Feeds {
|
|
267
304
|
export { type FeedGetSettingsResponse as FeedGetSettingsResponse, type FeedListItemsResponse as FeedListItemsResponse, type FeedListItemsResponsesEntriesCursor as FeedListItemsResponsesEntriesCursor, type FeedListItemsParams as FeedListItemsParams, };
|
|
268
305
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"feeds.d.ts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG
|
|
1
|
+
{"version":3,"file":"feeds.d.ts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,WAAW,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC;IAE7C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|