sequenzy 2.1.82 → 2.1.88
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/campaigns/client/Client.js +2 -1
- package/dist/cjs/api/resources/campaigns/client/requests/ListCampaignsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/campaigns/types/ListCampaignsResponsePagination.d.ts +4 -0
- package/dist/cjs/api/resources/inApp/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/inApp/client/Client.js +1 -1
- package/dist/cjs/api/resources/inApp/types/EstimateInAppCampaignRecipientsResponse.d.ts +2 -0
- package/dist/cjs/api/resources/media/client/Client.d.ts +23 -0
- package/dist/cjs/api/resources/media/client/Client.js +90 -0
- package/dist/cjs/api/resources/media/client/requests/CropEmailImageRequest.d.ts +21 -0
- package/dist/cjs/api/resources/media/client/requests/CropEmailImageRequest.js +3 -0
- package/dist/cjs/api/resources/media/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageRequestAspectRatio.d.ts +4 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageRequestAspectRatio.js +3 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageRequestCrop.d.ts +9 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageRequestCrop.js +3 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageResponse.d.ts +12 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageResponse.js +3 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageResponseAsset.d.ts +15 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageResponseAsset.js +3 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageResponseCrop.d.ts +11 -0
- package/dist/cjs/api/resources/media/types/CropEmailImageResponseCrop.js +3 -0
- package/dist/cjs/api/resources/media/types/index.d.ts +5 -0
- package/dist/cjs/api/resources/media/types/index.js +5 -0
- package/dist/cjs/api/resources/push/client/requests/SendTestPushRequest.d.ts +2 -0
- package/dist/cjs/api/resources/push/client/requests/TranslatePushContentRequest.d.ts +2 -0
- package/dist/cjs/api/resources/push/types/TranslatePushContentRequestPlatformsItem.d.ts +6 -0
- package/dist/cjs/api/resources/push/types/TranslatePushContentRequestPlatformsItem.js +9 -0
- package/dist/cjs/api/resources/push/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/push/types/index.js +1 -0
- package/dist/cjs/api/resources/segments/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/segments/client/Client.js +1 -1
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponse.d.ts +9 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.d.ts +4 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.js +3 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.d.ts +7 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.js +3 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.d.ts +4 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.js +3 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.d.ts +8 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.js +3 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.d.ts +6 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.js +9 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.d.ts +8 -0
- package/dist/cjs/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.js +11 -0
- package/dist/cjs/api/resources/segments/types/index.d.ts +6 -0
- package/dist/cjs/api/resources/segments/types/index.js +6 -0
- package/dist/cjs/api/resources/sequences/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/sequences/client/Client.js +4 -3
- package/dist/cjs/api/resources/sequences/client/requests/ListSequencesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/sequences/types/DeleteSequencesResponse.d.ts +5 -0
- package/dist/cjs/api/resources/sequences/types/DeleteSequencesResponse.js +3 -0
- package/dist/cjs/api/resources/sequences/types/ListSequencesResponsePagination.d.ts +4 -0
- package/dist/cjs/api/resources/sequences/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/sequences/types/index.js +1 -0
- package/dist/cjs/api/resources/subscribers/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/subscribers/client/Client.js +4 -4
- package/dist/cjs/api/resources/subscribers/resources/events/types/TriggerBulkEventsResponse.d.ts +3 -0
- package/dist/cjs/api/resources/subscribers/resources/events/types/TriggerEventsResponse.d.ts +3 -0
- package/dist/cjs/api/resources/subscribers/resources/tags/client/Client.d.ts +3 -1
- package/dist/cjs/api/resources/subscribers/resources/tags/client/Client.js +7 -1
- package/dist/cjs/api/resources/subscribers/resources/tags/client/requests/RemoveTagsRequest.d.ts +3 -3
- package/dist/cjs/api/resources/subscribers/resources/tags/types/AddTagsResponse.d.ts +3 -0
- package/dist/cjs/api/resources/subscribers/resources/tags/types/RemoveTagsResponse.d.ts +2 -0
- package/dist/cjs/api/resources/subscribers/resources/tags/types/RemoveTagsResponseSubscriber.d.ts +1 -1
- package/dist/cjs/api/resources/subscribers/types/AddTagsBulkResponse.d.ts +3 -0
- package/dist/cjs/api/resources/subscribers/types/CreateSubscribersResponse.d.ts +3 -0
- package/dist/cjs/api/resources/subscribers/types/ImportEventsSubscribersResponse.d.ts +3 -0
- package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdSubscribersResponse.d.ts +3 -0
- package/dist/cjs/api/resources/subscribers/types/UpdateSubscribersResponse.d.ts +3 -0
- package/dist/cjs/api/resources/templates/client/Client.js +2 -1
- package/dist/cjs/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/templates/types/ListTemplatesResponsePagination.d.ts +4 -0
- package/dist/cjs/api/types/FilterLeaf.d.ts +1 -1
- package/dist/cjs/api/types/FilterLeafField.d.ts +1 -0
- package/dist/cjs/api/types/FilterLeafField.js +1 -0
- package/dist/cjs/api/types/FilterLeafOperator.d.ts +3 -1
- package/dist/cjs/api/types/FilterLeafOperator.js +3 -1
- package/dist/cjs/api/types/SequenceTriggerWarnings.d.ts +4 -0
- package/dist/cjs/api/types/SequenceTriggerWarnings.js +3 -0
- package/dist/cjs/api/types/SequenceTriggersRan.d.ts +4 -0
- package/dist/cjs/api/types/SequenceTriggersRan.js +3 -0
- package/dist/cjs/api/types/SequenceTriggersSkippedReason.d.ts +7 -0
- package/dist/cjs/api/types/SequenceTriggersSkippedReason.js +10 -0
- package/dist/cjs/api/types/SubscriberImport.d.ts +1 -0
- package/dist/cjs/api/types/SubscriberImportListQuality.d.ts +20 -0
- package/dist/cjs/api/types/SubscriberImportListQuality.js +3 -0
- package/dist/cjs/api/types/SubscriberImportListQualityIssuesItem.d.ts +7 -0
- package/dist/cjs/api/types/SubscriberImportListQualityIssuesItem.js +3 -0
- package/dist/cjs/api/types/SubscriberImportListQualityIssuesItemKind.d.ts +7 -0
- package/dist/cjs/api/types/SubscriberImportListQualityIssuesItemKind.js +10 -0
- package/dist/cjs/api/types/SubscriberImportListQualityStatus.d.ts +4 -0
- package/dist/cjs/api/types/SubscriberImportListQualityStatus.js +7 -0
- package/dist/cjs/api/types/index.d.ts +7 -0
- package/dist/cjs/api/types/index.js +7 -0
- package/dist/cjs/serialization/resources/campaigns/types/ListCampaignsResponsePagination.d.ts +2 -0
- package/dist/cjs/serialization/resources/campaigns/types/ListCampaignsResponsePagination.js +2 -0
- package/dist/cjs/serialization/resources/inApp/types/EstimateInAppCampaignRecipientsResponse.d.ts +1 -0
- package/dist/cjs/serialization/resources/inApp/types/EstimateInAppCampaignRecipientsResponse.js +1 -0
- package/dist/cjs/serialization/resources/media/client/requests/CropEmailImageRequest.d.ts +16 -0
- package/dist/cjs/serialization/resources/media/client/requests/CropEmailImageRequest.js +38 -0
- package/dist/cjs/serialization/resources/media/client/requests/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/media/client/requests/index.js +3 -1
- package/dist/cjs/serialization/resources/media/types/CropEmailImageRequestAspectRatio.d.ts +7 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageRequestAspectRatio.js +29 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageRequestCrop.d.ts +12 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageRequestCrop.js +34 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageResponse.d.ts +15 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageResponse.js +37 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageResponseAsset.d.ts +18 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageResponseAsset.js +40 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageResponseCrop.d.ts +14 -0
- package/dist/cjs/serialization/resources/media/types/CropEmailImageResponseCrop.js +36 -0
- package/dist/cjs/serialization/resources/media/types/index.d.ts +5 -0
- package/dist/cjs/serialization/resources/media/types/index.js +5 -0
- package/dist/cjs/serialization/resources/push/client/requests/SendTestPushRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/push/client/requests/SendTestPushRequest.js +2 -0
- package/dist/cjs/serialization/resources/push/client/requests/TranslatePushContentRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/push/client/requests/TranslatePushContentRequest.js +2 -0
- package/dist/cjs/serialization/resources/push/types/TranslatePushContentRequestPlatformsItem.d.ts +7 -0
- package/dist/cjs/serialization/resources/push/types/TranslatePushContentRequestPlatformsItem.js +29 -0
- package/dist/cjs/serialization/resources/push/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/push/types/index.js +1 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponse.d.ts +8 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponse.js +8 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.d.ts +10 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.js +32 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.d.ts +12 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.js +34 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.d.ts +10 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.js +32 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.d.ts +14 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.js +36 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.d.ts +7 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.js +29 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.d.ts +7 -0
- package/dist/cjs/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.js +29 -0
- package/dist/cjs/serialization/resources/segments/types/index.d.ts +6 -0
- package/dist/cjs/serialization/resources/segments/types/index.js +6 -0
- package/dist/cjs/serialization/resources/sequences/types/DeleteSequencesResponse.d.ts +10 -0
- package/dist/cjs/serialization/resources/sequences/types/DeleteSequencesResponse.js +34 -0
- package/dist/cjs/serialization/resources/sequences/types/ListSequencesResponsePagination.d.ts +2 -0
- package/dist/cjs/serialization/resources/sequences/types/ListSequencesResponsePagination.js +2 -0
- package/dist/cjs/serialization/resources/sequences/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/sequences/types/index.js +1 -0
- package/dist/cjs/serialization/resources/subscribers/resources/events/types/TriggerBulkEventsResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/resources/events/types/TriggerBulkEventsResponse.js +6 -0
- package/dist/cjs/serialization/resources/subscribers/resources/events/types/TriggerEventsResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/resources/events/types/TriggerEventsResponse.js +6 -0
- package/dist/cjs/serialization/resources/subscribers/resources/tags/types/AddTagsResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/resources/tags/types/AddTagsResponse.js +6 -0
- package/dist/cjs/serialization/resources/subscribers/resources/tags/types/RemoveTagsResponse.d.ts +1 -0
- package/dist/cjs/serialization/resources/subscribers/resources/tags/types/RemoveTagsResponse.js +1 -0
- package/dist/cjs/serialization/resources/subscribers/types/AddTagsBulkResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/AddTagsBulkResponse.js +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/CreateSubscribersResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/CreateSubscribersResponse.js +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/ImportEventsSubscribersResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/ImportEventsSubscribersResponse.js +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersResponse.js +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersResponse.d.ts +6 -0
- package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersResponse.js +6 -0
- package/dist/cjs/serialization/resources/templates/types/ListTemplatesResponsePagination.d.ts +2 -0
- package/dist/cjs/serialization/resources/templates/types/ListTemplatesResponsePagination.js +2 -0
- package/dist/cjs/serialization/types/FilterLeafField.d.ts +1 -1
- package/dist/cjs/serialization/types/FilterLeafField.js +1 -0
- package/dist/cjs/serialization/types/FilterLeafOperator.d.ts +1 -1
- package/dist/cjs/serialization/types/FilterLeafOperator.js +2 -0
- package/dist/cjs/serialization/types/SequenceTriggerWarnings.d.ts +7 -0
- package/dist/cjs/serialization/types/SequenceTriggerWarnings.js +29 -0
- package/dist/cjs/serialization/types/SequenceTriggersRan.d.ts +7 -0
- package/dist/cjs/serialization/types/SequenceTriggersRan.js +29 -0
- package/dist/cjs/serialization/types/SequenceTriggersSkippedReason.d.ts +7 -0
- package/dist/cjs/serialization/types/SequenceTriggersSkippedReason.js +29 -0
- package/dist/cjs/serialization/types/SubscriberImport.d.ts +2 -0
- package/dist/cjs/serialization/types/SubscriberImport.js +2 -0
- package/dist/cjs/serialization/types/SubscriberImportListQuality.d.ts +18 -0
- package/dist/cjs/serialization/types/SubscriberImportListQuality.js +40 -0
- package/dist/cjs/serialization/types/SubscriberImportListQualityIssuesItem.d.ts +11 -0
- package/dist/cjs/serialization/types/SubscriberImportListQualityIssuesItem.js +33 -0
- package/dist/cjs/serialization/types/SubscriberImportListQualityIssuesItemKind.d.ts +7 -0
- package/dist/cjs/serialization/types/SubscriberImportListQualityIssuesItemKind.js +29 -0
- package/dist/cjs/serialization/types/SubscriberImportListQualityStatus.d.ts +7 -0
- package/dist/cjs/serialization/types/SubscriberImportListQualityStatus.js +29 -0
- package/dist/cjs/serialization/types/index.d.ts +7 -0
- package/dist/cjs/serialization/types/index.js +7 -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/campaigns/client/Client.js +2 -1
- package/dist/esm/api/resources/campaigns/client/requests/ListCampaignsRequest.d.ts +2 -0
- package/dist/esm/api/resources/campaigns/types/ListCampaignsResponsePagination.d.ts +4 -0
- package/dist/esm/api/resources/inApp/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/inApp/client/Client.js +1 -1
- package/dist/esm/api/resources/inApp/types/EstimateInAppCampaignRecipientsResponse.d.ts +2 -0
- package/dist/esm/api/resources/media/client/Client.d.ts +23 -0
- package/dist/esm/api/resources/media/client/Client.js +90 -0
- package/dist/esm/api/resources/media/client/requests/CropEmailImageRequest.d.ts +21 -0
- package/dist/esm/api/resources/media/client/requests/CropEmailImageRequest.js +2 -0
- package/dist/esm/api/resources/media/client/requests/index.d.ts +1 -0
- package/dist/esm/api/resources/media/types/CropEmailImageRequestAspectRatio.d.ts +4 -0
- package/dist/esm/api/resources/media/types/CropEmailImageRequestAspectRatio.js +2 -0
- package/dist/esm/api/resources/media/types/CropEmailImageRequestCrop.d.ts +9 -0
- package/dist/esm/api/resources/media/types/CropEmailImageRequestCrop.js +2 -0
- package/dist/esm/api/resources/media/types/CropEmailImageResponse.d.ts +12 -0
- package/dist/esm/api/resources/media/types/CropEmailImageResponse.js +2 -0
- package/dist/esm/api/resources/media/types/CropEmailImageResponseAsset.d.ts +15 -0
- package/dist/esm/api/resources/media/types/CropEmailImageResponseAsset.js +2 -0
- package/dist/esm/api/resources/media/types/CropEmailImageResponseCrop.d.ts +11 -0
- package/dist/esm/api/resources/media/types/CropEmailImageResponseCrop.js +2 -0
- package/dist/esm/api/resources/media/types/index.d.ts +5 -0
- package/dist/esm/api/resources/media/types/index.js +5 -0
- package/dist/esm/api/resources/push/client/requests/SendTestPushRequest.d.ts +2 -0
- package/dist/esm/api/resources/push/client/requests/TranslatePushContentRequest.d.ts +2 -0
- package/dist/esm/api/resources/push/types/TranslatePushContentRequestPlatformsItem.d.ts +6 -0
- package/dist/esm/api/resources/push/types/TranslatePushContentRequestPlatformsItem.js +6 -0
- package/dist/esm/api/resources/push/types/index.d.ts +1 -0
- package/dist/esm/api/resources/push/types/index.js +1 -0
- package/dist/esm/api/resources/segments/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/segments/client/Client.js +1 -1
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponse.d.ts +9 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.d.ts +4 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.js +2 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.d.ts +7 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.js +2 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.d.ts +4 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.js +2 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.d.ts +8 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.js +2 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.d.ts +6 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.js +6 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.d.ts +8 -0
- package/dist/esm/api/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.js +8 -0
- package/dist/esm/api/resources/segments/types/index.d.ts +6 -0
- package/dist/esm/api/resources/segments/types/index.js +6 -0
- package/dist/esm/api/resources/sequences/client/Client.d.ts +2 -2
- package/dist/esm/api/resources/sequences/client/Client.js +4 -3
- package/dist/esm/api/resources/sequences/client/requests/ListSequencesRequest.d.ts +2 -0
- package/dist/esm/api/resources/sequences/types/DeleteSequencesResponse.d.ts +5 -0
- package/dist/esm/api/resources/sequences/types/DeleteSequencesResponse.js +2 -0
- package/dist/esm/api/resources/sequences/types/ListSequencesResponsePagination.d.ts +4 -0
- package/dist/esm/api/resources/sequences/types/index.d.ts +1 -0
- package/dist/esm/api/resources/sequences/types/index.js +1 -0
- package/dist/esm/api/resources/subscribers/client/Client.d.ts +4 -4
- package/dist/esm/api/resources/subscribers/client/Client.js +4 -4
- package/dist/esm/api/resources/subscribers/resources/events/types/TriggerBulkEventsResponse.d.ts +3 -0
- package/dist/esm/api/resources/subscribers/resources/events/types/TriggerEventsResponse.d.ts +3 -0
- package/dist/esm/api/resources/subscribers/resources/tags/client/Client.d.ts +3 -1
- package/dist/esm/api/resources/subscribers/resources/tags/client/Client.js +7 -1
- package/dist/esm/api/resources/subscribers/resources/tags/client/requests/RemoveTagsRequest.d.ts +3 -3
- package/dist/esm/api/resources/subscribers/resources/tags/types/AddTagsResponse.d.ts +3 -0
- package/dist/esm/api/resources/subscribers/resources/tags/types/RemoveTagsResponse.d.ts +2 -0
- package/dist/esm/api/resources/subscribers/resources/tags/types/RemoveTagsResponseSubscriber.d.ts +1 -1
- package/dist/esm/api/resources/subscribers/types/AddTagsBulkResponse.d.ts +3 -0
- package/dist/esm/api/resources/subscribers/types/CreateSubscribersResponse.d.ts +3 -0
- package/dist/esm/api/resources/subscribers/types/ImportEventsSubscribersResponse.d.ts +3 -0
- package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersResponse.d.ts +3 -0
- package/dist/esm/api/resources/subscribers/types/UpdateSubscribersResponse.d.ts +3 -0
- package/dist/esm/api/resources/templates/client/Client.js +2 -1
- package/dist/esm/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +2 -0
- package/dist/esm/api/resources/templates/types/ListTemplatesResponsePagination.d.ts +4 -0
- package/dist/esm/api/types/FilterLeaf.d.ts +1 -1
- package/dist/esm/api/types/FilterLeafField.d.ts +1 -0
- package/dist/esm/api/types/FilterLeafField.js +1 -0
- package/dist/esm/api/types/FilterLeafOperator.d.ts +3 -1
- package/dist/esm/api/types/FilterLeafOperator.js +3 -1
- package/dist/esm/api/types/SequenceTriggerWarnings.d.ts +4 -0
- package/dist/esm/api/types/SequenceTriggerWarnings.js +2 -0
- package/dist/esm/api/types/SequenceTriggersRan.d.ts +4 -0
- package/dist/esm/api/types/SequenceTriggersRan.js +2 -0
- package/dist/esm/api/types/SequenceTriggersSkippedReason.d.ts +7 -0
- package/dist/esm/api/types/SequenceTriggersSkippedReason.js +7 -0
- package/dist/esm/api/types/SubscriberImport.d.ts +1 -0
- package/dist/esm/api/types/SubscriberImportListQuality.d.ts +20 -0
- package/dist/esm/api/types/SubscriberImportListQuality.js +2 -0
- package/dist/esm/api/types/SubscriberImportListQualityIssuesItem.d.ts +7 -0
- package/dist/esm/api/types/SubscriberImportListQualityIssuesItem.js +2 -0
- package/dist/esm/api/types/SubscriberImportListQualityIssuesItemKind.d.ts +7 -0
- package/dist/esm/api/types/SubscriberImportListQualityIssuesItemKind.js +7 -0
- package/dist/esm/api/types/SubscriberImportListQualityStatus.d.ts +4 -0
- package/dist/esm/api/types/SubscriberImportListQualityStatus.js +4 -0
- package/dist/esm/api/types/index.d.ts +7 -0
- package/dist/esm/api/types/index.js +7 -0
- package/dist/esm/serialization/resources/campaigns/types/ListCampaignsResponsePagination.d.ts +2 -0
- package/dist/esm/serialization/resources/campaigns/types/ListCampaignsResponsePagination.js +2 -0
- package/dist/esm/serialization/resources/inApp/types/EstimateInAppCampaignRecipientsResponse.d.ts +1 -0
- package/dist/esm/serialization/resources/inApp/types/EstimateInAppCampaignRecipientsResponse.js +1 -0
- package/dist/esm/serialization/resources/media/client/requests/CropEmailImageRequest.d.ts +16 -0
- package/dist/esm/serialization/resources/media/client/requests/CropEmailImageRequest.js +12 -0
- package/dist/esm/serialization/resources/media/client/requests/index.d.ts +1 -0
- package/dist/esm/serialization/resources/media/client/requests/index.js +1 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageRequestAspectRatio.d.ts +7 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageRequestAspectRatio.js +3 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageRequestCrop.d.ts +12 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageRequestCrop.js +8 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageResponse.d.ts +15 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageResponse.js +11 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageResponseAsset.d.ts +18 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageResponseAsset.js +14 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageResponseCrop.d.ts +14 -0
- package/dist/esm/serialization/resources/media/types/CropEmailImageResponseCrop.js +10 -0
- package/dist/esm/serialization/resources/media/types/index.d.ts +5 -0
- package/dist/esm/serialization/resources/media/types/index.js +5 -0
- package/dist/esm/serialization/resources/push/client/requests/SendTestPushRequest.d.ts +2 -0
- package/dist/esm/serialization/resources/push/client/requests/SendTestPushRequest.js +2 -0
- package/dist/esm/serialization/resources/push/client/requests/TranslatePushContentRequest.d.ts +2 -0
- package/dist/esm/serialization/resources/push/client/requests/TranslatePushContentRequest.js +2 -0
- package/dist/esm/serialization/resources/push/types/TranslatePushContentRequestPlatformsItem.d.ts +7 -0
- package/dist/esm/serialization/resources/push/types/TranslatePushContentRequestPlatformsItem.js +3 -0
- package/dist/esm/serialization/resources/push/types/index.d.ts +1 -0
- package/dist/esm/serialization/resources/push/types/index.js +1 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponse.d.ts +8 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponse.js +8 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.d.ts +10 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedAudienceSyncsItem.js +6 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.d.ts +12 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedCampaignsItem.js +8 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.d.ts +10 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSegmentsItem.js +6 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.d.ts +14 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItem.js +10 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.d.ts +7 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemStatus.js +3 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.d.ts +7 -0
- package/dist/esm/serialization/resources/segments/types/DeleteSegmentsResponseAffectedSequencesItemUsagesItem.js +3 -0
- package/dist/esm/serialization/resources/segments/types/index.d.ts +6 -0
- package/dist/esm/serialization/resources/segments/types/index.js +6 -0
- package/dist/esm/serialization/resources/sequences/types/DeleteSequencesResponse.d.ts +10 -0
- package/dist/esm/serialization/resources/sequences/types/DeleteSequencesResponse.js +8 -0
- package/dist/esm/serialization/resources/sequences/types/ListSequencesResponsePagination.d.ts +2 -0
- package/dist/esm/serialization/resources/sequences/types/ListSequencesResponsePagination.js +2 -0
- package/dist/esm/serialization/resources/sequences/types/index.d.ts +1 -0
- package/dist/esm/serialization/resources/sequences/types/index.js +1 -0
- package/dist/esm/serialization/resources/subscribers/resources/events/types/TriggerBulkEventsResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/resources/events/types/TriggerBulkEventsResponse.js +6 -0
- package/dist/esm/serialization/resources/subscribers/resources/events/types/TriggerEventsResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/resources/events/types/TriggerEventsResponse.js +6 -0
- package/dist/esm/serialization/resources/subscribers/resources/tags/types/AddTagsResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/resources/tags/types/AddTagsResponse.js +6 -0
- package/dist/esm/serialization/resources/subscribers/resources/tags/types/RemoveTagsResponse.d.ts +1 -0
- package/dist/esm/serialization/resources/subscribers/resources/tags/types/RemoveTagsResponse.js +1 -0
- package/dist/esm/serialization/resources/subscribers/types/AddTagsBulkResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/types/AddTagsBulkResponse.js +6 -0
- package/dist/esm/serialization/resources/subscribers/types/CreateSubscribersResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/types/CreateSubscribersResponse.js +6 -0
- package/dist/esm/serialization/resources/subscribers/types/ImportEventsSubscribersResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/types/ImportEventsSubscribersResponse.js +6 -0
- package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersResponse.js +6 -0
- package/dist/esm/serialization/resources/subscribers/types/UpdateSubscribersResponse.d.ts +6 -0
- package/dist/esm/serialization/resources/subscribers/types/UpdateSubscribersResponse.js +6 -0
- package/dist/esm/serialization/resources/templates/types/ListTemplatesResponsePagination.d.ts +2 -0
- package/dist/esm/serialization/resources/templates/types/ListTemplatesResponsePagination.js +2 -0
- package/dist/esm/serialization/types/FilterLeafField.d.ts +1 -1
- package/dist/esm/serialization/types/FilterLeafField.js +1 -0
- package/dist/esm/serialization/types/FilterLeafOperator.d.ts +1 -1
- package/dist/esm/serialization/types/FilterLeafOperator.js +2 -0
- package/dist/esm/serialization/types/SequenceTriggerWarnings.d.ts +7 -0
- package/dist/esm/serialization/types/SequenceTriggerWarnings.js +3 -0
- package/dist/esm/serialization/types/SequenceTriggersRan.d.ts +7 -0
- package/dist/esm/serialization/types/SequenceTriggersRan.js +3 -0
- package/dist/esm/serialization/types/SequenceTriggersSkippedReason.d.ts +7 -0
- package/dist/esm/serialization/types/SequenceTriggersSkippedReason.js +3 -0
- package/dist/esm/serialization/types/SubscriberImport.d.ts +2 -0
- package/dist/esm/serialization/types/SubscriberImport.js +2 -0
- package/dist/esm/serialization/types/SubscriberImportListQuality.d.ts +18 -0
- package/dist/esm/serialization/types/SubscriberImportListQuality.js +14 -0
- package/dist/esm/serialization/types/SubscriberImportListQualityIssuesItem.d.ts +11 -0
- package/dist/esm/serialization/types/SubscriberImportListQualityIssuesItem.js +7 -0
- package/dist/esm/serialization/types/SubscriberImportListQualityIssuesItemKind.d.ts +7 -0
- package/dist/esm/serialization/types/SubscriberImportListQualityIssuesItemKind.js +3 -0
- package/dist/esm/serialization/types/SubscriberImportListQualityStatus.d.ts +7 -0
- package/dist/esm/serialization/types/SubscriberImportListQualityStatus.js +3 -0
- package/dist/esm/serialization/types/index.d.ts +7 -0
- package/dist/esm/serialization/types/index.js +7 -0
- package/package.json +1 -1
|
@@ -838,7 +838,7 @@ class SequencesClient {
|
|
|
838
838
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/goals");
|
|
839
839
|
}
|
|
840
840
|
/**
|
|
841
|
-
* Deletes a sequence and its
|
|
841
|
+
* Deletes a sequence and its steps. Contacts still in it are removed and get none of its remaining steps; `contactsInSequence` says how many.
|
|
842
842
|
*
|
|
843
843
|
* @param {Sequenzy.DeleteSequencesRequest} request
|
|
844
844
|
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -877,7 +877,7 @@ class SequencesClient {
|
|
|
877
877
|
});
|
|
878
878
|
if (_response.ok) {
|
|
879
879
|
return {
|
|
880
|
-
data: serializers.
|
|
880
|
+
data: serializers.DeleteSequencesResponse.parseOrThrow(_response.body, {
|
|
881
881
|
unrecognizedObjectKeys: "passthrough",
|
|
882
882
|
allowUnrecognizedUnionMembers: true,
|
|
883
883
|
allowUnrecognizedEnumValues: true,
|
|
@@ -2544,12 +2544,13 @@ class SequencesClient {
|
|
|
2544
2544
|
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
2545
2545
|
}
|
|
2546
2546
|
async __list(request = {}, requestOptions) {
|
|
2547
|
-
const { label, labels, limit, offset, search, status } = request;
|
|
2547
|
+
const { label, labels, limit, offset, page, search, status } = request;
|
|
2548
2548
|
const _queryParams = {
|
|
2549
2549
|
label,
|
|
2550
2550
|
labels,
|
|
2551
2551
|
limit,
|
|
2552
2552
|
offset,
|
|
2553
|
+
page,
|
|
2553
2554
|
search,
|
|
2554
2555
|
status: status != null
|
|
2555
2556
|
? serializers.SequenceStatus.jsonOrThrow(status, {
|
|
@@ -11,6 +11,8 @@ export interface ListSequencesRequest {
|
|
|
11
11
|
/** Page size, up to 100. When limit and offset are both omitted, every sequence is returned. */
|
|
12
12
|
limit?: number;
|
|
13
13
|
offset?: number;
|
|
14
|
+
/** Optional 1-based page number, used only with limit and without offset. page alone does not enable pagination, so every sequence is still returned. A malformed page is ignored. */
|
|
15
|
+
page?: number;
|
|
14
16
|
/** Case-insensitive name or description search. */
|
|
15
17
|
search?: string;
|
|
16
18
|
status?: Sequenzy.SequenceStatus;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
2
|
+
export interface DeleteSequencesResponse extends Sequenzy.SequenceActionResponse {
|
|
3
|
+
/** Contacts who were still in the sequence (running a step, waiting, or paused) when it was deleted. They were removed and get none of its remaining steps. */
|
|
4
|
+
contactsInSequence?: number;
|
|
5
|
+
}
|
|
@@ -4,5 +4,9 @@ export interface ListSequencesResponsePagination {
|
|
|
4
4
|
/** Applied page size, or null when the unpaginated default returned every sequence. */
|
|
5
5
|
limit?: number | null;
|
|
6
6
|
offset?: number;
|
|
7
|
+
/** 1-based page that starts at offset. */
|
|
8
|
+
page?: number;
|
|
7
9
|
total?: number;
|
|
10
|
+
/** Pages at this limit; 1 for an unpaginated response with results. */
|
|
11
|
+
totalPages?: number;
|
|
8
12
|
}
|
|
@@ -15,6 +15,7 @@ export * from "./CreateFromTemplateSequencesResponseSequenceChannelsItem.js";
|
|
|
15
15
|
export * from "./CreateFromTemplateSequencesResponseSequenceEnrichmentStatus.js";
|
|
16
16
|
export * from "./CreateGoalSequencesResponse.js";
|
|
17
17
|
export * from "./DeleteGoalSequencesResponse.js";
|
|
18
|
+
export * from "./DeleteSequencesResponse.js";
|
|
18
19
|
export * from "./DiscardEmailVariationSequencesResponse.js";
|
|
19
20
|
export * from "./DuplicateSequencesResponse.js";
|
|
20
21
|
export * from "./EditEmailsSequencesResponse.js";
|
|
@@ -31,6 +31,7 @@ __exportStar(require("./CreateFromTemplateSequencesResponseSequenceChannelsItem.
|
|
|
31
31
|
__exportStar(require("./CreateFromTemplateSequencesResponseSequenceEnrichmentStatus.js"), exports);
|
|
32
32
|
__exportStar(require("./CreateGoalSequencesResponse.js"), exports);
|
|
33
33
|
__exportStar(require("./DeleteGoalSequencesResponse.js"), exports);
|
|
34
|
+
__exportStar(require("./DeleteSequencesResponse.js"), exports);
|
|
34
35
|
__exportStar(require("./DiscardEmailVariationSequencesResponse.js"), exports);
|
|
35
36
|
__exportStar(require("./DuplicateSequencesResponse.js"), exports);
|
|
36
37
|
__exportStar(require("./EditEmailsSequencesResponse.js"), exports);
|
|
@@ -20,7 +20,7 @@ export declare class SubscribersClient {
|
|
|
20
20
|
get events(): EventsClient;
|
|
21
21
|
get tags(): TagsClient;
|
|
22
22
|
/**
|
|
23
|
-
* Adds
|
|
23
|
+
* One contact, several tags. Adds several tags to a single subscriber identified by email or externalId. Creates the subscriber if they don't exist. To add tags to many existing subscribers without creating contacts, use POST /subscribers/bulk/tags/add. Creates tag definitions if they don't exist. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, the confirmation email is queued, and tag automations wait at their trigger until the subscriber confirms.
|
|
24
24
|
*
|
|
25
25
|
* @param {Sequenzy.AddTagsBulkRequest} request
|
|
26
26
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -38,7 +38,7 @@ export declare class SubscribersClient {
|
|
|
38
38
|
addTagsBulk(request: Sequenzy.AddTagsBulkRequest, requestOptions?: SubscribersClient.RequestOptions): core.HttpResponsePromise<Sequenzy.AddTagsBulkResponse>;
|
|
39
39
|
private __addTagsBulk;
|
|
40
40
|
/**
|
|
41
|
-
* Adds one or more tags to up to 500 existing subscribers identified by email, externalId, or subscriberId. Built for reconciling historical or derived tags, so identifiers that do not match an existing subscriber are returned in notFound rather than creating contacts. Tag automations are skipped unless triggerAutomations is true, which requires the automations:trigger scope.
|
|
41
|
+
* Many contacts, one or more tags. Adds one or more tags to up to 500 existing subscribers identified by email, externalId, or subscriberId. Built for reconciling historical or derived tags, so identifiers that do not match an existing subscriber are returned in notFound rather than creating contacts. Tag automations are skipped unless triggerAutomations is true, which requires the automations:trigger scope.
|
|
42
42
|
*
|
|
43
43
|
* @param {Sequenzy.BulkSubscriberTagRequest} request
|
|
44
44
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -59,7 +59,7 @@ export declare class SubscribersClient {
|
|
|
59
59
|
bulkAddTags(request: Sequenzy.BulkSubscriberTagRequest, requestOptions?: SubscribersClient.RequestOptions): core.HttpResponsePromise<Sequenzy.BulkSubscriberTagResponse>;
|
|
60
60
|
private __bulkAddTags;
|
|
61
61
|
/**
|
|
62
|
-
* Removes one or more tags from up to 500 existing subscribers identified by email, externalId, or subscriberId. Identifiers that do not match an existing subscriber are returned in notFound.
|
|
62
|
+
* Many contacts, one or more tags. Removes one or more tags from up to 500 existing subscribers identified by email, externalId, or subscriberId. Identifiers that do not match an existing subscriber are returned in notFound.
|
|
63
63
|
*
|
|
64
64
|
* @param {Sequenzy.BulkSubscriberTagRequest} request
|
|
65
65
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -124,7 +124,7 @@ export declare class SubscribersClient {
|
|
|
124
124
|
create(request?: Sequenzy.CreateSubscribersRequest, requestOptions?: SubscribersClient.RequestOptions): core.HttpResponsePromise<Sequenzy.CreateSubscribersResponse>;
|
|
125
125
|
private __create;
|
|
126
126
|
/**
|
|
127
|
-
* Queues an asynchronous full-record subscriber import of up to 5,000 contacts.
|
|
127
|
+
* Queues an asynchronous full-record subscriber import of up to 5,000 contacts. If the list has too many addresses that don't exist, the import gets a listQuality recommendation to clean it.
|
|
128
128
|
*
|
|
129
129
|
* @param {Sequenzy.CreateImportSubscribersRequest} request
|
|
130
130
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -50,7 +50,7 @@ class SubscribersClient {
|
|
|
50
50
|
return (this._tags ?? (this._tags = new Client_js_2.TagsClient(this._options)));
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
|
-
* Adds
|
|
53
|
+
* One contact, several tags. Adds several tags to a single subscriber identified by email or externalId. Creates the subscriber if they don't exist. To add tags to many existing subscribers without creating contacts, use POST /subscribers/bulk/tags/add. Creates tag definitions if they don't exist. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, the confirmation email is queued, and tag automations wait at their trigger until the subscriber confirms.
|
|
54
54
|
*
|
|
55
55
|
* @param {Sequenzy.AddTagsBulkRequest} request
|
|
56
56
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -119,7 +119,7 @@ class SubscribersClient {
|
|
|
119
119
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/subscribers/tags/bulk");
|
|
120
120
|
}
|
|
121
121
|
/**
|
|
122
|
-
* Adds one or more tags to up to 500 existing subscribers identified by email, externalId, or subscriberId. Built for reconciling historical or derived tags, so identifiers that do not match an existing subscriber are returned in notFound rather than creating contacts. Tag automations are skipped unless triggerAutomations is true, which requires the automations:trigger scope.
|
|
122
|
+
* Many contacts, one or more tags. Adds one or more tags to up to 500 existing subscribers identified by email, externalId, or subscriberId. Built for reconciling historical or derived tags, so identifiers that do not match an existing subscriber are returned in notFound rather than creating contacts. Tag automations are skipped unless triggerAutomations is true, which requires the automations:trigger scope.
|
|
123
123
|
*
|
|
124
124
|
* @param {Sequenzy.BulkSubscriberTagRequest} request
|
|
125
125
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -195,7 +195,7 @@ class SubscribersClient {
|
|
|
195
195
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/subscribers/bulk/tags/add");
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
|
-
* Removes one or more tags from up to 500 existing subscribers identified by email, externalId, or subscriberId. Identifiers that do not match an existing subscriber are returned in notFound.
|
|
198
|
+
* Many contacts, one or more tags. Removes one or more tags from up to 500 existing subscribers identified by email, externalId, or subscriberId. Identifiers that do not match an existing subscriber are returned in notFound.
|
|
199
199
|
*
|
|
200
200
|
* @param {Sequenzy.BulkSubscriberTagRequest} request
|
|
201
201
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -418,7 +418,7 @@ class SubscribersClient {
|
|
|
418
418
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/subscribers");
|
|
419
419
|
}
|
|
420
420
|
/**
|
|
421
|
-
* Queues an asynchronous full-record subscriber import of up to 5,000 contacts.
|
|
421
|
+
* Queues an asynchronous full-record subscriber import of up to 5,000 contacts. If the list has too many addresses that don't exist, the import gets a listQuality recommendation to clean it.
|
|
422
422
|
*
|
|
423
423
|
* @param {Sequenzy.CreateImportSubscribersRequest} request
|
|
424
424
|
* @param {SubscribersClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/api/resources/subscribers/resources/events/types/TriggerBulkEventsResponse.d.ts
CHANGED
|
@@ -3,6 +3,9 @@ export interface TriggerBulkEventsResponse {
|
|
|
3
3
|
events?: Sequenzy.subscribers.TriggerBulkEventsResponseEventsItem[];
|
|
4
4
|
/** Present when this request created a brand-new subscriber while workspace double opt-in is enabled. The subscriber stays pending and matching sequences wait until they confirm. */
|
|
5
5
|
optIn?: Sequenzy.subscribers.TriggerBulkEventsResponseOptIn;
|
|
6
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
7
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
6
8
|
subscriber?: Sequenzy.subscribers.TriggerBulkEventsResponseSubscriber;
|
|
7
9
|
success?: boolean;
|
|
10
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
8
11
|
}
|
package/dist/cjs/api/resources/subscribers/resources/events/types/TriggerEventsResponse.d.ts
CHANGED
|
@@ -17,8 +17,11 @@ export interface TriggerEventsResponse {
|
|
|
17
17
|
inserted?: number;
|
|
18
18
|
/** Present when this event created a brand-new subscriber while workspace double opt-in is enabled. The subscriber stays pending and matching sequences wait until they confirm. */
|
|
19
19
|
optIn?: Sequenzy.subscribers.TriggerEventsResponseOptIn;
|
|
20
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
21
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
20
22
|
/** Present when the event was recorded but one or more side-effect stages (e.g. apply-sync-rules, trigger-event-automations) failed. Retry-sensitive callers should treat these as partial failures. */
|
|
21
23
|
sideEffectFailures?: string[];
|
|
22
24
|
subscriber?: Sequenzy.subscribers.TriggerEventsResponseSubscriber;
|
|
23
25
|
success?: boolean;
|
|
26
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
24
27
|
}
|
|
@@ -29,12 +29,14 @@ export declare class TagsClient {
|
|
|
29
29
|
add(request: Sequenzy.subscribers.AddTagsRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.subscribers.AddTagsResponse>;
|
|
30
30
|
private __add;
|
|
31
31
|
/**
|
|
32
|
-
* Removes
|
|
32
|
+
* Removes one tag from one subscriber identified by email or externalId. Never creates a subscriber. When no subscriber matches, the request succeeds with subscriberFound false, tag.removed false, an empty subscriber.id and subscriber.created false. firstName and lastName update a matched subscriber and are ignored otherwise. To remove tags from many existing subscribers, use POST /subscribers/bulk/tags/remove.
|
|
33
33
|
*
|
|
34
34
|
* @param {Sequenzy.subscribers.RemoveTagsRequest} request
|
|
35
35
|
* @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
37
38
|
* @throws {@link Sequenzy.UnauthorizedError}
|
|
39
|
+
* @throws {@link Sequenzy.ConflictError}
|
|
38
40
|
* @throws {@link Sequenzy.InternalServerError}
|
|
39
41
|
* @throws {@link errors.SequenzyError}
|
|
40
42
|
* @throws {@link errors.SequenzyTimeoutError}
|
|
@@ -108,12 +108,14 @@ class TagsClient {
|
|
|
108
108
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/subscribers/tags");
|
|
109
109
|
}
|
|
110
110
|
/**
|
|
111
|
-
* Removes
|
|
111
|
+
* Removes one tag from one subscriber identified by email or externalId. Never creates a subscriber. When no subscriber matches, the request succeeds with subscriberFound false, tag.removed false, an empty subscriber.id and subscriber.created false. firstName and lastName update a matched subscriber and are ignored otherwise. To remove tags from many existing subscribers, use POST /subscribers/bulk/tags/remove.
|
|
112
112
|
*
|
|
113
113
|
* @param {Sequenzy.subscribers.RemoveTagsRequest} request
|
|
114
114
|
* @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
115
115
|
*
|
|
116
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
116
117
|
* @throws {@link Sequenzy.UnauthorizedError}
|
|
118
|
+
* @throws {@link Sequenzy.ConflictError}
|
|
117
119
|
* @throws {@link Sequenzy.InternalServerError}
|
|
118
120
|
* @throws {@link errors.SequenzyError}
|
|
119
121
|
* @throws {@link errors.SequenzyTimeoutError}
|
|
@@ -162,8 +164,12 @@ class TagsClient {
|
|
|
162
164
|
}
|
|
163
165
|
if (_response.error.reason === "status-code") {
|
|
164
166
|
switch (_response.error.statusCode) {
|
|
167
|
+
case 400:
|
|
168
|
+
throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
|
|
165
169
|
case 401:
|
|
166
170
|
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
171
|
+
case 409:
|
|
172
|
+
throw new Sequenzy.ConflictError(_response.error.body, _response.rawResponse);
|
|
167
173
|
case 500:
|
|
168
174
|
throw new Sequenzy.InternalServerError(_response.error.body, _response.rawResponse);
|
|
169
175
|
default:
|
package/dist/cjs/api/resources/subscribers/resources/tags/client/requests/RemoveTagsRequest.d.ts
CHANGED
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface RemoveTagsRequest {
|
|
8
|
-
/**
|
|
8
|
+
/** Subscriber email. Provide email, externalId, or both. */
|
|
9
9
|
email?: string;
|
|
10
10
|
/** Customer-owned app/customer/user ID */
|
|
11
11
|
externalId?: string;
|
|
12
|
-
/**
|
|
12
|
+
/** Updates the matched subscriber's first name. Ignored when no subscriber matches. */
|
|
13
13
|
firstName?: string;
|
|
14
|
-
/**
|
|
14
|
+
/** Updates the matched subscriber's last name. Ignored when no subscriber matches. */
|
|
15
15
|
lastName?: string;
|
|
16
16
|
tag: string;
|
|
17
17
|
}
|
|
@@ -2,7 +2,10 @@ import type * as Sequenzy from "../../../../../index.js";
|
|
|
2
2
|
export interface AddTagsResponse {
|
|
3
3
|
/** Present when this request created a brand-new subscriber while workspace double opt-in is enabled. The tag is applied, but the subscriber stays pending and tag automations wait until they confirm. */
|
|
4
4
|
optIn?: Sequenzy.subscribers.AddTagsResponseOptIn;
|
|
5
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
6
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
5
7
|
subscriber?: Sequenzy.subscribers.AddTagsResponseSubscriber;
|
|
6
8
|
success?: boolean;
|
|
7
9
|
tag?: Sequenzy.subscribers.AddTagsResponseTag;
|
|
10
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
8
11
|
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type * as Sequenzy from "../../../../../index.js";
|
|
2
2
|
export interface RemoveTagsResponse {
|
|
3
3
|
subscriber?: Sequenzy.subscribers.RemoveTagsResponseSubscriber;
|
|
4
|
+
/** False when no subscriber matched the email or externalId. Nothing was created or changed, subscriber.id is empty and subscriber.tags is empty. */
|
|
5
|
+
subscriberFound?: boolean;
|
|
4
6
|
success?: boolean;
|
|
5
7
|
tag?: Sequenzy.subscribers.RemoveTagsResponseTag;
|
|
6
8
|
}
|
|
@@ -2,7 +2,10 @@ import type * as Sequenzy from "../../../index.js";
|
|
|
2
2
|
export interface AddTagsBulkResponse {
|
|
3
3
|
/** Present when this request created a brand-new subscriber while workspace double opt-in is enabled. The tags are applied, but the subscriber stays pending and tag automations wait until they confirm. */
|
|
4
4
|
optIn?: Sequenzy.AddTagsBulkResponseOptIn;
|
|
5
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
6
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
5
7
|
subscriber?: Sequenzy.AddTagsBulkResponseSubscriber;
|
|
6
8
|
success?: boolean;
|
|
7
9
|
tags?: Sequenzy.AddTagsBulkResponseTags;
|
|
10
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
8
11
|
}
|
|
@@ -2,6 +2,9 @@ import type * as Sequenzy from "../../../index.js";
|
|
|
2
2
|
export interface CreateSubscribersResponse {
|
|
3
3
|
/** Present when the subscriber is awaiting double opt-in confirmation. */
|
|
4
4
|
optIn?: Sequenzy.CreateSubscribersResponseOptIn;
|
|
5
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
6
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
5
7
|
subscriber?: Sequenzy.CreateSubscribersResponseSubscriber;
|
|
6
8
|
success?: boolean;
|
|
9
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
7
10
|
}
|
|
@@ -10,6 +10,8 @@ export interface ImportEventsSubscribersResponse {
|
|
|
10
10
|
failures?: Sequenzy.ImportEventsSubscribersResponseFailuresItem[];
|
|
11
11
|
/** Events recorded by this request. */
|
|
12
12
|
recorded?: number;
|
|
13
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
14
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
13
15
|
/** Receipt rows whose downstream side effects or historical automation shielding failed. This is orthogonal to receipt accounting and may accompany either recorded or duplicate rows during recovery. */
|
|
14
16
|
sideEffectFailed?: number;
|
|
15
17
|
/** Post-write failures by input index. The receipt exists (new or duplicate); retry with the same eventId for recovery. */
|
|
@@ -19,4 +21,5 @@ export interface ImportEventsSubscribersResponse {
|
|
|
19
21
|
success?: boolean;
|
|
20
22
|
/** Events submitted in this request. */
|
|
21
23
|
total?: number;
|
|
24
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
22
25
|
}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import type * as Sequenzy from "../../../index.js";
|
|
2
2
|
export interface UpdateByExternalIdSubscribersResponse {
|
|
3
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
4
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
3
5
|
subscriber?: Sequenzy.Subscriber;
|
|
4
6
|
success?: boolean;
|
|
7
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
5
8
|
}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import type * as Sequenzy from "../../../index.js";
|
|
2
2
|
export interface UpdateSubscribersResponse {
|
|
3
|
+
sequenceTriggersRan?: Sequenzy.SequenceTriggersRan;
|
|
4
|
+
sequenceTriggersSkippedReason?: Sequenzy.SequenceTriggersSkippedReason;
|
|
3
5
|
subscriber?: Sequenzy.Subscriber;
|
|
4
6
|
success?: boolean;
|
|
7
|
+
warnings?: Sequenzy.SequenceTriggerWarnings;
|
|
5
8
|
}
|
|
@@ -558,12 +558,13 @@ class TemplatesClient {
|
|
|
558
558
|
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
559
559
|
}
|
|
560
560
|
async __list(request = {}, requestOptions) {
|
|
561
|
-
const { isTemplate, label, limit, offset } = request;
|
|
561
|
+
const { isTemplate, label, limit, offset, page } = request;
|
|
562
562
|
const _queryParams = {
|
|
563
563
|
isTemplate,
|
|
564
564
|
label,
|
|
565
565
|
limit,
|
|
566
566
|
offset,
|
|
567
|
+
page,
|
|
567
568
|
};
|
|
568
569
|
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
569
570
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
@@ -11,4 +11,6 @@ export interface ListTemplatesRequest {
|
|
|
11
11
|
limit?: number;
|
|
12
12
|
/** Templates to skip before returning results. */
|
|
13
13
|
offset?: number;
|
|
14
|
+
/** Optional 1-based page number, used when offset is absent: page=N starts at row (N - 1) * limit. An explicit offset takes precedence; a malformed page is ignored. */
|
|
15
|
+
page?: number;
|
|
14
16
|
}
|
|
@@ -4,6 +4,10 @@ export interface ListTemplatesResponsePagination {
|
|
|
4
4
|
hasMore?: boolean;
|
|
5
5
|
limit?: number;
|
|
6
6
|
offset?: number;
|
|
7
|
+
/** 1-based page that starts at offset. */
|
|
8
|
+
page?: number;
|
|
7
9
|
/** Every matching email body. */
|
|
8
10
|
total?: number;
|
|
11
|
+
/** Pages at this limit. */
|
|
12
|
+
totalPages?: number;
|
|
9
13
|
}
|
|
@@ -7,7 +7,7 @@ export interface FilterLeaf {
|
|
|
7
7
|
id: string;
|
|
8
8
|
/** Required when the filter is inside a v2 root group. */
|
|
9
9
|
kind?: Sequenzy.FilterLeafKind;
|
|
10
|
-
/** Valid operators depend on the field. status/segment: is, is_not. smsStatus: is, is_not (values: subscribed, unsubscribed, not_subscribed). phone: is_not_empty, is_empty (empty value). tag: contains, not_contains, is_empty, is_not_empty. email: contains, not_contains for domain or substring matching, is, is_not for an exact case-insensitive address. emailProvider/list: is, is_not, is_empty, is_not_empty. firstName/lastName: contains, not_contains, is_empty, is_not_empty. added: less_than, more_than. attribute: is, is_not, is_empty, is_not_empty, gte, lte, gt, lt, contains, not_contains. event and email engagement fields: is, is_not, at_least, less_than_count. emailBounced also supports is_temporary_bounce and is_permanent_bounce. stripeProduct: is, is_not, at_least, less_than_count. stripeCurrentProduct/stripeTrialProduct: is, is_not, gte, lte, gt, lt. commerceProduct/commerceCollection: is, is_not, at_least, less_than_count. pushDevice: is, is_not (values: any, web, ios, android; matches active push devices). pushSent/pushDelivered/pushClicked: is, is_not with a time range such as 30d or all (test sends are ignored). */
|
|
10
|
+
/** Valid operators depend on the field. status/segment: is, is_not. smsStatus: is, is_not (values: subscribed, unsubscribed, not_subscribed). phone: is_not_empty, is_empty (empty value), or starts_with, not_starts_with, contains, not_contains with digits matched against the stored E.164 number (for example +44 or +1 415; negative operators only match contacts with a phone). phoneCountry: is, is_not with ISO 3166-1 alpha-2 codes, comma-separated for several (for example GB or US,CA); only contacts with a phone match. tag: contains, not_contains, is_empty, is_not_empty. email: contains, not_contains for domain or substring matching, is, is_not for an exact case-insensitive address. emailProvider/list: is, is_not, is_empty, is_not_empty. firstName/lastName: contains, not_contains, is_empty, is_not_empty. added: less_than, more_than. attribute: is, is_not, is_empty, is_not_empty, gte, lte, gt, lt, contains, not_contains. event and email engagement fields: is, is_not, at_least, less_than_count. emailBounced also supports is_temporary_bounce and is_permanent_bounce. stripeProduct: is, is_not, at_least, less_than_count. stripeCurrentProduct/stripeTrialProduct: is, is_not, gte, lte, gt, lt. commerceProduct/commerceCollection: is, is_not, at_least, less_than_count. pushDevice: is, is_not (values: any, web, ios, android; matches active push devices). pushSent/pushDelivered/pushClicked: is, is_not with a time range such as 30d or all (test sends are ignored). */
|
|
11
11
|
operator: Sequenzy.FilterLeafOperator;
|
|
12
12
|
/** Event filters use `eventName:30d` or `eventName:5:30d`. Segment filters use a segment ID. Email engagement fields use a rolling time window (`24h`, `7d`, `30d`, `90d`, `180d`, `all`; whole hours from `1h` to `8760h` are measured to the exact hour; count filters are exact up to `168h`), a specific campaign via `campaign:<campaign_id>`, an email-type scope via `marketing:<timeRange>` (marketing-policy campaign, automation, and Send API traffic) or `transactional:<timeRange>` (transactional-policy sends; with is/is_not or the emailBounced subtype operators; scopes require a send-time policy snapshot, so ambiguous older events remain unscoped), or `count:timeRange` (such as `10:30d` or `10:all`) with at_least/less_than_count. Stripe product filters use `prod_123` for bought/current/trialing checks, `prod_123:3` for payment thresholds, and product-scoped values such as `prod_123:is_canceled`, `prod_123:cancels_at:2026-05-26`, `prod_123:end_at:2026-05-26`, or `prod_123:start_at:7 days ago`. Commerce product filters use `provider:productId` (provider one of `shopify`, `woocommerce`, `api`), optionally with an order-count threshold (`shopify:42:2`); a bare product ID matches the ID on any provider. Commerce collection filters use a collection ID or handle (`skincare`), optionally provider-prefixed and/or with an order-count threshold (`shopify:skincare:2`), and match anyone whose orders contain any product currently in that collection. Push device filters use `any`, `web`, `ios`, or `android`. Push sent, delivered, and clicked filters use a time range (`7d`, `30d`, `all`). */
|
|
13
13
|
value: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** Valid operators depend on the field. status/segment: is, is_not. smsStatus: is, is_not (values: subscribed, unsubscribed, not_subscribed). phone: is_not_empty, is_empty (empty value). tag: contains, not_contains, is_empty, is_not_empty. email: contains, not_contains for domain or substring matching, is, is_not for an exact case-insensitive address. emailProvider/list: is, is_not, is_empty, is_not_empty. firstName/lastName: contains, not_contains, is_empty, is_not_empty. added: less_than, more_than. attribute: is, is_not, is_empty, is_not_empty, gte, lte, gt, lt, contains, not_contains. event and email engagement fields: is, is_not, at_least, less_than_count. emailBounced also supports is_temporary_bounce and is_permanent_bounce. stripeProduct: is, is_not, at_least, less_than_count. stripeCurrentProduct/stripeTrialProduct: is, is_not, gte, lte, gt, lt. commerceProduct/commerceCollection: is, is_not, at_least, less_than_count. pushDevice: is, is_not (values: any, web, ios, android; matches active push devices). pushSent/pushDelivered/pushClicked: is, is_not with a time range such as 30d or all (test sends are ignored). */
|
|
1
|
+
/** Valid operators depend on the field. status/segment: is, is_not. smsStatus: is, is_not (values: subscribed, unsubscribed, not_subscribed). phone: is_not_empty, is_empty (empty value), or starts_with, not_starts_with, contains, not_contains with digits matched against the stored E.164 number (for example +44 or +1 415; negative operators only match contacts with a phone). phoneCountry: is, is_not with ISO 3166-1 alpha-2 codes, comma-separated for several (for example GB or US,CA); only contacts with a phone match. tag: contains, not_contains, is_empty, is_not_empty. email: contains, not_contains for domain or substring matching, is, is_not for an exact case-insensitive address. emailProvider/list: is, is_not, is_empty, is_not_empty. firstName/lastName: contains, not_contains, is_empty, is_not_empty. added: less_than, more_than. attribute: is, is_not, is_empty, is_not_empty, gte, lte, gt, lt, contains, not_contains. event and email engagement fields: is, is_not, at_least, less_than_count. emailBounced also supports is_temporary_bounce and is_permanent_bounce. stripeProduct: is, is_not, at_least, less_than_count. stripeCurrentProduct/stripeTrialProduct: is, is_not, gte, lte, gt, lt. commerceProduct/commerceCollection: is, is_not, at_least, less_than_count. pushDevice: is, is_not (values: any, web, ios, android; matches active push devices). pushSent/pushDelivered/pushClicked: is, is_not with a time range such as 30d or all (test sends are ignored). */
|
|
2
2
|
export declare const FilterLeafOperator: {
|
|
3
3
|
readonly Is: "is";
|
|
4
4
|
readonly IsNot: "is_not";
|
|
@@ -6,6 +6,8 @@ export declare const FilterLeafOperator: {
|
|
|
6
6
|
readonly IsNotEmpty: "is_not_empty";
|
|
7
7
|
readonly Contains: "contains";
|
|
8
8
|
readonly NotContains: "not_contains";
|
|
9
|
+
readonly StartsWith: "starts_with";
|
|
10
|
+
readonly NotStartsWith: "not_starts_with";
|
|
9
11
|
readonly LessThan: "less_than";
|
|
10
12
|
readonly MoreThan: "more_than";
|
|
11
13
|
readonly IsTemporaryBounce: "is_temporary_bounce";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.FilterLeafOperator = void 0;
|
|
5
|
-
/** Valid operators depend on the field. status/segment: is, is_not. smsStatus: is, is_not (values: subscribed, unsubscribed, not_subscribed). phone: is_not_empty, is_empty (empty value). tag: contains, not_contains, is_empty, is_not_empty. email: contains, not_contains for domain or substring matching, is, is_not for an exact case-insensitive address. emailProvider/list: is, is_not, is_empty, is_not_empty. firstName/lastName: contains, not_contains, is_empty, is_not_empty. added: less_than, more_than. attribute: is, is_not, is_empty, is_not_empty, gte, lte, gt, lt, contains, not_contains. event and email engagement fields: is, is_not, at_least, less_than_count. emailBounced also supports is_temporary_bounce and is_permanent_bounce. stripeProduct: is, is_not, at_least, less_than_count. stripeCurrentProduct/stripeTrialProduct: is, is_not, gte, lte, gt, lt. commerceProduct/commerceCollection: is, is_not, at_least, less_than_count. pushDevice: is, is_not (values: any, web, ios, android; matches active push devices). pushSent/pushDelivered/pushClicked: is, is_not with a time range such as 30d or all (test sends are ignored). */
|
|
5
|
+
/** Valid operators depend on the field. status/segment: is, is_not. smsStatus: is, is_not (values: subscribed, unsubscribed, not_subscribed). phone: is_not_empty, is_empty (empty value), or starts_with, not_starts_with, contains, not_contains with digits matched against the stored E.164 number (for example +44 or +1 415; negative operators only match contacts with a phone). phoneCountry: is, is_not with ISO 3166-1 alpha-2 codes, comma-separated for several (for example GB or US,CA); only contacts with a phone match. tag: contains, not_contains, is_empty, is_not_empty. email: contains, not_contains for domain or substring matching, is, is_not for an exact case-insensitive address. emailProvider/list: is, is_not, is_empty, is_not_empty. firstName/lastName: contains, not_contains, is_empty, is_not_empty. added: less_than, more_than. attribute: is, is_not, is_empty, is_not_empty, gte, lte, gt, lt, contains, not_contains. event and email engagement fields: is, is_not, at_least, less_than_count. emailBounced also supports is_temporary_bounce and is_permanent_bounce. stripeProduct: is, is_not, at_least, less_than_count. stripeCurrentProduct/stripeTrialProduct: is, is_not, gte, lte, gt, lt. commerceProduct/commerceCollection: is, is_not, at_least, less_than_count. pushDevice: is, is_not (values: any, web, ios, android; matches active push devices). pushSent/pushDelivered/pushClicked: is, is_not with a time range such as 30d or all (test sends are ignored). */
|
|
6
6
|
exports.FilterLeafOperator = {
|
|
7
7
|
Is: "is",
|
|
8
8
|
IsNot: "is_not",
|
|
@@ -10,6 +10,8 @@ exports.FilterLeafOperator = {
|
|
|
10
10
|
IsNotEmpty: "is_not_empty",
|
|
11
11
|
Contains: "contains",
|
|
12
12
|
NotContains: "not_contains",
|
|
13
|
+
StartsWith: "starts_with",
|
|
14
|
+
NotStartsWith: "not_starts_with",
|
|
13
15
|
LessThan: "less_than",
|
|
14
16
|
MoreThan: "more_than",
|
|
15
17
|
IsTemporaryBounce: "is_temporary_bounce",
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `true` when sequence triggers were allowed to run for this request. It does not mean a sequence started: no trigger may match, and a duplicate event or a tag the contact already had does not enroll anyone again. `false` when no sequence could start from this request; `sequenceTriggersSkippedReason` says why.
|
|
3
|
+
*/
|
|
4
|
+
export type SequenceTriggersRan = boolean;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** Present when `sequenceTriggersRan` is `false`. `missing_scope`: the API key lacks `automations:trigger`, so the write was applied but no sequence started and no waiting step resumed. `not_requested`: `enrollInSequences` was `false`. `historical`: the write was recorded as history (an `occurredAt` or `createdAt` more than an hour old). */
|
|
2
|
+
export declare const SequenceTriggersSkippedReason: {
|
|
3
|
+
readonly MissingScope: "missing_scope";
|
|
4
|
+
readonly NotRequested: "not_requested";
|
|
5
|
+
readonly Historical: "historical";
|
|
6
|
+
};
|
|
7
|
+
export type SequenceTriggersSkippedReason = (typeof SequenceTriggersSkippedReason)[keyof typeof SequenceTriggersSkippedReason];
|
|
@@ -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.SequenceTriggersSkippedReason = void 0;
|
|
5
|
+
/** Present when `sequenceTriggersRan` is `false`. `missing_scope`: the API key lacks `automations:trigger`, so the write was applied but no sequence started and no waiting step resumed. `not_requested`: `enrollInSequences` was `false`. `historical`: the write was recorded as history (an `occurredAt` or `createdAt` more than an hour old). */
|
|
6
|
+
exports.SequenceTriggersSkippedReason = {
|
|
7
|
+
MissingScope: "missing_scope",
|
|
8
|
+
NotRequested: "not_requested",
|
|
9
|
+
Historical: "historical",
|
|
10
|
+
};
|
|
@@ -13,6 +13,7 @@ export interface SubscriberImport {
|
|
|
13
13
|
failedReasons?: Record<string, number>;
|
|
14
14
|
fileName?: string;
|
|
15
15
|
id?: string;
|
|
16
|
+
listQuality?: Sequenzy.SubscriberImportListQuality | null;
|
|
16
17
|
processedCount?: number;
|
|
17
18
|
skippedCount?: number;
|
|
18
19
|
/** Count per reason a row was skipped. The values sum to skippedCount. */
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Set when the list has too many addresses that don't exist or look risky; null otherwise. None of its contacts are imported (every row is skipped as list_needs_cleaning). An import stays running, with nothing processed, until its list check is done.
|
|
4
|
+
*/
|
|
5
|
+
export interface SubscriberImportListQuality {
|
|
6
|
+
checkedAt?: Date | null;
|
|
7
|
+
/** A list-cleaning service to clean the list with. */
|
|
8
|
+
cleaningUrl?: string;
|
|
9
|
+
/** What needs cleaning, as estimated shares of the list. A list can need cleaning for any of them, not only for addresses that don't exist. */
|
|
10
|
+
issues?: Sequenzy.SubscriberImportListQualityIssuesItem[];
|
|
11
|
+
/** Customer-facing explanation and recommendation. */
|
|
12
|
+
message?: string;
|
|
13
|
+
/** Addresses in the checked sample. */
|
|
14
|
+
sampleSize?: number;
|
|
15
|
+
status?: Sequenzy.SubscriberImportListQualityStatus;
|
|
16
|
+
/** Addresses in the sample that don't exist. */
|
|
17
|
+
undeliverableCount?: number;
|
|
18
|
+
/** Estimated share of the list's addresses that don't exist, from 0 to 1. */
|
|
19
|
+
undeliverableRate?: number;
|
|
20
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
2
|
+
export interface SubscriberImportListQualityIssuesItem {
|
|
3
|
+
/** undeliverable: addresses that don't exist. disposable: temporary inboxes. role: shared addresses like info@ or sales@. */
|
|
4
|
+
kind: Sequenzy.SubscriberImportListQualityIssuesItemKind;
|
|
5
|
+
/** Share of the list, from 0 to 1. */
|
|
6
|
+
rate: number;
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** undeliverable: addresses that don't exist. disposable: temporary inboxes. role: shared addresses like info@ or sales@. */
|
|
2
|
+
export declare const SubscriberImportListQualityIssuesItemKind: {
|
|
3
|
+
readonly Undeliverable: "undeliverable";
|
|
4
|
+
readonly Disposable: "disposable";
|
|
5
|
+
readonly Role: "role";
|
|
6
|
+
};
|
|
7
|
+
export type SubscriberImportListQualityIssuesItemKind = (typeof SubscriberImportListQualityIssuesItemKind)[keyof typeof SubscriberImportListQualityIssuesItemKind];
|
|
@@ -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.SubscriberImportListQualityIssuesItemKind = void 0;
|
|
5
|
+
/** undeliverable: addresses that don't exist. disposable: temporary inboxes. role: shared addresses like info@ or sales@. */
|
|
6
|
+
exports.SubscriberImportListQualityIssuesItemKind = {
|
|
7
|
+
Undeliverable: "undeliverable",
|
|
8
|
+
Disposable: "disposable",
|
|
9
|
+
Role: "role",
|
|
10
|
+
};
|
|
@@ -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.SubscriberImportListQualityStatus = void 0;
|
|
5
|
+
exports.SubscriberImportListQualityStatus = {
|
|
6
|
+
NeedsCleaning: "needs_cleaning",
|
|
7
|
+
};
|
|
@@ -855,7 +855,10 @@ export * from "./SequenceTriggerPropertyFilter.js";
|
|
|
855
855
|
export * from "./SequenceTriggerPropertyFilterOperator.js";
|
|
856
856
|
export * from "./SequenceTriggerPropertyFilterValue.js";
|
|
857
857
|
export * from "./SequenceTriggerPropertyFilterValueThreeItem.js";
|
|
858
|
+
export * from "./SequenceTriggersRan.js";
|
|
859
|
+
export * from "./SequenceTriggersSkippedReason.js";
|
|
858
860
|
export * from "./SequenceTriggerType.js";
|
|
861
|
+
export * from "./SequenceTriggerWarnings.js";
|
|
859
862
|
export * from "./SequenceWaitUntilInput.js";
|
|
860
863
|
export * from "./SequenceWaitUntilInputDirection.js";
|
|
861
864
|
export * from "./SequenceWaitUntilInputMissingAction.js";
|
|
@@ -886,6 +889,10 @@ export * from "./SubscriberActivityEvent.js";
|
|
|
886
889
|
export * from "./SubscriberActivityEventEngagementQuality.js";
|
|
887
890
|
export * from "./SubscriberEmailStats.js";
|
|
888
891
|
export * from "./SubscriberImport.js";
|
|
892
|
+
export * from "./SubscriberImportListQuality.js";
|
|
893
|
+
export * from "./SubscriberImportListQualityIssuesItem.js";
|
|
894
|
+
export * from "./SubscriberImportListQualityIssuesItemKind.js";
|
|
895
|
+
export * from "./SubscriberImportListQualityStatus.js";
|
|
889
896
|
export * from "./SubscriberImportRecord.js";
|
|
890
897
|
export * from "./SubscriberImportRecordCustomAttributesValue.js";
|
|
891
898
|
export * from "./SubscriberImportRecordCustomAttributesValueThreeItem.js";
|