sequenzy 2.1.23 → 2.1.30
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/dist/cjs/api/resources/accounts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/accounts/client/Client.js +1 -1
- package/dist/cjs/api/resources/analytics/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/analytics/client/Client.js +108 -1
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +27 -0
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.js +3 -0
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +4 -0
- package/dist/cjs/api/resources/analytics/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +8 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestBy.js +11 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +6 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +9 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +8 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +11 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +14 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponse.js +3 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +30 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +3 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsResponse.d.ts +4 -0
- package/dist/cjs/api/resources/analytics/types/index.d.ts +5 -0
- package/dist/cjs/api/resources/analytics/types/index.js +5 -0
- package/dist/cjs/api/resources/integrations/client/Client.d.ts +17 -0
- package/dist/cjs/api/resources/integrations/client/Client.js +66 -0
- package/dist/cjs/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +12 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +11 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +4 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +4 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +7 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +10 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +10 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +12 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +15 -0
- package/dist/cjs/api/resources/integrations/types/index.d.ts +7 -0
- package/dist/cjs/api/resources/integrations/types/index.js +7 -0
- package/dist/cjs/api/types/EmailEvent.d.ts +5 -0
- package/dist/cjs/api/types/EmailEventOutcome.d.ts +8 -0
- package/dist/cjs/api/types/EmailEventOutcome.js +11 -0
- package/dist/cjs/api/types/EmailSend.d.ts +7 -1
- package/dist/cjs/api/types/EmailSendEvent.d.ts +1 -0
- package/dist/cjs/api/types/EmailSendInternalFailureCode.d.ts +1 -1
- package/dist/cjs/api/types/EmailSendInternalFailureCode.js +1 -1
- package/dist/cjs/api/types/EmailSendOutcome.d.ts +8 -0
- package/dist/cjs/api/types/EmailSendOutcome.js +11 -0
- package/dist/cjs/api/types/SenderHealthMetric.d.ts +1 -1
- package/dist/cjs/api/types/SendingStatusPauseReasonKind.d.ts +1 -0
- package/dist/cjs/api/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/cjs/api/types/SendingStatusSenderHealth.d.ts +4 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +19 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +41 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +26 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +48 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.js +2 -0
- package/dist/cjs/serialization/resources/analytics/types/index.d.ts +5 -0
- package/dist/cjs/serialization/resources/analytics/types/index.js +5 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +15 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +37 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +13 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +35 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +10 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +32 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +29 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +15 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +37 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +29 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +39 -0
- package/dist/cjs/serialization/resources/integrations/types/index.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/index.js +7 -0
- package/dist/cjs/serialization/types/EmailEvent.d.ts +3 -0
- package/dist/cjs/serialization/types/EmailEvent.js +3 -0
- package/dist/cjs/serialization/types/EmailEventOutcome.d.ts +7 -0
- package/dist/cjs/serialization/types/EmailEventOutcome.js +29 -0
- package/dist/cjs/serialization/types/EmailSend.d.ts +3 -0
- package/dist/cjs/serialization/types/EmailSend.js +3 -0
- package/dist/cjs/serialization/types/EmailSendOutcome.d.ts +7 -0
- package/dist/cjs/serialization/types/EmailSendOutcome.js +29 -0
- package/dist/cjs/serialization/types/SendingStatusPauseReasonKind.d.ts +1 -1
- package/dist/cjs/serialization/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/cjs/serialization/types/SendingStatusSenderHealth.d.ts +2 -0
- package/dist/cjs/serialization/types/SendingStatusSenderHealth.js +2 -0
- package/dist/cjs/serialization/types/index.d.ts +2 -0
- package/dist/cjs/serialization/types/index.js +2 -0
- package/dist/esm/api/resources/accounts/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/accounts/client/Client.js +1 -1
- package/dist/esm/api/resources/analytics/client/Client.d.ts +20 -0
- package/dist/esm/api/resources/analytics/client/Client.js +108 -1
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +27 -0
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.js +2 -0
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +4 -0
- package/dist/esm/api/resources/analytics/client/requests/index.d.ts +1 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestBy.js +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +6 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +6 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +14 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponse.js +2 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +30 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +2 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsResponse.d.ts +4 -0
- package/dist/esm/api/resources/analytics/types/index.d.ts +5 -0
- package/dist/esm/api/resources/analytics/types/index.js +5 -0
- package/dist/esm/api/resources/integrations/client/Client.d.ts +17 -0
- package/dist/esm/api/resources/integrations/client/Client.js +66 -0
- package/dist/esm/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +1 -1
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +12 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +11 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +4 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +4 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +4 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +10 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +7 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +12 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +12 -0
- package/dist/esm/api/resources/integrations/types/index.d.ts +7 -0
- package/dist/esm/api/resources/integrations/types/index.js +7 -0
- package/dist/esm/api/types/EmailEvent.d.ts +5 -0
- package/dist/esm/api/types/EmailEventOutcome.d.ts +8 -0
- package/dist/esm/api/types/EmailEventOutcome.js +8 -0
- package/dist/esm/api/types/EmailSend.d.ts +7 -1
- package/dist/esm/api/types/EmailSendEvent.d.ts +1 -0
- package/dist/esm/api/types/EmailSendInternalFailureCode.d.ts +1 -1
- package/dist/esm/api/types/EmailSendInternalFailureCode.js +1 -1
- package/dist/esm/api/types/EmailSendOutcome.d.ts +8 -0
- package/dist/esm/api/types/EmailSendOutcome.js +8 -0
- package/dist/esm/api/types/SenderHealthMetric.d.ts +1 -1
- package/dist/esm/api/types/SendingStatusPauseReasonKind.d.ts +1 -0
- package/dist/esm/api/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/esm/api/types/SendingStatusSenderHealth.d.ts +4 -0
- package/dist/esm/api/types/index.d.ts +2 -0
- package/dist/esm/api/types/index.js +2 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +19 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +15 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +26 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +22 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.js +2 -0
- package/dist/esm/serialization/resources/analytics/types/index.d.ts +5 -0
- package/dist/esm/serialization/resources/analytics/types/index.js +5 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +15 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +11 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +13 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +9 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +10 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +6 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +3 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +15 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +11 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +3 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +13 -0
- package/dist/esm/serialization/resources/integrations/types/index.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/index.js +7 -0
- package/dist/esm/serialization/types/EmailEvent.d.ts +3 -0
- package/dist/esm/serialization/types/EmailEvent.js +3 -0
- package/dist/esm/serialization/types/EmailEventOutcome.d.ts +7 -0
- package/dist/esm/serialization/types/EmailEventOutcome.js +3 -0
- package/dist/esm/serialization/types/EmailSend.d.ts +3 -0
- package/dist/esm/serialization/types/EmailSend.js +3 -0
- package/dist/esm/serialization/types/EmailSendOutcome.d.ts +7 -0
- package/dist/esm/serialization/types/EmailSendOutcome.js +3 -0
- package/dist/esm/serialization/types/SendingStatusPauseReasonKind.d.ts +1 -1
- package/dist/esm/serialization/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/esm/serialization/types/SendingStatusSenderHealth.d.ts +2 -0
- package/dist/esm/serialization/types/SendingStatusSenderHealth.js +2 -0
- package/dist/esm/serialization/types/index.d.ts +2 -0
- package/dist/esm/serialization/types/index.js +2 -0
- package/package.json +1 -1
|
@@ -143,7 +143,7 @@ export declare class AccountsClient {
|
|
|
143
143
|
getOrganizationIdJob(request: Sequenzy.GetOrganizationIdJobAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetOrganizationIdJobAccountsResponse>;
|
|
144
144
|
private __getOrganizationIdJob;
|
|
145
145
|
/**
|
|
146
|
-
* Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin.
|
|
146
|
+
* Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin. Organizations is the dashboard name for accounts, and every `/accounts` path also works as `/organizations`, and `/account-suggestions` as `/organization-suggestions`.
|
|
147
147
|
*
|
|
148
148
|
* @param {Sequenzy.ListAccountsRequest} request
|
|
149
149
|
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -520,7 +520,7 @@ class AccountsClient {
|
|
|
520
520
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/account-suggestions/organization-ids/jobs/{jobId}");
|
|
521
521
|
}
|
|
522
522
|
/**
|
|
523
|
-
* Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin.
|
|
523
|
+
* Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin. Organizations is the dashboard name for accounts, and every `/accounts` path also works as `/organizations`, and `/account-suggestions` as `/organization-suggestions`.
|
|
524
524
|
*
|
|
525
525
|
* @param {Sequenzy.ListAccountsRequest} request
|
|
526
526
|
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -115,6 +115,7 @@ export declare class AnalyticsClient {
|
|
|
115
115
|
*
|
|
116
116
|
* @throws {@link Sequenzy.BadRequestError}
|
|
117
117
|
* @throws {@link Sequenzy.UnauthorizedError}
|
|
118
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
118
119
|
* @throws {@link Sequenzy.ServiceUnavailableError}
|
|
119
120
|
* @throws {@link errors.SequenzyError}
|
|
120
121
|
* @throws {@link errors.SequenzyTimeoutError}
|
|
@@ -124,6 +125,25 @@ export declare class AnalyticsClient {
|
|
|
124
125
|
*/
|
|
125
126
|
getMetrics(request?: Sequenzy.GetMetricsRequest, requestOptions?: AnalyticsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetMetricsResponse>;
|
|
126
127
|
private __getMetrics;
|
|
128
|
+
/**
|
|
129
|
+
* Returns the delivery funnel for each value of one dimension, most sends first, so you can find the email, sequence, provider or domain behind a number and drill into it. Rows count the sends made in the window and the engagement they earned. Defaults to the last 30 days and 25 rows.
|
|
130
|
+
*
|
|
131
|
+
* @param {Sequenzy.GetMetricsBreakdownRequest} request
|
|
132
|
+
* @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
135
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
136
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
137
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
138
|
+
* @throws {@link Sequenzy.InternalServerError}
|
|
139
|
+
* @throws {@link errors.SequenzyError}
|
|
140
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
141
|
+
*
|
|
142
|
+
* @example
|
|
143
|
+
* await client.analytics.getMetricsBreakdown()
|
|
144
|
+
*/
|
|
145
|
+
getMetricsBreakdown(request?: Sequenzy.GetMetricsBreakdownRequest, requestOptions?: AnalyticsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetMetricsBreakdownResponse>;
|
|
146
|
+
private __getMetricsBreakdown;
|
|
127
147
|
/**
|
|
128
148
|
* Returns a paginated list of recipients with their open, click, and unsubscribe events. Use this to sync engagement data to your own database.
|
|
129
149
|
*
|
|
@@ -473,6 +473,7 @@ class AnalyticsClient {
|
|
|
473
473
|
*
|
|
474
474
|
* @throws {@link Sequenzy.BadRequestError}
|
|
475
475
|
* @throws {@link Sequenzy.UnauthorizedError}
|
|
476
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
476
477
|
* @throws {@link Sequenzy.ServiceUnavailableError}
|
|
477
478
|
* @throws {@link errors.SequenzyError}
|
|
478
479
|
* @throws {@link errors.SequenzyTimeoutError}
|
|
@@ -484,7 +485,7 @@ class AnalyticsClient {
|
|
|
484
485
|
return core.HttpResponsePromise.fromPromise(this.__getMetrics(request, requestOptions));
|
|
485
486
|
}
|
|
486
487
|
async __getMetrics(request = {}, requestOptions) {
|
|
487
|
-
const { emailType, end, includeMachineEngagement, mailboxProvider, period, start } = request;
|
|
488
|
+
const { emailType, end, includeMachineEngagement, mailboxProvider, period, recipientDomain, source, start } = request;
|
|
488
489
|
const _queryParams = {
|
|
489
490
|
emailType: emailType != null
|
|
490
491
|
? serializers.GetMetricsRequestEmailType.jsonOrThrow(emailType, {
|
|
@@ -501,6 +502,8 @@ class AnalyticsClient {
|
|
|
501
502
|
omitUndefined: true,
|
|
502
503
|
})
|
|
503
504
|
: undefined,
|
|
505
|
+
recipientDomain,
|
|
506
|
+
source,
|
|
504
507
|
start: start != null ? start?.toISOString() : undefined,
|
|
505
508
|
};
|
|
506
509
|
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
@@ -540,6 +543,8 @@ class AnalyticsClient {
|
|
|
540
543
|
throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
|
|
541
544
|
case 401:
|
|
542
545
|
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
546
|
+
case 404:
|
|
547
|
+
throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
|
|
543
548
|
case 503:
|
|
544
549
|
throw new Sequenzy.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
545
550
|
default:
|
|
@@ -552,6 +557,108 @@ class AnalyticsClient {
|
|
|
552
557
|
}
|
|
553
558
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/metrics");
|
|
554
559
|
}
|
|
560
|
+
/**
|
|
561
|
+
* Returns the delivery funnel for each value of one dimension, most sends first, so you can find the email, sequence, provider or domain behind a number and drill into it. Rows count the sends made in the window and the engagement they earned. Defaults to the last 30 days and 25 rows.
|
|
562
|
+
*
|
|
563
|
+
* @param {Sequenzy.GetMetricsBreakdownRequest} request
|
|
564
|
+
* @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
565
|
+
*
|
|
566
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
567
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
568
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
569
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
570
|
+
* @throws {@link Sequenzy.InternalServerError}
|
|
571
|
+
* @throws {@link errors.SequenzyError}
|
|
572
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
573
|
+
*
|
|
574
|
+
* @example
|
|
575
|
+
* await client.analytics.getMetricsBreakdown()
|
|
576
|
+
*/
|
|
577
|
+
getMetricsBreakdown(request = {}, requestOptions) {
|
|
578
|
+
return core.HttpResponsePromise.fromPromise(this.__getMetricsBreakdown(request, requestOptions));
|
|
579
|
+
}
|
|
580
|
+
async __getMetricsBreakdown(request = {}, requestOptions) {
|
|
581
|
+
const { by, emailType, end, includeMachineEngagement, limit, mailboxProvider, period, recipientDomain, source, start, } = request;
|
|
582
|
+
const _queryParams = {
|
|
583
|
+
by: by != null
|
|
584
|
+
? serializers.GetMetricsBreakdownRequestBy.jsonOrThrow(by, {
|
|
585
|
+
unrecognizedObjectKeys: "strip",
|
|
586
|
+
omitUndefined: true,
|
|
587
|
+
})
|
|
588
|
+
: undefined,
|
|
589
|
+
emailType: emailType != null
|
|
590
|
+
? serializers.GetMetricsBreakdownRequestEmailType.jsonOrThrow(emailType, {
|
|
591
|
+
unrecognizedObjectKeys: "strip",
|
|
592
|
+
omitUndefined: true,
|
|
593
|
+
})
|
|
594
|
+
: undefined,
|
|
595
|
+
end: end != null ? end?.toISOString() : undefined,
|
|
596
|
+
includeMachineEngagement,
|
|
597
|
+
limit,
|
|
598
|
+
mailboxProvider,
|
|
599
|
+
period: period != null
|
|
600
|
+
? serializers.GetMetricsBreakdownRequestPeriod.jsonOrThrow(period, {
|
|
601
|
+
unrecognizedObjectKeys: "strip",
|
|
602
|
+
omitUndefined: true,
|
|
603
|
+
})
|
|
604
|
+
: undefined,
|
|
605
|
+
recipientDomain,
|
|
606
|
+
source,
|
|
607
|
+
start: start != null ? start?.toISOString() : undefined,
|
|
608
|
+
};
|
|
609
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
610
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
611
|
+
const _response = await core.fetcher({
|
|
612
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
613
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
614
|
+
environments.SequenzyEnvironment.Default, "metrics/breakdown"),
|
|
615
|
+
method: "GET",
|
|
616
|
+
headers: _headers,
|
|
617
|
+
queryString: core.url
|
|
618
|
+
.queryBuilder()
|
|
619
|
+
.addMany(_queryParams)
|
|
620
|
+
.mergeAdditional(requestOptions?.queryParams)
|
|
621
|
+
.build(),
|
|
622
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
623
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
624
|
+
abortSignal: requestOptions?.abortSignal,
|
|
625
|
+
fetchFn: this._options?.fetch,
|
|
626
|
+
logging: this._options.logging,
|
|
627
|
+
});
|
|
628
|
+
if (_response.ok) {
|
|
629
|
+
return {
|
|
630
|
+
data: serializers.GetMetricsBreakdownResponse.parseOrThrow(_response.body, {
|
|
631
|
+
unrecognizedObjectKeys: "passthrough",
|
|
632
|
+
allowUnrecognizedUnionMembers: true,
|
|
633
|
+
allowUnrecognizedEnumValues: true,
|
|
634
|
+
skipValidation: true,
|
|
635
|
+
breadcrumbsPrefix: ["response"],
|
|
636
|
+
}),
|
|
637
|
+
rawResponse: _response.rawResponse,
|
|
638
|
+
};
|
|
639
|
+
}
|
|
640
|
+
if (_response.error.reason === "status-code") {
|
|
641
|
+
switch (_response.error.statusCode) {
|
|
642
|
+
case 400:
|
|
643
|
+
throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
|
|
644
|
+
case 401:
|
|
645
|
+
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
646
|
+
case 403:
|
|
647
|
+
throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
648
|
+
case 404:
|
|
649
|
+
throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
|
|
650
|
+
case 500:
|
|
651
|
+
throw new Sequenzy.InternalServerError(_response.error.body, _response.rawResponse);
|
|
652
|
+
default:
|
|
653
|
+
throw new errors.SequenzyError({
|
|
654
|
+
statusCode: _response.error.statusCode,
|
|
655
|
+
body: _response.error.body,
|
|
656
|
+
rawResponse: _response.rawResponse,
|
|
657
|
+
});
|
|
658
|
+
}
|
|
659
|
+
}
|
|
660
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/metrics/breakdown");
|
|
661
|
+
}
|
|
555
662
|
/**
|
|
556
663
|
* Returns a paginated list of recipients with their open, click, and unsubscribe events. Use this to sync engagement data to your own database.
|
|
557
664
|
*
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {}
|
|
5
|
+
*/
|
|
6
|
+
export interface GetMetricsBreakdownRequest {
|
|
7
|
+
/** Dimension to group by. `email` has one row per campaign, sequence email step and transactional template. */
|
|
8
|
+
by?: Sequenzy.GetMetricsBreakdownRequestBy;
|
|
9
|
+
/** Structural email type filter. Marketer-role personal keys only see the emails their role can open and cannot request transactional. */
|
|
10
|
+
emailType?: Sequenzy.GetMetricsBreakdownRequestEmailType;
|
|
11
|
+
/** End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days. */
|
|
12
|
+
end?: Date;
|
|
13
|
+
/** Include detected scanner, preview, and tracked asset open/click events. */
|
|
14
|
+
includeMachineEngagement?: boolean;
|
|
15
|
+
/** Number of rows to return. */
|
|
16
|
+
limit?: number;
|
|
17
|
+
/** Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). */
|
|
18
|
+
mailboxProvider?: string;
|
|
19
|
+
/** Sliding window over send times. Ignored when start/end are provided. */
|
|
20
|
+
period?: Sequenzy.GetMetricsBreakdownRequestPeriod;
|
|
21
|
+
/** Recipient domain filter (e.g. gmail.com). Case-insensitive. */
|
|
22
|
+
recipientDomain?: string;
|
|
23
|
+
/** Email source filter as `<type>:<id>`: `campaign:<campaignId>`, `sequence:<sequenceId>`, `sequence_step:<email step id>` or `transactional:<transactional email id>`. Returns 404 when the source is not in the company or not visible to the key. */
|
|
24
|
+
source?: string;
|
|
25
|
+
/** Start of custom time range (ISO 8601). Must be used with `end`. */
|
|
26
|
+
start?: Date;
|
|
27
|
+
}
|
|
@@ -14,6 +14,10 @@ export interface GetMetricsRequest {
|
|
|
14
14
|
mailboxProvider?: string;
|
|
15
15
|
/** Sliding time window. Ignored when start/end are provided. */
|
|
16
16
|
period?: Sequenzy.GetMetricsRequestPeriod;
|
|
17
|
+
/** Recipient domain filter (e.g. gmail.com). Case-insensitive. */
|
|
18
|
+
recipientDomain?: string;
|
|
19
|
+
/** Email source filter as `<type>:<id>`: `campaign:<campaignId>`, `sequence:<sequenceId>`, `sequence_step:<email step id>` or `transactional:<transactional email id>`. Responses filtered by recipientDomain or source report replies as 0 and omit the commerce forecast. Returns 404 when the source is not in the company or not visible to the key. */
|
|
20
|
+
source?: string;
|
|
17
21
|
/** Start of custom time range (ISO 8601). Must be used with `end`. */
|
|
18
22
|
start?: Date;
|
|
19
23
|
}
|
|
@@ -3,6 +3,7 @@ export type { GetCampaignMetricsRequest } from "./GetCampaignMetricsRequest.js";
|
|
|
3
3
|
export type { GetCampaignStatsLegacyRequest } from "./GetCampaignStatsLegacyRequest.js";
|
|
4
4
|
export type { GetEmailClientMetricsRequest } from "./GetEmailClientMetricsRequest.js";
|
|
5
5
|
export type { GetLinkClickMetricsRequest } from "./GetLinkClickMetricsRequest.js";
|
|
6
|
+
export type { GetMetricsBreakdownRequest } from "./GetMetricsBreakdownRequest.js";
|
|
6
7
|
export type { GetMetricsRequest } from "./GetMetricsRequest.js";
|
|
7
8
|
export type { GetRecipientsRequest } from "./GetRecipientsRequest.js";
|
|
8
9
|
export type { GetSequenceMetricsRequest } from "./GetSequenceMetricsRequest.js";
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare const GetMetricsBreakdownRequestBy: {
|
|
2
|
+
readonly Email: "email";
|
|
3
|
+
readonly Sequence: "sequence";
|
|
4
|
+
readonly EmailType: "email_type";
|
|
5
|
+
readonly MailboxProvider: "mailbox_provider";
|
|
6
|
+
readonly RecipientDomain: "recipient_domain";
|
|
7
|
+
};
|
|
8
|
+
export type GetMetricsBreakdownRequestBy = (typeof GetMetricsBreakdownRequestBy)[keyof typeof GetMetricsBreakdownRequestBy];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetMetricsBreakdownRequestBy = void 0;
|
|
5
|
+
exports.GetMetricsBreakdownRequestBy = {
|
|
6
|
+
Email: "email",
|
|
7
|
+
Sequence: "sequence",
|
|
8
|
+
EmailType: "email_type",
|
|
9
|
+
MailboxProvider: "mailbox_provider",
|
|
10
|
+
RecipientDomain: "recipient_domain",
|
|
11
|
+
};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const GetMetricsBreakdownRequestEmailType: {
|
|
2
|
+
readonly Campaign: "campaign";
|
|
3
|
+
readonly Transactional: "transactional";
|
|
4
|
+
readonly Sequence: "sequence";
|
|
5
|
+
};
|
|
6
|
+
export type GetMetricsBreakdownRequestEmailType = (typeof GetMetricsBreakdownRequestEmailType)[keyof typeof GetMetricsBreakdownRequestEmailType];
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetMetricsBreakdownRequestEmailType = void 0;
|
|
5
|
+
exports.GetMetricsBreakdownRequestEmailType = {
|
|
6
|
+
Campaign: "campaign",
|
|
7
|
+
Transactional: "transactional",
|
|
8
|
+
Sequence: "sequence",
|
|
9
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare const GetMetricsBreakdownRequestPeriod: {
|
|
2
|
+
readonly OneH: "1h";
|
|
3
|
+
readonly TwentyFourH: "24h";
|
|
4
|
+
readonly SevenD: "7d";
|
|
5
|
+
readonly ThirtyD: "30d";
|
|
6
|
+
readonly NinetyD: "90d";
|
|
7
|
+
};
|
|
8
|
+
export type GetMetricsBreakdownRequestPeriod = (typeof GetMetricsBreakdownRequestPeriod)[keyof typeof GetMetricsBreakdownRequestPeriod];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetMetricsBreakdownRequestPeriod = void 0;
|
|
5
|
+
exports.GetMetricsBreakdownRequestPeriod = {
|
|
6
|
+
OneH: "1h",
|
|
7
|
+
TwentyFourH: "24h",
|
|
8
|
+
SevenD: "7d",
|
|
9
|
+
ThirtyD: "30d",
|
|
10
|
+
NinetyD: "90d",
|
|
11
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
2
|
+
export interface GetMetricsBreakdownResponse {
|
|
3
|
+
by: string;
|
|
4
|
+
emailType?: string;
|
|
5
|
+
end: Date;
|
|
6
|
+
mailboxProvider?: string;
|
|
7
|
+
/** Applied period, or `custom` when start/end were provided. */
|
|
8
|
+
period?: string;
|
|
9
|
+
recipientDomain?: string;
|
|
10
|
+
rows: Sequenzy.GetMetricsBreakdownResponseRowsItem[];
|
|
11
|
+
source?: string;
|
|
12
|
+
start: Date;
|
|
13
|
+
success: boolean;
|
|
14
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export interface GetMetricsBreakdownResponseRowsItem {
|
|
2
|
+
bounced: number;
|
|
3
|
+
/** Percentage of sent. */
|
|
4
|
+
bounceRate: number;
|
|
5
|
+
clicked: number;
|
|
6
|
+
/** Percentage of delivered. */
|
|
7
|
+
clickRate: number;
|
|
8
|
+
complained: number;
|
|
9
|
+
/** Attributed goal conversions. Provider and domain come from the send each conversion is attributed to. */
|
|
10
|
+
conversions?: number;
|
|
11
|
+
delivered: number;
|
|
12
|
+
/** Percentage of sent. */
|
|
13
|
+
deliveryRate: number;
|
|
14
|
+
/** Secondary label, such as the sequence an email step belongs to. */
|
|
15
|
+
detail?: string | null;
|
|
16
|
+
/** The filter that narrows a later request to this row: `{kind: "source", source: {type, id}}` (pass as `source=<type>:<id>`), `{kind: "email_type", emailType}`, `{kind: "mailbox_provider", mailboxProvider}` or `{kind: "recipient_domain", recipientDomain}`. Null when the row cannot be drilled into. */
|
|
17
|
+
filter?: Record<string, unknown> | null;
|
|
18
|
+
/** Dimension value (an id, email type, provider or domain). Empty when the events predate the column. */
|
|
19
|
+
key: string;
|
|
20
|
+
label: string;
|
|
21
|
+
opened: number;
|
|
22
|
+
/** Percentage of delivered. */
|
|
23
|
+
openRate: number;
|
|
24
|
+
/** Attributed revenue in currency units. */
|
|
25
|
+
revenue?: number;
|
|
26
|
+
sent: number;
|
|
27
|
+
unsubscribed: number;
|
|
28
|
+
/** Percentage of delivered. */
|
|
29
|
+
unsubscribeRate: number;
|
|
30
|
+
}
|
|
@@ -8,6 +8,10 @@ export interface GetMetricsResponse {
|
|
|
8
8
|
/** Echoed back when `mailboxProvider` is provided. */
|
|
9
9
|
mailboxProvider?: string;
|
|
10
10
|
period?: string;
|
|
11
|
+
/** Echoed back, lowercased, when `recipientDomain` is provided. */
|
|
12
|
+
recipientDomain?: string;
|
|
13
|
+
/** Echoed back when `source` is provided. */
|
|
14
|
+
source?: string;
|
|
11
15
|
stats?: Sequenzy.EngagementStats;
|
|
12
16
|
/** Live count of every stored contact in the company. Independent of the requested period. */
|
|
13
17
|
subscriberCount?: number;
|
|
@@ -11,6 +11,11 @@ export * from "./GetLinkClickMetricsRequestEmailType.js";
|
|
|
11
11
|
export * from "./GetLinkClickMetricsRequestPeriod.js";
|
|
12
12
|
export * from "./GetLinkClickMetricsResponse.js";
|
|
13
13
|
export * from "./GetLinkClickMetricsResponseEmailType.js";
|
|
14
|
+
export * from "./GetMetricsBreakdownRequestBy.js";
|
|
15
|
+
export * from "./GetMetricsBreakdownRequestEmailType.js";
|
|
16
|
+
export * from "./GetMetricsBreakdownRequestPeriod.js";
|
|
17
|
+
export * from "./GetMetricsBreakdownResponse.js";
|
|
18
|
+
export * from "./GetMetricsBreakdownResponseRowsItem.js";
|
|
14
19
|
export * from "./GetMetricsRequestEmailType.js";
|
|
15
20
|
export * from "./GetMetricsRequestPeriod.js";
|
|
16
21
|
export * from "./GetMetricsResponse.js";
|
|
@@ -27,6 +27,11 @@ __exportStar(require("./GetLinkClickMetricsRequestEmailType.js"), exports);
|
|
|
27
27
|
__exportStar(require("./GetLinkClickMetricsRequestPeriod.js"), exports);
|
|
28
28
|
__exportStar(require("./GetLinkClickMetricsResponse.js"), exports);
|
|
29
29
|
__exportStar(require("./GetLinkClickMetricsResponseEmailType.js"), exports);
|
|
30
|
+
__exportStar(require("./GetMetricsBreakdownRequestBy.js"), exports);
|
|
31
|
+
__exportStar(require("./GetMetricsBreakdownRequestEmailType.js"), exports);
|
|
32
|
+
__exportStar(require("./GetMetricsBreakdownRequestPeriod.js"), exports);
|
|
33
|
+
__exportStar(require("./GetMetricsBreakdownResponse.js"), exports);
|
|
34
|
+
__exportStar(require("./GetMetricsBreakdownResponseRowsItem.js"), exports);
|
|
30
35
|
__exportStar(require("./GetMetricsRequestEmailType.js"), exports);
|
|
31
36
|
__exportStar(require("./GetMetricsRequestPeriod.js"), exports);
|
|
32
37
|
__exportStar(require("./GetMetricsResponse.js"), exports);
|
|
@@ -182,6 +182,23 @@ export declare class IntegrationsClient {
|
|
|
182
182
|
*/
|
|
183
183
|
listCapabilities(request?: Sequenzy.ListCapabilitiesIntegrationsRequest, requestOptions?: IntegrationsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListCapabilitiesIntegrationsResponse>;
|
|
184
184
|
private __listCapabilities;
|
|
185
|
+
/**
|
|
186
|
+
* Suggests integrations to connect next, from what Sequenzy found on the company's website during onboarding: tools on the homepage or on the sign-in page it links to (Clerk, Supabase, PostHog, Segment, Webflow, Wix, WordPress, WooCommerce) or a Shopify storefront. Connected providers are left out. Payment providers are never guessed from the site: when it lists pricing and no payment or commerce integration is connected, paymentProviders lists every payment provider. Requires the account:read scope.
|
|
187
|
+
*
|
|
188
|
+
* @param {IntegrationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
189
|
+
*
|
|
190
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
191
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
192
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
193
|
+
* @throws {@link Sequenzy.ServiceUnavailableError}
|
|
194
|
+
* @throws {@link errors.SequenzyError}
|
|
195
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
196
|
+
*
|
|
197
|
+
* @example
|
|
198
|
+
* await client.integrations.listSuggestions()
|
|
199
|
+
*/
|
|
200
|
+
listSuggestions(requestOptions?: IntegrationsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListSuggestionsIntegrationsResponse>;
|
|
201
|
+
private __listSuggestions;
|
|
185
202
|
/**
|
|
186
203
|
* Queues a manual re-sync for a connected integration - customers and revenue for a payment provider (Stripe, Polar, Paddle, Dodo, Lemon Squeezy, Creem, Chargebee, Whop), the user backfill for Supabase, or the event-history import for PostHog and Segment. The Supabase sync reads the project, schema, and table already configured for the integration and returns 400 when none is configured. PostHog and Segment re-run their event-history imports with credentials stored at connect time and are the supported retry path for failed imports; each restarts from the beginning, already-imported events dedupe, and returns 409 while queued or syncing. Segment requires a saved Unify space ID and Profile API token and covers the most recent 14 days served by the Profile API. Terminal BullMQ failures release imports for retry. Returns immediately; poll the integration to watch syncStatus. Other providers re-sync from the dashboard. Requires the integrations:manage scope.
|
|
187
204
|
*
|
|
@@ -691,6 +691,72 @@ class IntegrationsClient {
|
|
|
691
691
|
}
|
|
692
692
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/integrations/catalog");
|
|
693
693
|
}
|
|
694
|
+
/**
|
|
695
|
+
* Suggests integrations to connect next, from what Sequenzy found on the company's website during onboarding: tools on the homepage or on the sign-in page it links to (Clerk, Supabase, PostHog, Segment, Webflow, Wix, WordPress, WooCommerce) or a Shopify storefront. Connected providers are left out. Payment providers are never guessed from the site: when it lists pricing and no payment or commerce integration is connected, paymentProviders lists every payment provider. Requires the account:read scope.
|
|
696
|
+
*
|
|
697
|
+
* @param {IntegrationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
698
|
+
*
|
|
699
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
700
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
701
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
702
|
+
* @throws {@link Sequenzy.ServiceUnavailableError}
|
|
703
|
+
* @throws {@link errors.SequenzyError}
|
|
704
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
705
|
+
*
|
|
706
|
+
* @example
|
|
707
|
+
* await client.integrations.listSuggestions()
|
|
708
|
+
*/
|
|
709
|
+
listSuggestions(requestOptions) {
|
|
710
|
+
return core.HttpResponsePromise.fromPromise(this.__listSuggestions(requestOptions));
|
|
711
|
+
}
|
|
712
|
+
async __listSuggestions(requestOptions) {
|
|
713
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
714
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
715
|
+
const _response = await core.fetcher({
|
|
716
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
717
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
718
|
+
environments.SequenzyEnvironment.Default, "integrations/suggestions"),
|
|
719
|
+
method: "GET",
|
|
720
|
+
headers: _headers,
|
|
721
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
722
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
723
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
724
|
+
abortSignal: requestOptions?.abortSignal,
|
|
725
|
+
fetchFn: this._options?.fetch,
|
|
726
|
+
logging: this._options.logging,
|
|
727
|
+
});
|
|
728
|
+
if (_response.ok) {
|
|
729
|
+
return {
|
|
730
|
+
data: serializers.ListSuggestionsIntegrationsResponse.parseOrThrow(_response.body, {
|
|
731
|
+
unrecognizedObjectKeys: "passthrough",
|
|
732
|
+
allowUnrecognizedUnionMembers: true,
|
|
733
|
+
allowUnrecognizedEnumValues: true,
|
|
734
|
+
skipValidation: true,
|
|
735
|
+
breadcrumbsPrefix: ["response"],
|
|
736
|
+
}),
|
|
737
|
+
rawResponse: _response.rawResponse,
|
|
738
|
+
};
|
|
739
|
+
}
|
|
740
|
+
if (_response.error.reason === "status-code") {
|
|
741
|
+
switch (_response.error.statusCode) {
|
|
742
|
+
case 401:
|
|
743
|
+
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
744
|
+
case 403:
|
|
745
|
+
throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
746
|
+
case 404:
|
|
747
|
+
throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
|
|
748
|
+
case 503:
|
|
749
|
+
throw new Sequenzy.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
750
|
+
default:
|
|
751
|
+
throw new errors.SequenzyError({
|
|
752
|
+
statusCode: _response.error.statusCode,
|
|
753
|
+
body: _response.error.body,
|
|
754
|
+
rawResponse: _response.rawResponse,
|
|
755
|
+
});
|
|
756
|
+
}
|
|
757
|
+
}
|
|
758
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/integrations/suggestions");
|
|
759
|
+
}
|
|
694
760
|
/**
|
|
695
761
|
* Queues a manual re-sync for a connected integration - customers and revenue for a payment provider (Stripe, Polar, Paddle, Dodo, Lemon Squeezy, Creem, Chargebee, Whop), the user backfill for Supabase, or the event-history import for PostHog and Segment. The Supabase sync reads the project, schema, and table already configured for the integration and returns 400 when none is configured. PostHog and Segment re-run their event-history imports with credentials stored at connect time and are the supported retry path for failed imports; each restarts from the beginning, already-imported events dedupe, and returns 409 while queued or syncing. Segment requires a saved Unify space ID and Profile API token and covers the most recent 14 days served by the Profile API. Terminal BullMQ failures release imports for retry. Returns immediately; poll the integration to watch syncStatus. Other providers re-sync from the dashboard. Requires the integrations:manage scope.
|
|
696
762
|
*
|
|
@@ -16,6 +16,6 @@ export interface ConnectIntegrationsRequest {
|
|
|
16
16
|
providerAccountId?: string;
|
|
17
17
|
/** PostHog and Segment: event delivery scope. Attio: listMap (Sequenzy list id to Attio list id or slug) and syncCompanyFromDomain. SparkLoop: listIds for new referrals. */
|
|
18
18
|
settings?: Sequenzy.ConnectIntegrationsRequestSettings;
|
|
19
|
-
/** Signing secret of the provider webhook. Optional for lemon_squeezy managed provisioning and not used by attio; required for other providers. Lemon Squeezy manual secrets use 16-40 characters. For Chargebee, pass username:password. For RevenueCat, pass at least 16 characters: the authorization header value set on the RevenueCat webhook, or its HMAC signing secret. For Superwall, pass the webhook's whsec_ signing secret, the only credential it needs. For Segment, use 16-153 UTF-8 bytes. For SparkLoop,
|
|
19
|
+
/** Signing secret of the provider webhook. Optional for lemon_squeezy managed provisioning and for sparkloop, and not used by attio; required for other providers. Lemon Squeezy manual secrets use 16-40 characters. For Chargebee, pass username:password. For RevenueCat, pass at least 16 characters: the authorization header value set on the RevenueCat webhook, or its HMAC signing secret. For Superwall, pass the webhook's whsec_ signing secret, the only credential it needs. For Segment, use 16-153 UTF-8 bytes. For SparkLoop, omit it so Sequenzy authenticates deliveries with a secret in the webhook URL it registers, or pass the account's webhook authentication token to verify the SparkLoop-Token header instead. */
|
|
20
20
|
webhookSecret?: string;
|
|
21
21
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
2
|
+
export interface ListSuggestionsIntegrationsResponse {
|
|
3
|
+
/** Present when the website lists pricing and no payment or commerce integration is connected; null otherwise. */
|
|
4
|
+
paymentProviders: Sequenzy.ListSuggestionsIntegrationsResponsePaymentProviders | null;
|
|
5
|
+
/** False while onboarding is still reading the website, including the tool scan, which can finish a few seconds after the rest. An empty list then means the site has not been scanned yet, not that nothing was found. */
|
|
6
|
+
scanComplete: boolean;
|
|
7
|
+
success: boolean;
|
|
8
|
+
/** Detected providers that are not connected, in suggestion order. */
|
|
9
|
+
suggestions: Sequenzy.ListSuggestionsIntegrationsResponseSuggestionsItem[];
|
|
10
|
+
/** The company website the suggestions were read from. */
|
|
11
|
+
websiteUrl: string | null;
|
|
12
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Present when the website lists pricing and no payment or commerce integration is connected; null otherwise.
|
|
4
|
+
*/
|
|
5
|
+
export interface ListSuggestionsIntegrationsResponsePaymentProviders {
|
|
6
|
+
/** Pricing plans read from the website or entered in settings. */
|
|
7
|
+
pricingPlanCount: number;
|
|
8
|
+
/** Every available payment provider. */
|
|
9
|
+
providers: Sequenzy.ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem[];
|
|
10
|
+
reason: Sequenzy.ListSuggestionsIntegrationsResponsePaymentProvidersReason;
|
|
11
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export declare const ListSuggestionsIntegrationsResponsePaymentProvidersReason: {
|
|
2
|
+
readonly PricingFound: "pricing_found";
|
|
3
|
+
};
|
|
4
|
+
export type ListSuggestionsIntegrationsResponsePaymentProvidersReason = (typeof ListSuggestionsIntegrationsResponsePaymentProvidersReason)[keyof typeof ListSuggestionsIntegrationsResponsePaymentProvidersReason];
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListSuggestionsIntegrationsResponsePaymentProvidersReason = void 0;
|
|
5
|
+
exports.ListSuggestionsIntegrationsResponsePaymentProvidersReason = {
|
|
6
|
+
PricingFound: "pricing_found",
|
|
7
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
2
|
+
export interface ListSuggestionsIntegrationsResponseSuggestionsItem {
|
|
3
|
+
category: string;
|
|
4
|
+
/** Where the provider was found. storefront means the site runs on Shopify. */
|
|
5
|
+
evidence: Sequenzy.ListSuggestionsIntegrationsResponseSuggestionsItemEvidence;
|
|
6
|
+
name: string;
|
|
7
|
+
provider: Sequenzy.ListSuggestionsIntegrationsResponseSuggestionsItemProvider;
|
|
8
|
+
/** The myshopify.com domain for a Shopify suggestion when one was found; null otherwise. */
|
|
9
|
+
shopDomain: string | null;
|
|
10
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** Where the provider was found. storefront means the site runs on Shopify. */
|
|
2
|
+
export declare const ListSuggestionsIntegrationsResponseSuggestionsItemEvidence: {
|
|
3
|
+
readonly Homepage: "homepage";
|
|
4
|
+
readonly SignInPage: "sign_in_page";
|
|
5
|
+
readonly Storefront: "storefront";
|
|
6
|
+
};
|
|
7
|
+
export type ListSuggestionsIntegrationsResponseSuggestionsItemEvidence = (typeof ListSuggestionsIntegrationsResponseSuggestionsItemEvidence)[keyof typeof ListSuggestionsIntegrationsResponseSuggestionsItemEvidence];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListSuggestionsIntegrationsResponseSuggestionsItemEvidence = void 0;
|
|
5
|
+
/** Where the provider was found. storefront means the site runs on Shopify. */
|
|
6
|
+
exports.ListSuggestionsIntegrationsResponseSuggestionsItemEvidence = {
|
|
7
|
+
Homepage: "homepage",
|
|
8
|
+
SignInPage: "sign_in_page",
|
|
9
|
+
Storefront: "storefront",
|
|
10
|
+
};
|