sequenzy 2.1.88 → 2.1.90

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/dist/cjs/api/resources/analytics/client/Client.d.ts +1 -1
  2. package/dist/cjs/api/resources/analytics/client/Client.js +5 -3
  3. package/dist/cjs/api/resources/analytics/client/requests/ListCampaignPollResponsesLegacyRequest.d.ts +2 -0
  4. package/dist/cjs/api/resources/analytics/client/requests/ListCampaignPollResponsesRequest.d.ts +2 -0
  5. package/dist/cjs/api/types/OutboundWebhookEventType.d.ts +1 -0
  6. package/dist/cjs/api/types/OutboundWebhookEventType.js +1 -0
  7. package/dist/cjs/api/types/PollResponse.d.ts +6 -0
  8. package/dist/cjs/serialization/types/OutboundWebhookEventType.d.ts +1 -1
  9. package/dist/cjs/serialization/types/OutboundWebhookEventType.js +1 -0
  10. package/dist/cjs/serialization/types/PollResponse.d.ts +3 -0
  11. package/dist/cjs/serialization/types/PollResponse.js +3 -0
  12. package/dist/esm/api/resources/analytics/client/Client.d.ts +1 -1
  13. package/dist/esm/api/resources/analytics/client/Client.js +5 -3
  14. package/dist/esm/api/resources/analytics/client/requests/ListCampaignPollResponsesLegacyRequest.d.ts +2 -0
  15. package/dist/esm/api/resources/analytics/client/requests/ListCampaignPollResponsesRequest.d.ts +2 -0
  16. package/dist/esm/api/types/OutboundWebhookEventType.d.ts +1 -0
  17. package/dist/esm/api/types/OutboundWebhookEventType.js +1 -0
  18. package/dist/esm/api/types/PollResponse.d.ts +6 -0
  19. package/dist/esm/serialization/types/OutboundWebhookEventType.d.ts +1 -1
  20. package/dist/esm/serialization/types/OutboundWebhookEventType.js +1 -0
  21. package/dist/esm/serialization/types/PollResponse.d.ts +3 -0
  22. package/dist/esm/serialization/types/PollResponse.js +3 -0
  23. package/package.json +1 -1
@@ -258,7 +258,7 @@ export declare class AnalyticsClient {
258
258
  listCampaignEvents(request: Sequenzy.ListCampaignEventsRequest, requestOptions?: AnalyticsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListCampaignEventsResponse>;
259
259
  private __listCampaignEvents;
260
260
  /**
261
- * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
261
+ * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. Each row also carries the respondent's latest comment from the poll's confirmation page; pass `hasComment=true` to list only respondents who commented, newest comment first. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
262
262
  *
263
263
  * @param {Sequenzy.ListCampaignPollResponsesRequest} request
264
264
  * @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1188,7 +1188,7 @@ class AnalyticsClient {
1188
1188
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/metrics/campaigns/{campaignId}/events");
1189
1189
  }
1190
1190
  /**
1191
- * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
1191
+ * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. Each row also carries the respondent's latest comment from the poll's confirmation page; pass `hasComment=true` to list only respondents who commented, newest comment first. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
1192
1192
  *
1193
1193
  * @param {Sequenzy.ListCampaignPollResponsesRequest} request
1194
1194
  * @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1209,9 +1209,10 @@ class AnalyticsClient {
1209
1209
  return core.HttpResponsePromise.fromPromise(this.__listCampaignPollResponses(request, requestOptions));
1210
1210
  }
1211
1211
  async __listCampaignPollResponses(request, requestOptions) {
1212
- const { campaignId, blockId, limit, page } = request;
1212
+ const { campaignId, blockId, hasComment, limit, page } = request;
1213
1213
  const _queryParams = {
1214
1214
  blockId,
1215
+ hasComment,
1215
1216
  limit,
1216
1217
  page,
1217
1218
  };
@@ -1288,9 +1289,10 @@ class AnalyticsClient {
1288
1289
  return core.HttpResponsePromise.fromPromise(this.__listCampaignPollResponsesLegacy(request, requestOptions));
1289
1290
  }
1290
1291
  async __listCampaignPollResponsesLegacy(request, requestOptions) {
1291
- const { campaignId, blockId, limit, page } = request;
1292
+ const { campaignId, blockId, hasComment, limit, page } = request;
1292
1293
  const _queryParams = {
1293
1294
  blockId,
1295
+ hasComment,
1294
1296
  limit,
1295
1297
  page,
1296
1298
  };
@@ -9,6 +9,8 @@ export interface ListCampaignPollResponsesLegacyRequest {
9
9
  campaignId: string;
10
10
  /** Restrict results to one poll block. */
11
11
  blockId?: string;
12
+ /** Pass `true` to list only respondents who left a comment, newest comment first. */
13
+ hasComment?: boolean;
12
14
  /** Responses per page (max 500) */
13
15
  limit?: number;
14
16
  /** Page number */
@@ -9,6 +9,8 @@ export interface ListCampaignPollResponsesRequest {
9
9
  campaignId: string;
10
10
  /** Restrict results to one poll block. Block IDs come from the `polls` array of the campaign metrics endpoint. */
11
11
  blockId?: string;
12
+ /** Pass `true` to list only respondents who left a comment, newest comment first. */
13
+ hasComment?: boolean;
12
14
  /** Responses per page (max 500) */
13
15
  limit?: number;
14
16
  /** Page number */
@@ -25,5 +25,6 @@ export declare const OutboundWebhookEventType: {
25
25
  readonly SequenceFinished: "sequence.finished";
26
26
  readonly SequenceFailed: "sequence.failed";
27
27
  readonly PollAnswered: "poll.answered";
28
+ readonly PollCommented: "poll.commented";
28
29
  };
29
30
  export type OutboundWebhookEventType = (typeof OutboundWebhookEventType)[keyof typeof OutboundWebhookEventType];
@@ -29,4 +29,5 @@ exports.OutboundWebhookEventType = {
29
29
  SequenceFinished: "sequence.finished",
30
30
  SequenceFailed: "sequence.failed",
31
31
  PollAnswered: "poll.answered",
32
+ PollCommented: "poll.commented",
32
33
  };
@@ -11,6 +11,12 @@ export interface PollResponse {
11
11
  attributeKey?: string | null;
12
12
  /** Poll block ID inside the email content. */
13
13
  blockId?: string;
14
+ /** Latest comment the respondent left on the poll's hosted confirmation page, or null when they did not comment. Requires the poll's comment box (`commentEnabled`). */
15
+ comment?: string | null;
16
+ /** The answer the comment was written under. It can differ from `answers` when the respondent changed their answer after commenting. Null without a comment. */
17
+ commentAnswer?: string | null;
18
+ /** When the comment was left. Null without a comment. */
19
+ commentedAt?: Date | null;
14
20
  /** Null when the subscriber has since been deleted. */
15
21
  email?: string | null;
16
22
  externalId?: string | null;
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  export declare const OutboundWebhookEventType: core.serialization.Schema<serializers.OutboundWebhookEventType.Raw, Sequenzy.OutboundWebhookEventType>;
5
5
  export declare namespace OutboundWebhookEventType {
6
- type Raw = "email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.failed" | "email.complained" | "email.opened" | "email.clicked" | "email.replied" | "email.received" | "email.unsubscribed" | "campaign.sent" | "sms.sent" | "sms.delivered" | "sms.failed" | "sms.opted_out" | "subscriber.invalid" | "subscriber.created" | "subscriber.updated" | "subscriber.unsubscribed" | "subscriber.list_subscribed" | "subscriber.list_unsubscribed" | "subscriber_import.completed" | "sequence.finished" | "sequence.failed" | "poll.answered";
6
+ type Raw = "email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.failed" | "email.complained" | "email.opened" | "email.clicked" | "email.replied" | "email.received" | "email.unsubscribed" | "campaign.sent" | "sms.sent" | "sms.delivered" | "sms.failed" | "sms.opted_out" | "subscriber.invalid" | "subscriber.created" | "subscriber.updated" | "subscriber.unsubscribed" | "subscriber.list_subscribed" | "subscriber.list_unsubscribed" | "subscriber_import.completed" | "sequence.finished" | "sequence.failed" | "poll.answered" | "poll.commented";
7
7
  }
@@ -53,4 +53,5 @@ exports.OutboundWebhookEventType = core.serialization.enum_([
53
53
  "sequence.finished",
54
54
  "sequence.failed",
55
55
  "poll.answered",
56
+ "poll.commented",
56
57
  ]);
@@ -9,6 +9,9 @@ export declare namespace PollResponse {
9
9
  answers?: string[] | null;
10
10
  attributeKey?: (string | null | undefined) | null;
11
11
  blockId?: string | null;
12
+ comment?: (string | null | undefined) | null;
13
+ commentAnswer?: (string | null | undefined) | null;
14
+ commentedAt?: (string | null | undefined) | null;
12
15
  email?: (string | null | undefined) | null;
13
16
  externalId?: (string | null | undefined) | null;
14
17
  firstName?: (string | null | undefined) | null;
@@ -32,6 +32,9 @@ exports.PollResponse = core.serialization.object({
32
32
  answers: core.serialization.list(core.serialization.string()).optional(),
33
33
  attributeKey: core.serialization.string().optionalNullable(),
34
34
  blockId: core.serialization.string().optional(),
35
+ comment: core.serialization.string().optionalNullable(),
36
+ commentAnswer: core.serialization.string().optionalNullable(),
37
+ commentedAt: core.serialization.date().optionalNullable(),
35
38
  email: core.serialization.string().optionalNullable(),
36
39
  externalId: core.serialization.string().optionalNullable(),
37
40
  firstName: core.serialization.string().optionalNullable(),
@@ -258,7 +258,7 @@ export declare class AnalyticsClient {
258
258
  listCampaignEvents(request: Sequenzy.ListCampaignEventsRequest, requestOptions?: AnalyticsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListCampaignEventsResponse>;
259
259
  private __listCampaignEvents;
260
260
  /**
261
- * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
261
+ * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. Each row also carries the respondent's latest comment from the poll's confirmation page; pass `hasComment=true` to list only respondents who commented, newest comment first. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
262
262
  *
263
263
  * @param {Sequenzy.ListCampaignPollResponsesRequest} request
264
264
  * @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1162,7 +1162,7 @@ export class AnalyticsClient {
1162
1162
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/metrics/campaigns/{campaignId}/events");
1163
1163
  }
1164
1164
  /**
1165
- * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
1165
+ * Returns one row per respondent per Poll or NPS block in a campaign, newest answer first, with the answer, its stored value, the subscriber attribute the answer was saved to, and the response time. Only each subscriber's latest answer per block is returned, so counts match the `polls` summaries from the campaign metrics endpoint. Multi-select answers list every selected option in `answers` and `values`. Each row also carries the respondent's latest comment from the poll's confirmation page; pass `hasComment=true` to list only respondents who commented, newest comment first. For a sequence email step, pass the step's automation node ID as `campaignId`. Also available at `GET /campaigns/{campaignId}/poll-responses`.
1166
1166
  *
1167
1167
  * @param {Sequenzy.ListCampaignPollResponsesRequest} request
1168
1168
  * @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1183,9 +1183,10 @@ export class AnalyticsClient {
1183
1183
  return core.HttpResponsePromise.fromPromise(this.__listCampaignPollResponses(request, requestOptions));
1184
1184
  }
1185
1185
  async __listCampaignPollResponses(request, requestOptions) {
1186
- const { campaignId, blockId, limit, page } = request;
1186
+ const { campaignId, blockId, hasComment, limit, page } = request;
1187
1187
  const _queryParams = {
1188
1188
  blockId,
1189
+ hasComment,
1189
1190
  limit,
1190
1191
  page,
1191
1192
  };
@@ -1262,9 +1263,10 @@ export class AnalyticsClient {
1262
1263
  return core.HttpResponsePromise.fromPromise(this.__listCampaignPollResponsesLegacy(request, requestOptions));
1263
1264
  }
1264
1265
  async __listCampaignPollResponsesLegacy(request, requestOptions) {
1265
- const { campaignId, blockId, limit, page } = request;
1266
+ const { campaignId, blockId, hasComment, limit, page } = request;
1266
1267
  const _queryParams = {
1267
1268
  blockId,
1269
+ hasComment,
1268
1270
  limit,
1269
1271
  page,
1270
1272
  };
@@ -9,6 +9,8 @@ export interface ListCampaignPollResponsesLegacyRequest {
9
9
  campaignId: string;
10
10
  /** Restrict results to one poll block. */
11
11
  blockId?: string;
12
+ /** Pass `true` to list only respondents who left a comment, newest comment first. */
13
+ hasComment?: boolean;
12
14
  /** Responses per page (max 500) */
13
15
  limit?: number;
14
16
  /** Page number */
@@ -9,6 +9,8 @@ export interface ListCampaignPollResponsesRequest {
9
9
  campaignId: string;
10
10
  /** Restrict results to one poll block. Block IDs come from the `polls` array of the campaign metrics endpoint. */
11
11
  blockId?: string;
12
+ /** Pass `true` to list only respondents who left a comment, newest comment first. */
13
+ hasComment?: boolean;
12
14
  /** Responses per page (max 500) */
13
15
  limit?: number;
14
16
  /** Page number */
@@ -25,5 +25,6 @@ export declare const OutboundWebhookEventType: {
25
25
  readonly SequenceFinished: "sequence.finished";
26
26
  readonly SequenceFailed: "sequence.failed";
27
27
  readonly PollAnswered: "poll.answered";
28
+ readonly PollCommented: "poll.commented";
28
29
  };
29
30
  export type OutboundWebhookEventType = (typeof OutboundWebhookEventType)[keyof typeof OutboundWebhookEventType];
@@ -26,4 +26,5 @@ export const OutboundWebhookEventType = {
26
26
  SequenceFinished: "sequence.finished",
27
27
  SequenceFailed: "sequence.failed",
28
28
  PollAnswered: "poll.answered",
29
+ PollCommented: "poll.commented",
29
30
  };
@@ -11,6 +11,12 @@ export interface PollResponse {
11
11
  attributeKey?: string | null;
12
12
  /** Poll block ID inside the email content. */
13
13
  blockId?: string;
14
+ /** Latest comment the respondent left on the poll's hosted confirmation page, or null when they did not comment. Requires the poll's comment box (`commentEnabled`). */
15
+ comment?: string | null;
16
+ /** The answer the comment was written under. It can differ from `answers` when the respondent changed their answer after commenting. Null without a comment. */
17
+ commentAnswer?: string | null;
18
+ /** When the comment was left. Null without a comment. */
19
+ commentedAt?: Date | null;
14
20
  /** Null when the subscriber has since been deleted. */
15
21
  email?: string | null;
16
22
  externalId?: string | null;
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  export declare const OutboundWebhookEventType: core.serialization.Schema<serializers.OutboundWebhookEventType.Raw, Sequenzy.OutboundWebhookEventType>;
5
5
  export declare namespace OutboundWebhookEventType {
6
- type Raw = "email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.failed" | "email.complained" | "email.opened" | "email.clicked" | "email.replied" | "email.received" | "email.unsubscribed" | "campaign.sent" | "sms.sent" | "sms.delivered" | "sms.failed" | "sms.opted_out" | "subscriber.invalid" | "subscriber.created" | "subscriber.updated" | "subscriber.unsubscribed" | "subscriber.list_subscribed" | "subscriber.list_unsubscribed" | "subscriber_import.completed" | "sequence.finished" | "sequence.failed" | "poll.answered";
6
+ type Raw = "email.sent" | "email.delivered" | "email.delivery_delayed" | "email.bounced" | "email.failed" | "email.complained" | "email.opened" | "email.clicked" | "email.replied" | "email.received" | "email.unsubscribed" | "campaign.sent" | "sms.sent" | "sms.delivered" | "sms.failed" | "sms.opted_out" | "subscriber.invalid" | "subscriber.created" | "subscriber.updated" | "subscriber.unsubscribed" | "subscriber.list_subscribed" | "subscriber.list_unsubscribed" | "subscriber_import.completed" | "sequence.finished" | "sequence.failed" | "poll.answered" | "poll.commented";
7
7
  }
@@ -27,4 +27,5 @@ export const OutboundWebhookEventType = core.serialization.enum_([
27
27
  "sequence.finished",
28
28
  "sequence.failed",
29
29
  "poll.answered",
30
+ "poll.commented",
30
31
  ]);
@@ -9,6 +9,9 @@ export declare namespace PollResponse {
9
9
  answers?: string[] | null;
10
10
  attributeKey?: (string | null | undefined) | null;
11
11
  blockId?: string | null;
12
+ comment?: (string | null | undefined) | null;
13
+ commentAnswer?: (string | null | undefined) | null;
14
+ commentedAt?: (string | null | undefined) | null;
12
15
  email?: (string | null | undefined) | null;
13
16
  externalId?: (string | null | undefined) | null;
14
17
  firstName?: (string | null | undefined) | null;
@@ -6,6 +6,9 @@ export const PollResponse = core.serialization.object({
6
6
  answers: core.serialization.list(core.serialization.string()).optional(),
7
7
  attributeKey: core.serialization.string().optionalNullable(),
8
8
  blockId: core.serialization.string().optional(),
9
+ comment: core.serialization.string().optionalNullable(),
10
+ commentAnswer: core.serialization.string().optionalNullable(),
11
+ commentedAt: core.serialization.date().optionalNullable(),
9
12
  email: core.serialization.string().optionalNullable(),
10
13
  externalId: core.serialization.string().optionalNullable(),
11
14
  firstName: core.serialization.string().optionalNullable(),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sequenzy",
3
- "version": "2.1.88",
3
+ "version": "2.1.90",
4
4
  "description": "Official TypeScript SDK for the Sequenzy API",
5
5
  "license": "MIT",
6
6
  "homepage": "https://docs.sequenzy.com",