samva 0.26.0 → 0.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +7 -0
- package/README.md +14 -7
- package/dist/client/sdk.gen.d.ts +322 -143
- package/dist/client/sdk.gen.js +1085 -332
- package/dist/client/types.gen.d.ts +1342 -479
- package/dist/effect/agents.d.ts +119 -0
- package/dist/effect/agents.js +29 -0
- package/dist/effect/analytics.d.ts +1 -1
- package/dist/effect/analytics.js +1 -1
- package/dist/effect/api-keys.d.ts +6 -6
- package/dist/effect/attachments.d.ts +1 -1
- package/dist/effect/brands.d.ts +2 -0
- package/dist/effect/campaigns.d.ts +275 -25
- package/dist/effect/campaigns.js +7 -1
- package/dist/effect/contact-groups.d.ts +9 -9
- package/dist/effect/contacts.d.ts +74 -81
- package/dist/effect/contacts.js +7 -3
- package/dist/effect/conversations.d.ts +14 -6
- package/dist/effect/email.d.ts +34 -34
- package/dist/effect/errors.d.ts +1 -1
- package/dist/effect/errors.js +2 -2
- package/dist/effect/extension-installations.d.ts +3 -3
- package/dist/effect/extensions.d.ts +6 -6
- package/dist/effect/generated/agents.d.ts +6 -28
- package/dist/effect/generated/agents.js +270 -0
- package/dist/effect/generated/analytics.d.ts +3 -3
- package/dist/effect/generated/analytics.js +1 -1
- package/dist/effect/generated/api-keys.d.ts +6 -6
- package/dist/effect/generated/api-keys.js +2 -2
- package/dist/effect/generated/attachments.d.ts +3 -3
- package/dist/effect/generated/attachments.js +1 -1
- package/dist/effect/generated/brands.d.ts +16 -0
- package/dist/effect/generated/campaigns.d.ts +1181 -302
- package/dist/effect/generated/campaigns.js +169 -36
- package/dist/effect/generated/contact-events.d.ts +3 -3
- package/dist/effect/generated/contact-events.js +1 -1
- package/dist/effect/generated/contact-groups.d.ts +9 -9
- package/dist/effect/generated/contact-groups.js +7 -7
- package/dist/effect/generated/contacts.d.ts +2063 -290
- package/dist/effect/generated/contacts.js +343 -75
- package/dist/effect/generated/conversations.d.ts +14 -6
- package/dist/effect/generated/conversations.js +6 -6
- package/dist/effect/generated/email.d.ts +55 -70
- package/dist/effect/generated/email.js +18 -21
- package/dist/effect/generated/extension-installations.d.ts +3 -3
- package/dist/effect/generated/extension-installations.js +1 -1
- package/dist/effect/generated/extensions.d.ts +6 -6
- package/dist/effect/generated/extensions.js +2 -2
- package/dist/effect/generated/index.d.ts +5 -3
- package/dist/effect/generated/journeys.d.ts +9 -9
- package/dist/effect/generated/journeys.js +3 -3
- package/dist/effect/generated/mailboxes.d.ts +466 -712
- package/dist/effect/generated/mailboxes.js +22 -14
- package/dist/effect/generated/messages.d.ts +53 -29
- package/dist/effect/generated/messages.js +9 -5
- package/dist/effect/generated/namespaces.d.ts +3 -3
- package/dist/effect/generated/namespaces.js +1 -1
- package/dist/effect/generated/operations.d.ts +3 -3
- package/dist/effect/generated/operations.js +1 -1
- package/dist/effect/generated/organizations.d.ts +0 -9
- package/dist/effect/generated/organizations.js +1 -4
- package/dist/effect/generated/scheduled-messages.d.ts +69 -20
- package/dist/effect/generated/scheduled-messages.js +22 -3
- package/dist/effect/generated/shared.d.ts +431 -177
- package/dist/effect/generated/shared.js +216 -108
- package/dist/effect/generated/subscriptions.d.ts +4 -7
- package/dist/effect/generated/subscriptions.js +3 -4
- package/dist/effect/generated/templates.d.ts +71 -407
- package/dist/effect/generated/templates.js +23 -23
- package/dist/effect/generated/topic-forms.d.ts +656 -0
- package/dist/effect/generated/topic-forms.js +145 -0
- package/dist/effect/generated/{unsubscribe-groups.d.ts → topics.d.ts} +640 -435
- package/dist/effect/generated/topics.js +267 -0
- package/dist/effect/generated/webhooks.d.ts +6 -6
- package/dist/effect/generated/webhooks.js +2 -2
- package/dist/effect/generated-metadata.d.ts +78 -24
- package/dist/effect/generated-metadata.js +61 -27
- package/dist/effect/index.d.ts +3 -1
- package/dist/effect/index.js +5 -3
- package/dist/effect/internal/operation.js +4 -3
- package/dist/effect/internal/send.d.ts +4 -4
- package/dist/effect/journeys.d.ts +119 -119
- package/dist/effect/mailboxes.d.ts +137 -121
- package/dist/effect/messages.d.ts +19 -11
- package/dist/effect/namespaces.d.ts +3 -3
- package/dist/effect/operations.d.ts +3 -3
- package/dist/effect/scheduled-messages.d.ts +6 -6
- package/dist/effect/subscriptions.d.ts +1 -2
- package/dist/effect/templates.d.ts +13 -13
- package/dist/effect/topic-forms.d.ts +30 -0
- package/dist/effect/topic-forms.js +21 -0
- package/dist/effect/topics.d.ts +94 -0
- package/dist/effect/topics.js +29 -0
- package/dist/effect/webhooks.d.ts +6 -6
- package/dist/index.js +2 -2
- package/dist/package.js +1 -1
- package/dist/promises/errors.gen.d.ts +65 -8
- package/dist/promises/errors.gen.js +139 -7
- package/dist/promises/index.d.ts +7 -3
- package/dist/promises/index.js +9 -5
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/service-map.d.ts +117 -23
- package/dist/service-map.js +71 -10
- package/package.json +17 -9
- package/dist/effect/generated/unsubscribe-groups.js +0 -284
- package/dist/effect/unsubscribe-groups.d.ts +0 -74
- package/dist/effect/unsubscribe-groups.js +0 -29
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from "./client";
|
|
2
|
-
import type { AgentDefinition, AgentId, AgentName, AgentsCreateErrors, AgentsCreateResponses, AgentsGetErrors, AgentsGetResponses, AgentsGetVersionErrors, AgentsGetVersionResponses, AgentsListErrors, AgentsListResponses, AgentsListVersionsErrors, AgentsListVersionsResponses, AgentsPublishErrors, AgentsPublishResponses, AgentsRemoveErrors, AgentsRemoveResponses, AgentsReplaceDraftErrors, AgentsReplaceDraftResponses, AgentsUpdateErrors, AgentsUpdateResponses, AnalyticsExportDataErrors, AnalyticsExportDataResponses, AnalyticsGetChannelStatsErrors, AnalyticsGetChannelStatsResponses, AnalyticsGetDeliveryMetricsErrors, AnalyticsGetDeliveryMetricsResponses, AnalyticsGetHourlyDistributionErrors, AnalyticsGetHourlyDistributionResponses, AnalyticsGetStatsErrors, AnalyticsGetStatsResponses, AnalyticsGetTopContactsErrors, AnalyticsGetTopContactsResponses, ApiKeyAccess, ApiKeyId, ApiKeyMailboxAccessUpdate, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, AttachmentId, AttachmentsDownloadUrlErrors, AttachmentsDownloadUrlResponses, AttachmentsGetByIdErrors, AttachmentsGetByIdResponses, AttachmentsListErrors, AttachmentsListResponses, AttachmentsRemoveErrors, AttachmentsRemoveResponses, BlockedEmailId, BrandAssets, BrandFooter, BrandsCreateErrors, BrandsCreateResponses, BrandsGetErrors, BrandsGetResponses, BrandsListErrors, BrandsListResponses, BrandsRemoveErrors, BrandsRemoveResponses, BrandsSetDefaultErrors, BrandsSetDefaultResponses, BrandsUpdateErrors, BrandsUpdateResponses, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactEventReference, ContactEventsListEventsErrors, ContactEventsListEventsResponses, ContactGroupId, ContactGroupsAddMembersErrors, ContactGroupsAddMembersResponses, ContactGroupsCreateErrors, ContactGroupsCreateResponses, ContactGroupsEvaluateDynamicErrors, ContactGroupsEvaluateDynamicResponses, ContactGroupsGetByIdErrors, ContactGroupsGetByIdResponses, ContactGroupsGetMembersErrors, ContactGroupsGetMembersResponses, ContactGroupsListErrors, ContactGroupsListResponses, ContactGroupsPreviewErrors, ContactGroupsPreviewResponses, ContactGroupsRemoveErrors, ContactGroupsRemoveMembersErrors, ContactGroupsRemoveMembersResponses, ContactGroupsRemoveResponses, ContactGroupsUpdateErrors, ContactGroupsUpdateResponses, ContactId, ContactIdentityId, ContactIdentityInput, ContactLookup, ContactPreferences, ContactProfileUpdate, ContactProfileWritable, ContactsAddIdentityErrors, ContactsAddIdentityResponses, ContactsAddTagsErrors, ContactsAddTagsResponses, ContactsBulkDeleteErrors, ContactsBulkDeleteResponses, ContactsBulkImportErrors, ContactsBulkImportResponses, ContactsBulkUpdateStatusErrors, ContactsBulkUpdateStatusResponses, ContactsBulkUpdateTagsErrors, ContactsBulkUpdateTagsResponses, ContactsCreateErrors, ContactsCreateResponses, ContactsExportErrors, ContactsExportResponses, ContactsFindErrors, ContactsFindOrCreateErrors, ContactsFindOrCreateResponses, ContactsFindResponses, ContactsGetActivityTimelineErrors, ContactsGetActivityTimelineResponses, ContactsGetEngagementErrors, ContactsGetEngagementResponses, ContactsGetErrors, ContactsGetGroupMembershipsErrors, ContactsGetGroupMembershipsResponses, ContactsGetResponses, ContactsListErrors, ContactsListResponses, ContactsRemoveErrors, ContactsRemoveIdentityErrors, ContactsRemoveIdentityResponses, ContactsRemoveResponses, ContactsRemoveTagsErrors, ContactsRemoveTagsResponses, ContactsSetConsentErrors, ContactsSetConsentResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContextWritable, ConversationId, ConversationsAddCategoriesErrors, ConversationsAddCategoriesResponses, ConversationsAddChannelsErrors, ConversationsAddChannelsResponses, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsAddTagsErrors, ConversationsAddTagsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveCategoriesErrors, ConversationsRemoveCategoriesResponses, ConversationsRemoveChannelsErrors, ConversationsRemoveChannelsResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsRemoveTagsErrors, ConversationsRemoveTagsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, CreateEventPayload, CreateMailboxEndpointPayload, Cursor, CustomFieldDefinitionId, CustomFieldsCreateErrors, CustomFieldsCreateResponses, CustomFieldsListErrors, CustomFieldsListResponses, CustomFieldsRemoveErrors, CustomFieldsRemoveResponses, CustomFieldsUpdateErrors, CustomFieldsUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailAttachment, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContentWritable, EmailCountSuppressionsErrors, EmailCountSuppressionsResponses, EmailCreateDomainWarmingPlanErrors, EmailCreateDomainWarmingPlanResponses, EmailCreateForwardingRuleErrors, EmailCreateForwardingRuleResponses, EmailDeleteForwardingRuleErrors, EmailDeleteForwardingRuleResponses, EmailDetectRegistrarErrors, EmailDetectRegistrarResponses, EmailDisableCatchAllErrors, EmailDisableCatchAllResponses, EmailDisableCustomTrackingErrors, EmailDisableCustomTrackingResponses, EmailDomainId, EmailDomainWarmingBatchId, EmailEnableCatchAllErrors, EmailEnableCatchAllResponses, EmailEnableCustomTrackingErrors, EmailEnableCustomTrackingResponses, EmailEnableReceivingErrors, EmailEnableReceivingResponses, EmailForwardingRuleId, EmailGetBlockLogsErrors, EmailGetBlockLogsResponses, EmailGetCatchAllConfigErrors, EmailGetCatchAllConfigResponses, EmailGetCatchAllStatsErrors, EmailGetCatchAllStatsResponses, EmailGetCustomTrackingDomainConnectErrors, EmailGetCustomTrackingDomainConnectResponses, EmailGetCustomTrackingErrors, EmailGetCustomTrackingResponses, EmailGetDomainByIdErrors, EmailGetDomainByIdResponses, EmailGetDomainConnectErrors, EmailGetDomainConnectResponses, EmailGetDomainVerificationErrors, EmailGetDomainVerificationResponses, EmailGetDomainWarmingErrors, EmailGetDomainWarmingResponses, EmailGetForwardingLogErrors, EmailGetForwardingLogResponses, EmailGetOnboardingReviewErrors, EmailGetOnboardingReviewResponses, EmailGetReceivingStatusErrors, EmailGetReceivingStatusResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecheckCustomTrackingErrors, EmailRecheckCustomTrackingResponses, EmailRecipients, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailRespondToOnboardingInformationRequestErrors, EmailRespondToOnboardingInformationRequestResponses, EmailResumeDomainWarmingErrors, EmailResumeDomainWarmingResponses, EmailRotateDomainDkimErrors, EmailRotateDomainDkimResponses, EmailSender, EmailSenderId, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateDomainWarmingPolicyErrors, EmailUpdateDomainWarmingPolicyResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, EventsBatchErrors, EventsBatchResponses, EventsCreateErrors, EventsCreateResponses, ExtensionInstallationId, ExtensionInstallationsDisableErrors, ExtensionInstallationsDisableResponses, ExtensionInstallationsEnableErrors, ExtensionInstallationsEnableResponses, ExtensionInstallationsGetErrors, ExtensionInstallationsGetResponses, ExtensionInstallationsGetRunErrors, ExtensionInstallationsGetRunResponses, ExtensionInstallationsInstallErrors, ExtensionInstallationsInstallResponses, ExtensionInstallationsListErrors, ExtensionInstallationsListResponses, ExtensionInstallationsListRunsErrors, ExtensionInstallationsListRunsResponses, ExtensionInstallationsUninstallErrors, ExtensionInstallationsUninstallResponses, ExtensionInstallationsUpgradeErrors, ExtensionInstallationsUpgradeResponses, ExtensionsGetErrors, ExtensionsGetResponses, ExtensionsGetVersionErrors, ExtensionsGetVersionResponses, ExtensionsListErrors, ExtensionsListResponses, ExtensionsListVersionsErrors, ExtensionsListVersionsResponses, ExtensionsPublishErrors, ExtensionsPublishResponses, ExtensionVersionId, FeedbackContext, FeedbackSendErrors, FeedbackSendResponses, ForwardingConditions, IanaTimezone, JourneyDefinitionWritable, JourneyId, JourneyName, JourneyRunId, JourneyRunStatus, JourneysArchiveErrors, JourneysArchiveResponses, JourneysCreateErrors, JourneysCreateResponses, JourneysGetErrors, JourneysGetResponses, JourneysGetRunErrors, JourneysGetRunResponses, JourneysGetVersionErrors, JourneysGetVersionResponses, JourneysListErrors, JourneysListResponses, JourneysListRunsErrors, JourneysListRunsResponses, JourneysPauseErrors, JourneysPauseResponses, JourneysPublishErrors, JourneysPublishResponses, JourneysRemoveErrors, JourneysRemoveResponses, JourneysReplaceDraftErrors, JourneysReplaceDraftResponses, JourneysResumeErrors, JourneysResumeResponses, JourneysStatsErrors, JourneysStatsResponses, JourneyStatus, JourneysUpdateErrors, JourneysUpdateResponses, JsonObjectWritable, JsonValueWritable, MailboxActionId, MailboxChannel, MailboxDraftId, MailboxEndpointId, MailboxesAddThreadLabelsErrors, MailboxesAddThreadLabelsResponses, MailboxesApproveActionErrors, MailboxesApproveActionResponses, MailboxesCancelActionErrors, MailboxesCancelActionResponses, MailboxesCopyMessageAttachmentErrors, MailboxesCopyMessageAttachmentResponses, MailboxesCreateDraftErrors, MailboxesCreateDraftResponses, MailboxesCreateEndpointErrors, MailboxesCreateEndpointResponses, MailboxesCreateErrors, MailboxesCreateGrantErrors, MailboxesCreateGrantResponses, MailboxesCreateLabelErrors, MailboxesCreateLabelResponses, MailboxesCreateNoteErrors, MailboxesCreateNoteResponses, MailboxesCreatePolicyErrors, MailboxesCreatePolicyResponses, MailboxesCreateResponses, MailboxesDeleteDraftErrors, MailboxesDeleteDraftResponses, MailboxesDeleteLabelErrors, MailboxesDeleteLabelResponses, MailboxesDeleteNoteErrors, MailboxesDeleteNoteResponses, MailboxesDeletePolicyErrors, MailboxesDeletePolicyResponses, MailboxesDenyActionErrors, MailboxesDenyActionResponses, MailboxesDiscardMessageErrors, MailboxesDiscardMessageResponses, MailboxesForwardErrors, MailboxesForwardResponses, MailboxesGetActionErrors, MailboxesGetActionResponses, MailboxesGetAgentActivityErrors, MailboxesGetAgentActivityResponses, MailboxesGetDraftErrors, MailboxesGetDraftResponses, MailboxesGetErrors, MailboxesGetMessageAttachmentErrors, MailboxesGetMessageAttachmentResponses, MailboxesGetMessageErrors, MailboxesGetMessageRawErrors, MailboxesGetMessageRawResponses, MailboxesGetMessageResponses, MailboxesGetPolicyErrors, MailboxesGetPolicyResponses, MailboxesGetResponses, MailboxesGetThreadContentErrors, MailboxesGetThreadContentResponses, MailboxesGetThreadErrors, MailboxesGetThreadResponses, MailboxesListActionsErrors, MailboxesListActionsResponses, MailboxesListDraftsErrors, MailboxesListDraftsResponses, MailboxesListErrors, MailboxesListEventsErrors, MailboxesListEventsResponses, MailboxesListFoldersErrors, MailboxesListFoldersResponses, MailboxesListGrantsErrors, MailboxesListGrantsResponses, MailboxesListLabelsErrors, MailboxesListLabelsResponses, MailboxesListPoliciesErrors, MailboxesListPoliciesResponses, MailboxesListQuarantineErrors, MailboxesListQuarantineResponses, MailboxesListResponses, MailboxesListThreadMessagesErrors, MailboxesListThreadMessagesResponses, MailboxesListThreadNotesErrors, MailboxesListThreadNotesResponses, MailboxesListThreadsErrors, MailboxesListThreadsResponses, MailboxesPauseErrors, MailboxesPauseResponses, MailboxesReleaseMessageErrors, MailboxesReleaseMessageResponses, MailboxesRemoveEndpointErrors, MailboxesRemoveEndpointResponses, MailboxesRemoveErrors, MailboxesRemoveResponses, MailboxesRemoveThreadLabelsErrors, MailboxesRemoveThreadLabelsResponses, MailboxesReplyAllErrors, MailboxesReplyAllResponses, MailboxesReplyErrors, MailboxesReplyResponses, MailboxesResumeErrors, MailboxesResumeResponses, MailboxesRetryActionErrors, MailboxesRetryActionResponses, MailboxesRevokeGrantErrors, MailboxesRevokeGrantResponses, MailboxesSendDraftErrors, MailboxesSendDraftResponses, MailboxesSendMessageErrors, MailboxesSendMessageResponses, MailboxesUpdateDraftErrors, MailboxesUpdateDraftResponses, MailboxesUpdateEndpointErrors, MailboxesUpdateEndpointResponses, MailboxesUpdateErrors, MailboxesUpdateGrantErrors, MailboxesUpdateGrantResponses, MailboxesUpdateLabelErrors, MailboxesUpdateLabelResponses, MailboxesUpdateNoteErrors, MailboxesUpdateNoteResponses, MailboxesUpdatePolicyErrors, MailboxesUpdatePolicyResponses, MailboxesUpdateResponses, MailboxesUpdateThreadErrors, MailboxesUpdateThreadResponses, MailboxGrantId, MailboxGrantRole, MailboxId, MailboxLabelId, MailboxMetadataPatch, MailboxMetadataWritable, MailboxNoteId, MailboxPolicyId, MailboxPolicyOutcomeKind, MailboxSendMode, MailboxThreadFolder, MailboxThreadId, MailboxThreadPriority, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadataWritable, MessagesGetContentErrors, MessagesGetContentResponses, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListDeliveriesErrors, MessagesListDeliveriesResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, NamespaceId, NamespaceMetadataWritable, NamespaceResourceType, NamespacesAssignResourceErrors, NamespacesAssignResourceResponses, NamespacesCreateErrors, NamespacesCreateResponses, NamespacesGetErrors, NamespacesGetResponses, NamespacesGetUsageErrors, NamespacesGetUsageResponses, NamespacesListErrors, NamespacesListResponses, NamespacesRemoveErrors, NamespacesRemoveResourceErrors, NamespacesRemoveResourceResponses, NamespacesRemoveResponses, NamespacesUpdateErrors, NamespacesUpdateResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsCreateAvatarUploadErrors, OrganizationsCreateAvatarUploadResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetProfileErrors, OrganizationsGetProfileResponses, OrganizationsGetResponses, OrganizationsGetTrustTierErrors, OrganizationsGetTrustTierResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, PhoneRegion, RenderLocale, RenderTimeZone, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SubscriptionsSubscribeErrors, SubscriptionsSubscribeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAddEntryErrors, TemplatesAddEntryResponses, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesAttachWorkspaceResourceErrors, TemplatesAttachWorkspaceResourceResponses, TemplatesCheckWorkspaceErrors, TemplatesCheckWorkspaceResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateFromWebsiteErrors, TemplatesCreateFromWebsiteResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDiffWorkspaceErrors, TemplatesDiffWorkspaceResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesGetGitRepositoryErrors, TemplatesGetGitRepositoryResponses, TemplatesGetInputContractErrors, TemplatesGetInputContractResponses, TemplatesGetPublicationErrors, TemplatesGetPublicationResponses, TemplatesIssueGitCredentialErrors, TemplatesIssueGitCredentialResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesPutWorkspaceAssetErrors, TemplatesPutWorkspaceAssetResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderPublicationErrors, TemplatesRenderPublicationResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TemplateTrackingDefault, TrackingRecipientEmail, UnsubscribeAddMembersErrors, UnsubscribeAddMembersResponses, UnsubscribeCheckSubscriptionErrors, UnsubscribeCheckSubscriptionResponses, UnsubscribeCreateErrors, UnsubscribeCreateResponses, UnsubscribeGroupMemberRef, UnsubscribeId, UnsubscribeListErrors, UnsubscribeListMembersErrors, UnsubscribeListMembersResponses, UnsubscribeListResponses, UnsubscribeRemoveErrors, UnsubscribeRemoveMembersErrors, UnsubscribeRemoveMembersResponses, UnsubscribeRemoveResponses, UnsubscribeSetDefaultErrors, UnsubscribeSetDefaultResponses, UnsubscribeUpdateErrors, UnsubscribeUpdateResponses, UserId, VersionCursor, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetSecretErrors, WebhooksGetSecretResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses, WhoamiGetErrors, WhoamiGetResponses } from "./types.gen";
|
|
2
|
+
import type { AgentDefinition, AgentId, AgentName, AgentsCreateErrors, AgentsCreateResponses, AgentsGetErrors, AgentsGetResponses, AgentsGetVersionErrors, AgentsGetVersionResponses, AgentsListErrors, AgentsListResponses, AgentsListVersionsErrors, AgentsListVersionsResponses, AgentsPublishErrors, AgentsPublishResponses, AgentsRemoveErrors, AgentsRemoveResponses, AgentsReplaceDraftErrors, AgentsReplaceDraftResponses, AgentsUpdateErrors, AgentsUpdateResponses, AnalyticsExportDataErrors, AnalyticsExportDataResponses, AnalyticsGetChannelStatsErrors, AnalyticsGetChannelStatsResponses, AnalyticsGetDeliveryMetricsErrors, AnalyticsGetDeliveryMetricsResponses, AnalyticsGetHourlyDistributionErrors, AnalyticsGetHourlyDistributionResponses, AnalyticsGetStatsErrors, AnalyticsGetStatsResponses, AnalyticsGetTopContactsErrors, AnalyticsGetTopContactsResponses, ApiKeyAccess, ApiKeyId, ApiKeyMailboxAccessUpdate, ApiKeysCreateErrors, ApiKeysCreateResponses, ApiKeysGetActivityErrors, ApiKeysGetActivityResponses, ApiKeysGetErrors, ApiKeysGetResponses, ApiKeysGetStatsErrors, ApiKeysGetStatsResponses, ApiKeysListErrors, ApiKeysListResponses, ApiKeysRevokeErrors, ApiKeysRevokeResponses, ApiKeysRotateErrors, ApiKeysRotateResponses, ApiKeysUpdateErrors, ApiKeysUpdateResponses, AttachmentId, AttachmentsDownloadUrlErrors, AttachmentsDownloadUrlResponses, AttachmentsGetByIdErrors, AttachmentsGetByIdResponses, AttachmentsListErrors, AttachmentsListResponses, AttachmentsRemoveErrors, AttachmentsRemoveResponses, BlockedEmailId, BrandAssets, BrandFooter, BrandsCreateErrors, BrandsCreateResponses, BrandsGetErrors, BrandsGetResponses, BrandsListErrors, BrandsListResponses, BrandsRemoveErrors, BrandsRemoveResponses, BrandsSetDefaultErrors, BrandsSetDefaultResponses, BrandsUpdateErrors, BrandsUpdateResponses, CampaignAudience, CampaignContentInput, CampaignId, CampaignPolicy, CampaignRunId, CampaignsArchiveErrors, CampaignsArchiveResponses, CampaignsCancelRunErrors, CampaignsCancelRunResponses, CampaignsCreateErrors, CampaignsCreateResponses, CampaignsGetErrors, CampaignsGetResponses, CampaignsGetRunErrors, CampaignsGetRunReportErrors, CampaignsGetRunReportResponses, CampaignsGetRunResponses, CampaignsListErrors, CampaignsListRecipientsErrors, CampaignsListRecipientsResponses, CampaignsListResponses, CampaignsListRunsErrors, CampaignsListRunsResponses, CampaignsPauseRunErrors, CampaignsPauseRunResponses, CampaignsPreviewErrors, CampaignsPreviewResponses, CampaignsResumeRunErrors, CampaignsResumeRunResponses, CampaignsScheduleRunErrors, CampaignsScheduleRunResponses, CampaignsSendTestErrors, CampaignsSendTestResponses, CampaignsUpdateErrors, CampaignsUpdateResponses, ContactEventReference, ContactEventsListEventsErrors, ContactEventsListEventsResponses, ContactGroupId, ContactGroupsAddMembersErrors, ContactGroupsAddMembersResponses, ContactGroupsCreateErrors, ContactGroupsCreateResponses, ContactGroupsEvaluateDynamicErrors, ContactGroupsEvaluateDynamicResponses, ContactGroupsGetByIdErrors, ContactGroupsGetByIdResponses, ContactGroupsGetMembersErrors, ContactGroupsGetMembersResponses, ContactGroupsListErrors, ContactGroupsListResponses, ContactGroupsPreviewErrors, ContactGroupsPreviewResponses, ContactGroupsRemoveErrors, ContactGroupsRemoveMembersErrors, ContactGroupsRemoveMembersResponses, ContactGroupsRemoveResponses, ContactGroupsUpdateErrors, ContactGroupsUpdateResponses, ContactId, ContactIdentityId, ContactIdentityInput, ContactImportJobId, ContactLookup, ContactPreferences, ContactProfileUpdate, ContactProfileWritable, ContactsAddIdentityErrors, ContactsAddIdentityResponses, ContactsAddTagsErrors, ContactsAddTagsResponses, ContactsBulkDeleteErrors, ContactsBulkDeleteResponses, ContactsBulkUpdateStatusErrors, ContactsBulkUpdateStatusResponses, ContactsBulkUpdateTagsErrors, ContactsBulkUpdateTagsResponses, ContactsCreateErrors, ContactsCreateResponses, ContactsExportErrors, ContactsExportResponses, ContactsFindErrors, ContactsFindOrCreateErrors, ContactsFindOrCreateResponses, ContactsFindResponses, ContactsGetActivityTimelineErrors, ContactsGetActivityTimelineResponses, ContactsGetEngagementErrors, ContactsGetEngagementResponses, ContactsGetErrors, ContactsGetGroupMembershipsErrors, ContactsGetGroupMembershipsResponses, ContactsGetImportJobErrors, ContactsGetImportJobResponses, ContactsGetResponses, ContactsListErrors, ContactsListResponses, ContactsPlanImportErrors, ContactsPlanImportResponses, ContactsRemoveErrors, ContactsRemoveIdentityErrors, ContactsRemoveIdentityResponses, ContactsRemoveResponses, ContactsRemoveTagsErrors, ContactsRemoveTagsResponses, ContactsSetConsentErrors, ContactsSetConsentResponses, ContactsStartImportErrors, ContactsStartImportResponses, ContactsUpdateErrors, ContactsUpdateResponses, ConversationContextWritable, ConversationId, ConversationsAddCategoriesErrors, ConversationsAddCategoriesResponses, ConversationsAddChannelsErrors, ConversationsAddChannelsResponses, ConversationsAddContactsErrors, ConversationsAddContactsResponses, ConversationsAddTagsErrors, ConversationsAddTagsResponses, ConversationsCreateErrors, ConversationsCreateResponses, ConversationsGetByIdErrors, ConversationsGetByIdResponses, ConversationsListErrors, ConversationsListMessagesErrors, ConversationsListMessagesResponses, ConversationsListResponses, ConversationsRemoveCategoriesErrors, ConversationsRemoveCategoriesResponses, ConversationsRemoveChannelsErrors, ConversationsRemoveChannelsResponses, ConversationsRemoveContactsErrors, ConversationsRemoveContactsResponses, ConversationsRemoveTagsErrors, ConversationsRemoveTagsResponses, ConversationsUpdateErrors, ConversationsUpdateResponses, CreateEventPayload, CreateMailboxEndpointPayload, Cursor, CustomFieldDefinitionId, CustomFieldsCreateErrors, CustomFieldsCreateResponses, CustomFieldsListErrors, CustomFieldsListResponses, CustomFieldsRemoveErrors, CustomFieldsRemoveResponses, CustomFieldsUpdateErrors, CustomFieldsUpdateResponses, DispatchSendMessagePayload, EmailAddBlockErrors, EmailAddBlockResponses, EmailAddDomainErrors, EmailAddDomainResponses, EmailAddSenderErrors, EmailAddSenderResponses, EmailAdvanceDomainVerificationErrors, EmailAdvanceDomainVerificationResponses, EmailAttachment, EmailBccRecipients, EmailBuildCustomTrackingDomainConnectApplyUrlErrors, EmailBuildCustomTrackingDomainConnectApplyUrlResponses, EmailBuildDomainConnectApplyUrlErrors, EmailBuildDomainConnectApplyUrlResponses, EmailCancelDomainWarmingBatchErrors, EmailCancelDomainWarmingBatchResponses, EmailCcRecipients, EmailCheckBlockedErrors, EmailCheckBlockedResponses, EmailCheckSenderVerificationErrors, EmailCheckSenderVerificationResponses, EmailCompleteCustomTrackingDomainConnectErrors, EmailCompleteCustomTrackingDomainConnectResponses, EmailCompleteDomainConnectErrors, EmailCompleteDomainConnectResponses, EmailCompleteDomainWarmingErrors, EmailCompleteDomainWarmingResponses, EmailContentWritable, EmailCountSuppressionsErrors, EmailCountSuppressionsResponses, EmailCreateDomainWarmingPlanErrors, EmailCreateDomainWarmingPlanResponses, EmailCreateForwardingRuleErrors, EmailCreateForwardingRuleResponses, EmailDeleteForwardingRuleErrors, EmailDeleteForwardingRuleResponses, EmailDetectRegistrarErrors, EmailDetectRegistrarResponses, EmailDisableCatchAllErrors, EmailDisableCatchAllResponses, EmailDisableCustomTrackingErrors, EmailDisableCustomTrackingResponses, EmailDomainId, EmailDomainWarmingBatchId, EmailEnableCatchAllErrors, EmailEnableCatchAllResponses, EmailEnableCustomTrackingErrors, EmailEnableCustomTrackingResponses, EmailEnableReceivingErrors, EmailEnableReceivingResponses, EmailForwardingRuleId, EmailGetBlockLogsErrors, EmailGetBlockLogsResponses, EmailGetCatchAllConfigErrors, EmailGetCatchAllConfigResponses, EmailGetCatchAllStatsErrors, EmailGetCatchAllStatsResponses, EmailGetCustomTrackingDomainConnectErrors, EmailGetCustomTrackingDomainConnectResponses, EmailGetCustomTrackingErrors, EmailGetCustomTrackingResponses, EmailGetDomainByIdErrors, EmailGetDomainByIdResponses, EmailGetDomainConnectErrors, EmailGetDomainConnectResponses, EmailGetDomainVerificationErrors, EmailGetDomainVerificationResponses, EmailGetDomainWarmingErrors, EmailGetDomainWarmingResponses, EmailGetForwardingLogErrors, EmailGetForwardingLogResponses, EmailGetOnboardingReviewErrors, EmailGetOnboardingReviewResponses, EmailGetReceivingStatusErrors, EmailGetReceivingStatusResponses, EmailGetRecipientTrackingPreferenceErrors, EmailGetRecipientTrackingPreferenceResponses, EmailGetSenderErrors, EmailGetSenderResponses, EmailGetStatsErrors, EmailGetStatsResponses, EmailGetTrackingDefaultsErrors, EmailGetTrackingDefaultsResponses, EmailListBlocksErrors, EmailListBlocksResponses, EmailListDomainsErrors, EmailListDomainsResponses, EmailListForwardingRulesErrors, EmailListForwardingRulesResponses, EmailListSendersErrors, EmailListSendersResponses, EmailListSuppressionsErrors, EmailListSuppressionsResponses, EmailPauseDomainWarmingErrors, EmailPauseDomainWarmingResponses, EmailReapplyOnboardingReviewErrors, EmailReapplyOnboardingReviewResponses, EmailRecheckCustomTrackingErrors, EmailRecheckCustomTrackingResponses, EmailRecipients, EmailRemoveBlockErrors, EmailRemoveBlockResponses, EmailRemoveDomainErrors, EmailRemoveDomainResponses, EmailRemoveSenderErrors, EmailRemoveSenderResponses, EmailRemoveSuppressionErrors, EmailRemoveSuppressionResponses, EmailRespondToOnboardingInformationRequestErrors, EmailRespondToOnboardingInformationRequestResponses, EmailResumeDomainWarmingErrors, EmailResumeDomainWarmingResponses, EmailRotateDomainDkimErrors, EmailRotateDomainDkimResponses, EmailSender, EmailSenderId, EmailSetDefaultDomainErrors, EmailSetDefaultDomainResponses, EmailSetDefaultSenderErrors, EmailSetDefaultSenderResponses, EmailUpdateBlockErrors, EmailUpdateBlockResponses, EmailUpdateCatchAllConfigErrors, EmailUpdateCatchAllConfigResponses, EmailUpdateDomainConfigErrors, EmailUpdateDomainConfigResponses, EmailUpdateDomainWarmingPolicyErrors, EmailUpdateDomainWarmingPolicyResponses, EmailUpdateForwardingRuleErrors, EmailUpdateForwardingRuleResponses, EmailUpdateRecipientTrackingPreferenceErrors, EmailUpdateRecipientTrackingPreferenceResponses, EmailUpdateTrackingDefaultsErrors, EmailUpdateTrackingDefaultsResponses, EventsBatchErrors, EventsBatchResponses, EventsCreateErrors, EventsCreateResponses, ExtensionInstallationId, ExtensionInstallationsDisableErrors, ExtensionInstallationsDisableResponses, ExtensionInstallationsEnableErrors, ExtensionInstallationsEnableResponses, ExtensionInstallationsGetErrors, ExtensionInstallationsGetResponses, ExtensionInstallationsGetRunErrors, ExtensionInstallationsGetRunResponses, ExtensionInstallationsInstallErrors, ExtensionInstallationsInstallResponses, ExtensionInstallationsListErrors, ExtensionInstallationsListResponses, ExtensionInstallationsListRunsErrors, ExtensionInstallationsListRunsResponses, ExtensionInstallationsUninstallErrors, ExtensionInstallationsUninstallResponses, ExtensionInstallationsUpgradeErrors, ExtensionInstallationsUpgradeResponses, ExtensionsGetErrors, ExtensionsGetResponses, ExtensionsGetVersionErrors, ExtensionsGetVersionResponses, ExtensionsListErrors, ExtensionsListResponses, ExtensionsListVersionsErrors, ExtensionsListVersionsResponses, ExtensionsPublishErrors, ExtensionsPublishResponses, ExtensionVersionId, FeedbackContext, FeedbackSendErrors, FeedbackSendResponses, ForwardingConditions, IanaTimezone, JourneyDefinitionWritable, JourneyId, JourneyName, JourneyRunId, JourneyRunStatus, JourneysArchiveErrors, JourneysArchiveResponses, JourneysCreateErrors, JourneysCreateResponses, JourneysGetErrors, JourneysGetResponses, JourneysGetRunErrors, JourneysGetRunResponses, JourneysGetVersionErrors, JourneysGetVersionResponses, JourneysListErrors, JourneysListResponses, JourneysListRunsErrors, JourneysListRunsResponses, JourneysPauseErrors, JourneysPauseResponses, JourneysPublishErrors, JourneysPublishResponses, JourneysRemoveErrors, JourneysRemoveResponses, JourneysReplaceDraftErrors, JourneysReplaceDraftResponses, JourneysResumeErrors, JourneysResumeResponses, JourneysStatsErrors, JourneysStatsResponses, JourneyStatus, JourneysUpdateErrors, JourneysUpdateResponses, JsonObjectWritable, JsonValueWritable, MailboxActionId, MailboxChannel, MailboxDraftId, MailboxEndpointId, MailboxesAddThreadLabelsErrors, MailboxesAddThreadLabelsResponses, MailboxesApproveActionErrors, MailboxesApproveActionResponses, MailboxesCancelActionErrors, MailboxesCancelActionResponses, MailboxesCopyMessageAttachmentErrors, MailboxesCopyMessageAttachmentResponses, MailboxesCreateDraftErrors, MailboxesCreateDraftResponses, MailboxesCreateEndpointErrors, MailboxesCreateEndpointResponses, MailboxesCreateErrors, MailboxesCreateGrantErrors, MailboxesCreateGrantResponses, MailboxesCreateLabelErrors, MailboxesCreateLabelResponses, MailboxesCreateNoteErrors, MailboxesCreateNoteResponses, MailboxesCreatePolicyErrors, MailboxesCreatePolicyResponses, MailboxesCreateResponses, MailboxesDeleteDraftErrors, MailboxesDeleteDraftResponses, MailboxesDeleteLabelErrors, MailboxesDeleteLabelResponses, MailboxesDeleteNoteErrors, MailboxesDeleteNoteResponses, MailboxesDeletePolicyErrors, MailboxesDeletePolicyResponses, MailboxesDenyActionErrors, MailboxesDenyActionResponses, MailboxesDiscardMessageErrors, MailboxesDiscardMessageResponses, MailboxesForwardErrors, MailboxesForwardResponses, MailboxesGetActionErrors, MailboxesGetActionResponses, MailboxesGetAgentActivityErrors, MailboxesGetAgentActivityResponses, MailboxesGetDraftErrors, MailboxesGetDraftResponses, MailboxesGetErrors, MailboxesGetMessageAttachmentErrors, MailboxesGetMessageAttachmentResponses, MailboxesGetMessageErrors, MailboxesGetMessageRawErrors, MailboxesGetMessageRawResponses, MailboxesGetMessageResponses, MailboxesGetPolicyErrors, MailboxesGetPolicyResponses, MailboxesGetResponses, MailboxesGetThreadContentErrors, MailboxesGetThreadContentResponses, MailboxesGetThreadErrors, MailboxesGetThreadResponses, MailboxesListActionsErrors, MailboxesListActionsResponses, MailboxesListDraftsErrors, MailboxesListDraftsResponses, MailboxesListErrors, MailboxesListEventsErrors, MailboxesListEventsResponses, MailboxesListFoldersErrors, MailboxesListFoldersResponses, MailboxesListGrantsErrors, MailboxesListGrantsResponses, MailboxesListLabelsErrors, MailboxesListLabelsResponses, MailboxesListPoliciesErrors, MailboxesListPoliciesResponses, MailboxesListQuarantineErrors, MailboxesListQuarantineResponses, MailboxesListResponses, MailboxesListThreadMessagesErrors, MailboxesListThreadMessagesResponses, MailboxesListThreadNotesErrors, MailboxesListThreadNotesResponses, MailboxesListThreadsErrors, MailboxesListThreadsResponses, MailboxesPauseErrors, MailboxesPauseResponses, MailboxesReleaseMessageErrors, MailboxesReleaseMessageResponses, MailboxesRemoveEndpointErrors, MailboxesRemoveEndpointResponses, MailboxesRemoveErrors, MailboxesRemoveResponses, MailboxesRemoveThreadLabelsErrors, MailboxesRemoveThreadLabelsResponses, MailboxesReplyAllErrors, MailboxesReplyAllResponses, MailboxesReplyErrors, MailboxesReplyResponses, MailboxesResumeErrors, MailboxesResumeResponses, MailboxesRetryActionErrors, MailboxesRetryActionResponses, MailboxesRevokeGrantErrors, MailboxesRevokeGrantResponses, MailboxesSendDraftErrors, MailboxesSendDraftResponses, MailboxesSendMessageErrors, MailboxesSendMessageResponses, MailboxesUpdateDraftErrors, MailboxesUpdateDraftResponses, MailboxesUpdateEndpointErrors, MailboxesUpdateEndpointResponses, MailboxesUpdateErrors, MailboxesUpdateGrantErrors, MailboxesUpdateGrantResponses, MailboxesUpdateLabelErrors, MailboxesUpdateLabelResponses, MailboxesUpdateNoteErrors, MailboxesUpdateNoteResponses, MailboxesUpdatePolicyErrors, MailboxesUpdatePolicyResponses, MailboxesUpdateResponses, MailboxesUpdateThreadErrors, MailboxesUpdateThreadResponses, MailboxGrantId, MailboxGrantRole, MailboxId, MailboxLabelId, MailboxMetadataPatch, MailboxMetadataWritable, MailboxNoteId, MailboxPolicyId, MailboxPolicyOutcomeKind, MailboxSendMode, MailboxThreadFolder, MailboxThreadId, MailboxThreadPriority, MediaCompleteErrors, MediaCompleteResponses, MediaCreateErrors, MediaCreateResponses, MediaDownloadUrlErrors, MediaDownloadUrlResponses, MediaGetByIdErrors, MediaGetByIdResponses, MediaId, MediaRemoveErrors, MediaRemoveResponses, MessageId, MessageMetadataWritable, MessagesGetContentErrors, MessagesGetContentResponses, MessagesGetEmailErrors, MessagesGetEmailResponses, MessagesGetErrors, MessagesGetEventsErrors, MessagesGetEventsResponses, MessagesGetResponses, MessagesGetStatusErrors, MessagesGetStatusResponses, MessagesListDeliveriesErrors, MessagesListDeliveriesResponses, MessagesListErrors, MessagesListResponses, MessagesRemoveErrors, MessagesRemoveResponses, MessagesSendErrors, MessagesSendResponses, MessagesValidateEmailErrors, MessagesValidateEmailResponses, NamespaceId, NamespaceMetadataWritable, NamespaceResourceType, NamespacesAssignResourceErrors, NamespacesAssignResourceResponses, NamespacesCreateErrors, NamespacesCreateResponses, NamespacesGetErrors, NamespacesGetResponses, NamespacesGetUsageErrors, NamespacesGetUsageResponses, NamespacesListErrors, NamespacesListResponses, NamespacesRemoveErrors, NamespacesRemoveResourceErrors, NamespacesRemoveResourceResponses, NamespacesRemoveResponses, NamespacesUpdateErrors, NamespacesUpdateResponses, OperationId, OperationsGetErrors, OperationsGetResponses, OperationsListErrors, OperationsListResponses, OperationsRetryErrors, OperationsRetryResponses, OrganizationsCreateAvatarUploadErrors, OrganizationsCreateAvatarUploadResponses, OrganizationsCreateErrors, OrganizationsCreateResponses, OrganizationsDeleteErrors, OrganizationsDeleteResponses, OrganizationsGetErrors, OrganizationsGetProfileErrors, OrganizationsGetProfileResponses, OrganizationsGetResponses, OrganizationsGetTrustTierErrors, OrganizationsGetTrustTierResponses, OrganizationsGetUsageErrors, OrganizationsGetUsageResponses, OrganizationsUpdateErrors, OrganizationsUpdateResponses, PhoneRegion, RenderLocale, RenderTimeZone, ScheduledMessageId, ScheduledMessagesCancelErrors, ScheduledMessagesCancelResponses, ScheduledMessagesCreateErrors, ScheduledMessagesCreateResponses, ScheduledMessagesGetErrors, ScheduledMessagesGetResponses, ScheduledMessagesListErrors, ScheduledMessagesListResponses, ScheduledMessagesResumeErrors, ScheduledMessagesResumeResponses, SubscriptionsSubscribeErrors, SubscriptionsSubscribeResponses, SuppressionId, TemplateFamilyId, TemplateFromDefault, TemplateId, TemplateInputContractId, TemplateProjectId, TemplatePublicationId, TemplatesAddEntryErrors, TemplatesAddEntryResponses, TemplatesAttachFamilyMemberErrors, TemplatesAttachFamilyMemberResponses, TemplatesAttachWorkspaceResourceErrors, TemplatesAttachWorkspaceResourceResponses, TemplatesCheckWorkspaceErrors, TemplatesCheckWorkspaceResponses, TemplatesCreateErrors, TemplatesCreateFamilyErrors, TemplatesCreateFamilyFromTemplateErrors, TemplatesCreateFamilyFromTemplateResponses, TemplatesCreateFamilyResponses, TemplatesCreateFromWebsiteErrors, TemplatesCreateFromWebsiteResponses, TemplatesCreateResponses, TemplatesDeleteFamilyErrors, TemplatesDeleteFamilyResponses, TemplatesDetachFamilyMemberErrors, TemplatesDetachFamilyMemberResponses, TemplatesDiffWorkspaceErrors, TemplatesDiffWorkspaceResponses, TemplatesGetByIdErrors, TemplatesGetByIdResponses, TemplatesGetFamilyErrors, TemplatesGetFamilyResponses, TemplatesGetGitRepositoryErrors, TemplatesGetGitRepositoryResponses, TemplatesGetInputContractErrors, TemplatesGetInputContractResponses, TemplatesGetPublicationErrors, TemplatesGetPublicationResponses, TemplatesIssueGitCredentialErrors, TemplatesIssueGitCredentialResponses, TemplatesListErrors, TemplatesListFamiliesErrors, TemplatesListFamiliesResponses, TemplatesListInputContractsErrors, TemplatesListInputContractsResponses, TemplatesListResponses, TemplatesOpenWorkspaceErrors, TemplatesOpenWorkspaceResponses, TemplatesPatchWorkspaceErrors, TemplatesPatchWorkspaceResponses, TemplatesPublishErrors, TemplatesPublishResponses, TemplatesPutWorkspaceAssetErrors, TemplatesPutWorkspaceAssetResponses, TemplatesRemoveErrors, TemplatesRemoveResponses, TemplatesRemoveWorkspaceResourceErrors, TemplatesRemoveWorkspaceResourceResponses, TemplatesRenameFamilyErrors, TemplatesRenameFamilyResponses, TemplatesRenderPublicationErrors, TemplatesRenderPublicationResponses, TemplatesRenderWorkspaceFixtureErrors, TemplatesRenderWorkspaceFixtureResponses, TemplatesResolveWorkspaceConflictErrors, TemplatesResolveWorkspaceConflictResponses, TemplatesRestoreWorkspaceErrors, TemplatesRestoreWorkspaceResponses, TemplatesSaveWorkspaceErrors, TemplatesSaveWorkspaceResponses, TemplatesUpdateErrors, TemplatesUpdateResponses, TemplatesWorkspaceHistoryErrors, TemplatesWorkspaceHistoryResponses, TemplateTrackingDefault, TopicContactRef, TopicFormsCreateErrors, TopicFormsCreateResponses, TopicFormsGetErrors, TopicFormsGetResponses, TopicFormsListErrors, TopicFormsListResponses, TopicFormsRemoveErrors, TopicFormsRemoveResponses, TopicFormsUpdateErrors, TopicFormsUpdateResponses, TopicId, TopicsCheckSubscriptionErrors, TopicsCheckSubscriptionResponses, TopicsCreateErrors, TopicsCreateResponses, TopicsGetErrors, TopicsGetResponses, TopicsListErrors, TopicsListResponses, TopicsListSubscriptionsErrors, TopicsListSubscriptionsResponses, TopicsRemoveErrors, TopicsRemoveResponses, TopicsSetDefaultErrors, TopicsSetDefaultResponses, TopicsSetSubscriptionsErrors, TopicsSetSubscriptionsResponses, TopicsUpdateErrors, TopicsUpdateResponses, TrackingRecipientEmail, UserId, VersionCursor, WebhookDeliveryId, WebhookEndpointId, WebhooksCreateErrors, WebhooksCreateResponses, WebhooksGetErrors, WebhooksGetLogsErrors, WebhooksGetLogsResponses, WebhooksGetResponses, WebhooksGetSecretErrors, WebhooksGetSecretResponses, WebhooksGetStatsErrors, WebhooksGetStatsResponses, WebhooksListErrors, WebhooksListResponses, WebhooksRegenerateSecretErrors, WebhooksRegenerateSecretResponses, WebhooksRemoveErrors, WebhooksRemoveResponses, WebhooksRetryDeliveryErrors, WebhooksRetryDeliveryResponses, WebhooksTestErrors, WebhooksTestResponses, WebhooksUpdateErrors, WebhooksUpdateResponses, WhoamiGetErrors, WhoamiGetResponses } from "./types.gen";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -20,7 +20,7 @@ export declare class Messages {
|
|
|
20
20
|
* Returns message summaries, newest first (oldest first when filtered by conversation), with optional filters for channel, direction, status, conversation, contact, sender address, and creation time. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
21
21
|
*/
|
|
22
22
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
23
|
-
limit?:
|
|
23
|
+
limit?: number | null | undefined;
|
|
24
24
|
cursor?: Cursor | null | undefined;
|
|
25
25
|
channel?: "email" | null | undefined;
|
|
26
26
|
direction?: "outbound" | "inbound" | null | undefined;
|
|
@@ -87,8 +87,8 @@ export declare class Messages {
|
|
|
87
87
|
*/
|
|
88
88
|
static getEmail<ThrowOnError extends boolean = false>(parameters: {
|
|
89
89
|
id: MessageId;
|
|
90
|
-
includeDownloadUrls?:
|
|
91
|
-
urlExpiresIn?:
|
|
90
|
+
includeDownloadUrls?: boolean | null | undefined;
|
|
91
|
+
urlExpiresIn?: number | null | undefined;
|
|
92
92
|
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesGetEmailResponses, MessagesGetEmailErrors, ThrowOnError>;
|
|
93
93
|
/**
|
|
94
94
|
* Validate an email message
|
|
@@ -120,7 +120,7 @@ export declare class Messages {
|
|
|
120
120
|
*/
|
|
121
121
|
static getEvents<ThrowOnError extends boolean = false>(parameters: {
|
|
122
122
|
id: MessageId;
|
|
123
|
-
limit?:
|
|
123
|
+
limit?: number | null | undefined;
|
|
124
124
|
cursor?: Cursor | null | undefined;
|
|
125
125
|
}, options?: Options<never, ThrowOnError>): RequestResult<MessagesGetEventsResponses, MessagesGetEventsErrors, ThrowOnError>;
|
|
126
126
|
}
|
|
@@ -134,7 +134,7 @@ export declare class Operations {
|
|
|
134
134
|
* Lists asynchronous operations for the active organization, newest first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
135
135
|
*/
|
|
136
136
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
137
|
-
limit?:
|
|
137
|
+
limit?: number | null | undefined;
|
|
138
138
|
cursor?: Cursor | null | undefined;
|
|
139
139
|
kind?: "email-domain-provisioning" | "organization-deletion" | null | undefined;
|
|
140
140
|
status?: "pending" | "running" | "succeeded" | "failed" | null | undefined;
|
|
@@ -166,7 +166,7 @@ export declare class ScheduledMessages {
|
|
|
166
166
|
* Returns scheduled messages, soonest send first, optionally filtered by status. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
167
167
|
*/
|
|
168
168
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
169
|
-
limit?:
|
|
169
|
+
limit?: number | null | undefined;
|
|
170
170
|
cursor?: Cursor | null | undefined;
|
|
171
171
|
status?: "pending" | "dispatching" | "paused" | "dispatched" | "cancelled" | "failed" | null | undefined;
|
|
172
172
|
}, options?: Options<never, ThrowOnError>): RequestResult<ScheduledMessagesListResponses, ScheduledMessagesListErrors, ThrowOnError>;
|
|
@@ -217,6 +217,26 @@ export declare class ScheduledMessages2 {
|
|
|
217
217
|
static scheduledMessages: typeof ScheduledMessages;
|
|
218
218
|
}
|
|
219
219
|
export declare class Campaigns {
|
|
220
|
+
/**
|
|
221
|
+
* Preview a campaign email
|
|
222
|
+
*
|
|
223
|
+
* Renders draft email content using the selected contact's fields and declared templateData fallbacks. Creates no campaign run or message. Omit contactId to preview the fallback data alone.
|
|
224
|
+
*/
|
|
225
|
+
static preview<ThrowOnError extends boolean = false>(parameters: {
|
|
226
|
+
content: CampaignContentInput;
|
|
227
|
+
audience: CampaignAudience;
|
|
228
|
+
contactId?: ContactId | null | undefined;
|
|
229
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CampaignsPreviewResponses, CampaignsPreviewErrors, ThrowOnError>;
|
|
230
|
+
/**
|
|
231
|
+
* Send a campaign test
|
|
232
|
+
*
|
|
233
|
+
* Sends one rendered draft email to the authenticated actor's email address, using optional contactId only for personalization. Creates no campaign run. Normal sending permissions, billing, and delivery policies apply.
|
|
234
|
+
*/
|
|
235
|
+
static sendTest<ThrowOnError extends boolean = false>(parameters: {
|
|
236
|
+
content: CampaignContentInput;
|
|
237
|
+
audience: CampaignAudience;
|
|
238
|
+
contactId?: ContactId | null | undefined;
|
|
239
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CampaignsSendTestResponses, CampaignsSendTestErrors, ThrowOnError>;
|
|
220
240
|
/**
|
|
221
241
|
* List campaigns
|
|
222
242
|
*
|
|
@@ -224,7 +244,7 @@ export declare class Campaigns {
|
|
|
224
244
|
*/
|
|
225
245
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
226
246
|
status?: "draft" | "archived" | null | undefined;
|
|
227
|
-
limit?:
|
|
247
|
+
limit?: number | null | undefined;
|
|
228
248
|
cursor?: Cursor | null | undefined;
|
|
229
249
|
}, options?: Options<never, ThrowOnError>): RequestResult<CampaignsListResponses, CampaignsListErrors, ThrowOnError>;
|
|
230
250
|
/**
|
|
@@ -275,7 +295,7 @@ export declare class Campaigns {
|
|
|
275
295
|
static listRuns<ThrowOnError extends boolean = false>(parameters: {
|
|
276
296
|
id: CampaignId;
|
|
277
297
|
status?: "scheduled" | "resolving" | "dispatching" | "paused" | "completed" | "cancelled" | "failed" | null | undefined;
|
|
278
|
-
limit?:
|
|
298
|
+
limit?: number | null | undefined;
|
|
279
299
|
cursor?: Cursor | null | undefined;
|
|
280
300
|
}, options?: Options<never, ThrowOnError>): RequestResult<CampaignsListRunsResponses, CampaignsListRunsErrors, ThrowOnError>;
|
|
281
301
|
/**
|
|
@@ -297,6 +317,15 @@ export declare class Campaigns {
|
|
|
297
317
|
id: CampaignId;
|
|
298
318
|
runId: CampaignRunId;
|
|
299
319
|
}, options?: Options<never, ThrowOnError>): RequestResult<CampaignsGetRunResponses, CampaignsGetRunErrors, ThrowOnError>;
|
|
320
|
+
/**
|
|
321
|
+
* Get a campaign run report
|
|
322
|
+
*
|
|
323
|
+
* Returns delivery outcomes, topic unsubscribes, replies, and skip reasons for an email campaign run. Non-email runs return 404. Namespace-scoped reads require an existing audience topic in that namespace. Opens and clicks are directional counts of unique recipients excluding machine events, not exact measurements.
|
|
324
|
+
*/
|
|
325
|
+
static getRunReport<ThrowOnError extends boolean = false>(parameters: {
|
|
326
|
+
id: CampaignId;
|
|
327
|
+
runId: CampaignRunId;
|
|
328
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<CampaignsGetRunReportResponses, CampaignsGetRunReportErrors, ThrowOnError>;
|
|
300
329
|
/**
|
|
301
330
|
* Pause a campaign run
|
|
302
331
|
*
|
|
@@ -333,7 +362,7 @@ export declare class Campaigns {
|
|
|
333
362
|
id: CampaignId;
|
|
334
363
|
runId: CampaignRunId;
|
|
335
364
|
status?: "pending" | "dispatching" | "dispatched" | "failed" | "skipped" | null | undefined;
|
|
336
|
-
limit?:
|
|
365
|
+
limit?: number | null | undefined;
|
|
337
366
|
cursor?: Cursor | null | undefined;
|
|
338
367
|
}, options?: Options<never, ThrowOnError>): RequestResult<CampaignsListRecipientsResponses, CampaignsListRecipientsErrors, ThrowOnError>;
|
|
339
368
|
}
|
|
@@ -403,9 +432,9 @@ export declare class Email {
|
|
|
403
432
|
* Returns the organization's sending domains, newest first. A namespace-scoped key lists only its namespace's domains; an organization-wide caller lists every domain, or one namespace's with `namespaceId`. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. `sendable=true` lists only domains a send can use now: active, and verified, or verified before and degraded since. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours, the window the 5% bounce limit is enforced over) and `series`, the last 14 days of daily email sends attributed to the domain, oldest first.
|
|
404
433
|
*/
|
|
405
434
|
static listDomains<ThrowOnError extends boolean = false>(parameters?: {
|
|
406
|
-
limit?:
|
|
435
|
+
limit?: number | null | undefined;
|
|
407
436
|
cursor?: Cursor | null | undefined;
|
|
408
|
-
sendable?:
|
|
437
|
+
sendable?: true | null | undefined;
|
|
409
438
|
namespaceId?: NamespaceId | null | undefined;
|
|
410
439
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListDomainsResponses, EmailListDomainsErrors, ThrowOnError>;
|
|
411
440
|
/**
|
|
@@ -531,14 +560,14 @@ export declare class Email {
|
|
|
531
560
|
/**
|
|
532
561
|
* Update a domain's send-settings config
|
|
533
562
|
*
|
|
534
|
-
* Overrides the domain's open/click tracking, reply-to,
|
|
563
|
+
* Overrides the domain's open/click tracking, reply-to, topic defaults, and the brand its mail uses for the settings cascade. An omitted field is left unchanged; null clears it back to the organization default. Returns the saved config.
|
|
535
564
|
*/
|
|
536
565
|
static updateDomainConfig<ThrowOnError extends boolean = false>(parameters: {
|
|
537
566
|
id: EmailDomainId;
|
|
538
567
|
openTracking?: boolean | null | null | undefined;
|
|
539
568
|
clickTracking?: boolean | null | null | undefined;
|
|
540
569
|
replyTo?: Array<string> | null | null | undefined;
|
|
541
|
-
|
|
570
|
+
topicId?: TopicId | null | null | undefined;
|
|
542
571
|
footerEnabled?: boolean | null | null | undefined;
|
|
543
572
|
brandSlug?: string | null | null | undefined;
|
|
544
573
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailUpdateDomainConfigResponses, EmailUpdateDomainConfigErrors, ThrowOnError>;
|
|
@@ -609,11 +638,11 @@ export declare class Email {
|
|
|
609
638
|
* Returns senders, newest first. A namespace-scoped key lists only its namespace's senders; an organization-wide caller lists every sender, or one namespace's with `namespaceId`. Optionally filtered by verification status, active state, or default flag. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours) and `series`, the last 14 days of daily email sends from the address, oldest first.
|
|
610
639
|
*/
|
|
611
640
|
static listSenders<ThrowOnError extends boolean = false>(parameters?: {
|
|
612
|
-
limit?:
|
|
641
|
+
limit?: number | null | undefined;
|
|
613
642
|
cursor?: Cursor | null | undefined;
|
|
614
643
|
verificationStatus?: "pending" | "verified" | "failed" | null | undefined;
|
|
615
|
-
isActive?:
|
|
616
|
-
isDefault?:
|
|
644
|
+
isActive?: boolean | null | undefined;
|
|
645
|
+
isDefault?: boolean | null | undefined;
|
|
617
646
|
namespaceId?: NamespaceId | null | undefined;
|
|
618
647
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListSendersResponses, EmailListSendersErrors, ThrowOnError>;
|
|
619
648
|
/**
|
|
@@ -723,7 +752,7 @@ export declare class Email {
|
|
|
723
752
|
type?: "bounce" | "complaint" | "unsubscribe" | "manual" | null | undefined;
|
|
724
753
|
status?: "active" | "expired" | null | undefined;
|
|
725
754
|
search?: string | null | undefined;
|
|
726
|
-
limit?:
|
|
755
|
+
limit?: number | null | undefined;
|
|
727
756
|
cursor?: Cursor | null | undefined;
|
|
728
757
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListSuppressionsResponses, EmailListSuppressionsErrors, ThrowOnError>;
|
|
729
758
|
/**
|
|
@@ -747,8 +776,8 @@ export declare class Email {
|
|
|
747
776
|
*/
|
|
748
777
|
static listBlocks<ThrowOnError extends boolean = false>(parameters?: {
|
|
749
778
|
blockType?: "email" | "domain" | null | undefined;
|
|
750
|
-
isActive?:
|
|
751
|
-
limit?:
|
|
779
|
+
isActive?: boolean | null | undefined;
|
|
780
|
+
limit?: number | null | undefined;
|
|
752
781
|
cursor?: Cursor | null | undefined;
|
|
753
782
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListBlocksResponses, EmailListBlocksErrors, ThrowOnError>;
|
|
754
783
|
/**
|
|
@@ -793,7 +822,7 @@ export declare class Email {
|
|
|
793
822
|
fromAddress?: string | null | undefined;
|
|
794
823
|
after?: string | null | undefined;
|
|
795
824
|
before?: string | null | undefined;
|
|
796
|
-
limit?:
|
|
825
|
+
limit?: number | null | undefined;
|
|
797
826
|
cursor?: Cursor | null | undefined;
|
|
798
827
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetBlockLogsResponses, EmailGetBlockLogsErrors, ThrowOnError>;
|
|
799
828
|
/**
|
|
@@ -811,7 +840,7 @@ export declare class Email {
|
|
|
811
840
|
*/
|
|
812
841
|
static listForwardingRules<ThrowOnError extends boolean = false>(parameters?: {
|
|
813
842
|
domainId?: EmailDomainId | null | undefined;
|
|
814
|
-
isActive?:
|
|
843
|
+
isActive?: boolean | null | undefined;
|
|
815
844
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailListForwardingRulesResponses, EmailListForwardingRulesErrors, ThrowOnError>;
|
|
816
845
|
/**
|
|
817
846
|
* Create a forwarding rule
|
|
@@ -872,7 +901,7 @@ export declare class Email {
|
|
|
872
901
|
status?: "pending" | "forwarded" | "failed" | null | undefined;
|
|
873
902
|
after?: string | null | undefined;
|
|
874
903
|
before?: string | null | undefined;
|
|
875
|
-
limit?:
|
|
904
|
+
limit?: number | null | undefined;
|
|
876
905
|
cursor?: Cursor | null | undefined;
|
|
877
906
|
}, options?: Options<never, ThrowOnError>): RequestResult<EmailGetForwardingLogResponses, EmailGetForwardingLogErrors, ThrowOnError>;
|
|
878
907
|
/**
|
|
@@ -1027,7 +1056,7 @@ export declare class Attachments {
|
|
|
1027
1056
|
*/
|
|
1028
1057
|
static downloadUrl<ThrowOnError extends boolean = false>(parameters: {
|
|
1029
1058
|
id: AttachmentId;
|
|
1030
|
-
expiresIn?:
|
|
1059
|
+
expiresIn?: number | null | undefined;
|
|
1031
1060
|
}, options?: Options<never, ThrowOnError>): RequestResult<AttachmentsDownloadUrlResponses, AttachmentsDownloadUrlErrors, ThrowOnError>;
|
|
1032
1061
|
}
|
|
1033
1062
|
export declare class Attachments2 {
|
|
@@ -1040,7 +1069,7 @@ export declare class Conversations {
|
|
|
1040
1069
|
* Returns conversation summaries, most recently active first, filterable by status, channel, contact, and creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. A conversation that gains activity while you page moves ahead of the cursor, so a walk lists each conversation at most once. Read a conversation's contacts, metadata, and resolution with `GET /v1/conversations/{id}`.
|
|
1041
1070
|
*/
|
|
1042
1071
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1043
|
-
limit?:
|
|
1072
|
+
limit?: number | null | undefined;
|
|
1044
1073
|
cursor?: Cursor | null | undefined;
|
|
1045
1074
|
status?: "active" | "waiting" | "resolved" | "escalated" | "archived" | null | undefined;
|
|
1046
1075
|
channel?: "email" | null | undefined;
|
|
@@ -1111,7 +1140,7 @@ export declare class Conversations {
|
|
|
1111
1140
|
*/
|
|
1112
1141
|
static listMessages<ThrowOnError extends boolean = false>(parameters: {
|
|
1113
1142
|
id: ConversationId;
|
|
1114
|
-
limit?:
|
|
1143
|
+
limit?: number | null | undefined;
|
|
1115
1144
|
cursor?: Cursor | null | undefined;
|
|
1116
1145
|
after?: string | null | undefined;
|
|
1117
1146
|
before?: string | null | undefined;
|
|
@@ -1173,7 +1202,7 @@ export declare class Conversations {
|
|
|
1173
1202
|
/**
|
|
1174
1203
|
* Remove contacts from a conversation
|
|
1175
1204
|
*
|
|
1176
|
-
* Detaches one or more contacts from a conversation and returns the updated conversation.
|
|
1205
|
+
* Detaches one or more contacts from a conversation and returns the updated conversation. One request carries at most 1000 ids.
|
|
1177
1206
|
*/
|
|
1178
1207
|
static removeContacts<ThrowOnError extends boolean = false>(parameters: {
|
|
1179
1208
|
id: ConversationId;
|
|
@@ -1182,7 +1211,7 @@ export declare class Conversations {
|
|
|
1182
1211
|
/**
|
|
1183
1212
|
* Add contacts to a conversation
|
|
1184
1213
|
*
|
|
1185
|
-
* Attaches one or more contacts to a conversation and returns the updated conversation.
|
|
1214
|
+
* Attaches one or more contacts to a conversation and returns the updated conversation. One request carries at most 1000 ids.
|
|
1186
1215
|
*/
|
|
1187
1216
|
static addContacts<ThrowOnError extends boolean = false>(parameters: {
|
|
1188
1217
|
id: ConversationId;
|
|
@@ -1199,7 +1228,7 @@ export declare class Contacts {
|
|
|
1199
1228
|
* Returns contact summaries for the organization, newest first, filterable by search term, status, and creation time (`after`, `before`). `fields` is a comma-separated list of defined custom field keys to return in each summary's `customFields`; omitted keys and unselected fields are not returned. Filter by one defined custom field with `customField` and a JSON-encoded scalar `customFieldValue` (for example, `"creator"`, `42`, or `true`). Both filter parameters are required together, and unknown keys or values of the wrong type are rejected. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read full identities, profile, and metadata with `GET /v1/contacts/{id}`.
|
|
1200
1229
|
*/
|
|
1201
1230
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1202
|
-
limit?:
|
|
1231
|
+
limit?: number | null | undefined;
|
|
1203
1232
|
cursor?: Cursor | null | undefined;
|
|
1204
1233
|
namespaceId?: NamespaceId | null | undefined;
|
|
1205
1234
|
search?: string | null | undefined;
|
|
@@ -1351,31 +1380,106 @@ export declare class Contacts {
|
|
|
1351
1380
|
id: ContactId;
|
|
1352
1381
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsGetEngagementResponses, ContactsGetEngagementErrors, ThrowOnError>;
|
|
1353
1382
|
/**
|
|
1354
|
-
*
|
|
1383
|
+
* Preview a list migration
|
|
1355
1384
|
*
|
|
1356
|
-
*
|
|
1385
|
+
* The complete encoded JSON request must not exceed 3000000 bytes. Reads multiple declared export files without changing contacts. Restrictive evidence wins per address. Returns estimated counts and at most 100 diagnostics; processing rechecks current restrictions. Filenames never establish permission. Requires listMigration. Missing required columns refuse the file; unknown status values are conflicts and never subscribe a reader.
|
|
1357
1386
|
*/
|
|
1358
|
-
static
|
|
1387
|
+
static planImport<ThrowOnError extends boolean = false>(parameters: {
|
|
1388
|
+
preset: "beehiiv" | "substack" | "kit" | "mailchimp";
|
|
1389
|
+
topicId: TopicId;
|
|
1359
1390
|
namespaceId?: NamespaceId | null | undefined;
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1391
|
+
files: [
|
|
1392
|
+
{
|
|
1393
|
+
name: string;
|
|
1394
|
+
csv: string;
|
|
1395
|
+
evidence: {
|
|
1396
|
+
kind: "status_column";
|
|
1397
|
+
} | {
|
|
1398
|
+
kind: "export_scope";
|
|
1399
|
+
scope: "subscribed" | "unsubscribed" | "suppressed" | "cleaned/bounced";
|
|
1400
|
+
};
|
|
1401
|
+
/**
|
|
1402
|
+
* The operator declares this beehiiv export was filtered to Suppression does not exist.
|
|
1403
|
+
*/
|
|
1404
|
+
suppressionFree?: boolean | null | undefined;
|
|
1405
|
+
},
|
|
1406
|
+
...Array<{
|
|
1407
|
+
name: string;
|
|
1408
|
+
csv: string;
|
|
1409
|
+
evidence: {
|
|
1410
|
+
kind: "status_column";
|
|
1411
|
+
} | {
|
|
1412
|
+
kind: "export_scope";
|
|
1413
|
+
scope: "subscribed" | "unsubscribed" | "suppressed" | "cleaned/bounced";
|
|
1414
|
+
};
|
|
1415
|
+
/**
|
|
1416
|
+
* The operator declares this beehiiv export was filtered to Suppression does not exist.
|
|
1417
|
+
*/
|
|
1418
|
+
suppressionFree?: boolean | null | undefined;
|
|
1419
|
+
}>
|
|
1420
|
+
];
|
|
1421
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsPlanImportResponses, ContactsPlanImportErrors, ThrowOnError>;
|
|
1422
|
+
/**
|
|
1423
|
+
* Start or resume a list migration
|
|
1424
|
+
*
|
|
1425
|
+
* The complete encoded JSON request, including new-start metadata, must not exceed 3000000 bytes. Admits a durable import using the preview hash and an idempotency key, or resumes the same persisted input at its committed cursor. Imports never restore an existing unsubscribe, suppression or bounce. Namespace-scoped credentials cannot create organization-wide suppressions; those rows are conflicts and create no contact. New active contacts are billable and normal contact events apply. Requires listMigration for new admissions.
|
|
1426
|
+
*/
|
|
1427
|
+
static startImport<ThrowOnError extends boolean = false>(parameters: {
|
|
1428
|
+
mode: "new";
|
|
1429
|
+
input: {
|
|
1430
|
+
preset: "beehiiv" | "substack" | "kit" | "mailchimp";
|
|
1431
|
+
topicId: TopicId;
|
|
1432
|
+
namespaceId?: NamespaceId | null | undefined;
|
|
1433
|
+
files: [
|
|
1434
|
+
{
|
|
1435
|
+
name: string;
|
|
1436
|
+
csv: string;
|
|
1437
|
+
evidence: {
|
|
1438
|
+
kind: "status_column";
|
|
1439
|
+
} | {
|
|
1440
|
+
kind: "export_scope";
|
|
1441
|
+
scope: "subscribed" | "unsubscribed" | "suppressed" | "cleaned/bounced";
|
|
1442
|
+
};
|
|
1443
|
+
/**
|
|
1444
|
+
* The operator declares this beehiiv export was filtered to Suppression does not exist.
|
|
1445
|
+
*/
|
|
1446
|
+
suppressionFree?: boolean | null | undefined;
|
|
1447
|
+
},
|
|
1448
|
+
...Array<{
|
|
1449
|
+
name: string;
|
|
1450
|
+
csv: string;
|
|
1451
|
+
evidence: {
|
|
1452
|
+
kind: "status_column";
|
|
1453
|
+
} | {
|
|
1454
|
+
kind: "export_scope";
|
|
1455
|
+
scope: "subscribed" | "unsubscribed" | "suppressed" | "cleaned/bounced";
|
|
1456
|
+
};
|
|
1457
|
+
/**
|
|
1458
|
+
* The operator declares this beehiiv export was filtered to Suppression does not exist.
|
|
1459
|
+
*/
|
|
1460
|
+
suppressionFree?: boolean | null | undefined;
|
|
1461
|
+
}>
|
|
1462
|
+
];
|
|
1463
|
+
};
|
|
1464
|
+
planHash: string;
|
|
1465
|
+
idempotencyKey: string;
|
|
1466
|
+
} | {
|
|
1467
|
+
mode: "resume";
|
|
1468
|
+
jobId: ContactImportJobId;
|
|
1469
|
+
expectedGeneration: number;
|
|
1470
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsStartImportResponses, ContactsStartImportErrors, ThrowOnError>;
|
|
1471
|
+
/**
|
|
1472
|
+
* Get list migration progress
|
|
1473
|
+
*
|
|
1474
|
+
* Returns the visible import job's committed counts, generation, terminal failure and resumability. The job persists across worker restarts and page reloads. Admitted jobs remain readable when listMigration is disabled.
|
|
1475
|
+
*/
|
|
1476
|
+
static getImportJob<ThrowOnError extends boolean = false>(parameters: {
|
|
1477
|
+
id: ContactImportJobId;
|
|
1478
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsGetImportJobResponses, ContactsGetImportJobErrors, ThrowOnError>;
|
|
1375
1479
|
/**
|
|
1376
1480
|
* Bulk delete contacts
|
|
1377
1481
|
*
|
|
1378
|
-
* Permanently deletes multiple contacts by ID, returning counts of deleted and failed records.
|
|
1482
|
+
* Permanently deletes multiple contacts by ID, returning counts of deleted and failed records. One request carries at most 1000 ids.
|
|
1379
1483
|
*/
|
|
1380
1484
|
static bulkDelete<ThrowOnError extends boolean = false>(parameters: {
|
|
1381
1485
|
ids: [ContactId, ...Array<ContactId>];
|
|
@@ -1383,7 +1487,7 @@ export declare class Contacts {
|
|
|
1383
1487
|
/**
|
|
1384
1488
|
* Bulk update contact tags
|
|
1385
1489
|
*
|
|
1386
|
-
* Adds, removes, or replaces tags on multiple contacts in one request, returning counts of updated and failed records.
|
|
1490
|
+
* Adds, removes, or replaces tags on multiple contacts in one request, returning counts of updated and failed records. One request carries at most 1000 ids.
|
|
1387
1491
|
*/
|
|
1388
1492
|
static bulkUpdateTags<ThrowOnError extends boolean = false>(parameters: {
|
|
1389
1493
|
ids: [ContactId, ...Array<ContactId>];
|
|
@@ -1393,7 +1497,7 @@ export declare class Contacts {
|
|
|
1393
1497
|
/**
|
|
1394
1498
|
* Bulk update contact status
|
|
1395
1499
|
*
|
|
1396
|
-
* Sets the status on multiple contacts in one request, returning counts of updated and failed records.
|
|
1500
|
+
* Sets the status on multiple contacts in one request, returning counts of updated and failed records. One request carries at most 1000 ids.
|
|
1397
1501
|
*/
|
|
1398
1502
|
static bulkUpdateStatus<ThrowOnError extends boolean = false>(parameters: {
|
|
1399
1503
|
ids: [ContactId, ...Array<ContactId>];
|
|
@@ -1402,7 +1506,7 @@ export declare class Contacts {
|
|
|
1402
1506
|
/**
|
|
1403
1507
|
* Export contacts
|
|
1404
1508
|
*
|
|
1405
|
-
* Exports contacts as JSON or CSV, returning the serialized data and a count of exported records.
|
|
1509
|
+
* Exports contacts as JSON or CSV, returning the serialized data and a count of exported records. The ids filter takes at most 1000 ids.
|
|
1406
1510
|
*/
|
|
1407
1511
|
static export<ThrowOnError extends boolean = false>(parameters?: {
|
|
1408
1512
|
ids?: Array<ContactId> | null | undefined;
|
|
@@ -1420,7 +1524,7 @@ export declare class Contacts {
|
|
|
1420
1524
|
*/
|
|
1421
1525
|
static getActivityTimeline<ThrowOnError extends boolean = false>(parameters: {
|
|
1422
1526
|
id: ContactId;
|
|
1423
|
-
limit?:
|
|
1527
|
+
limit?: number | null | undefined;
|
|
1424
1528
|
cursor?: Cursor | null | undefined;
|
|
1425
1529
|
channel?: "email" | null | undefined;
|
|
1426
1530
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsGetActivityTimelineResponses, ContactsGetActivityTimelineErrors, ThrowOnError>;
|
|
@@ -1431,7 +1535,7 @@ export declare class Contacts {
|
|
|
1431
1535
|
*/
|
|
1432
1536
|
static getGroupMemberships<ThrowOnError extends boolean = false>(parameters: {
|
|
1433
1537
|
id: ContactId;
|
|
1434
|
-
limit?:
|
|
1538
|
+
limit?: number | null | undefined;
|
|
1435
1539
|
cursor?: Cursor | null | undefined;
|
|
1436
1540
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactsGetGroupMembershipsResponses, ContactsGetGroupMembershipsErrors, ThrowOnError>;
|
|
1437
1541
|
}
|
|
@@ -1471,7 +1575,7 @@ export declare class ContactEvents {
|
|
|
1471
1575
|
*/
|
|
1472
1576
|
static listEvents<ThrowOnError extends boolean = false>(parameters: {
|
|
1473
1577
|
id: ContactId;
|
|
1474
|
-
limit?:
|
|
1578
|
+
limit?: number | null | undefined;
|
|
1475
1579
|
cursor?: Cursor | null | undefined;
|
|
1476
1580
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactEventsListEventsResponses, ContactEventsListEventsErrors, ThrowOnError>;
|
|
1477
1581
|
}
|
|
@@ -1486,7 +1590,7 @@ export declare class Journeys {
|
|
|
1486
1590
|
*/
|
|
1487
1591
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1488
1592
|
status?: JourneyStatus | null | undefined;
|
|
1489
|
-
limit?:
|
|
1593
|
+
limit?: number | null | undefined;
|
|
1490
1594
|
cursor?: Cursor | null | undefined;
|
|
1491
1595
|
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysListResponses, JourneysListErrors, ThrowOnError>;
|
|
1492
1596
|
/**
|
|
@@ -1582,7 +1686,7 @@ export declare class Journeys {
|
|
|
1582
1686
|
*/
|
|
1583
1687
|
static stats<ThrowOnError extends boolean = false>(parameters: {
|
|
1584
1688
|
id: JourneyId;
|
|
1585
|
-
version?:
|
|
1689
|
+
version?: number | null | undefined;
|
|
1586
1690
|
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysStatsResponses, JourneysStatsErrors, ThrowOnError>;
|
|
1587
1691
|
/**
|
|
1588
1692
|
* List journey runs
|
|
@@ -1593,7 +1697,7 @@ export declare class Journeys {
|
|
|
1593
1697
|
id: JourneyId;
|
|
1594
1698
|
status?: JourneyRunStatus | null | undefined;
|
|
1595
1699
|
contactId?: ContactId | null | undefined;
|
|
1596
|
-
limit?:
|
|
1700
|
+
limit?: number | null | undefined;
|
|
1597
1701
|
cursor?: Cursor | null | undefined;
|
|
1598
1702
|
}, options?: Options<never, ThrowOnError>): RequestResult<JourneysListRunsResponses, JourneysListRunsErrors, ThrowOnError>;
|
|
1599
1703
|
/**
|
|
@@ -1616,7 +1720,7 @@ export declare class Agents {
|
|
|
1616
1720
|
* Returns the agents the caller can reach, newest first, without their drafts. Pass nextCursor back as cursor for the next page.
|
|
1617
1721
|
*/
|
|
1618
1722
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1619
|
-
limit?:
|
|
1723
|
+
limit?: number | null | undefined;
|
|
1620
1724
|
cursor?: Cursor | null | undefined;
|
|
1621
1725
|
}, options?: Options<never, ThrowOnError>): RequestResult<AgentsListResponses, AgentsListErrors, ThrowOnError>;
|
|
1622
1726
|
/**
|
|
@@ -1680,7 +1784,7 @@ export declare class Agents {
|
|
|
1680
1784
|
*/
|
|
1681
1785
|
static listVersions<ThrowOnError extends boolean = false>(parameters: {
|
|
1682
1786
|
id: AgentId;
|
|
1683
|
-
limit?:
|
|
1787
|
+
limit?: number | null | undefined;
|
|
1684
1788
|
cursor?: VersionCursor | null | undefined;
|
|
1685
1789
|
}, options?: Options<never, ThrowOnError>): RequestResult<AgentsListVersionsResponses, AgentsListVersionsErrors, ThrowOnError>;
|
|
1686
1790
|
/**
|
|
@@ -1700,16 +1804,15 @@ export declare class Subscriptions {
|
|
|
1700
1804
|
/**
|
|
1701
1805
|
* Request subscription confirmation
|
|
1702
1806
|
*
|
|
1703
|
-
* Sends a confirmation email from your sender. Only the recipient's explicit confirmation
|
|
1807
|
+
* Sends a confirmation email from your sender. Only the recipient's explicit confirmation creates their contact and subscribes them to the named topic. The link expires after seven days and can be used once. A custom published email template receives confirmUrl. Sending follows ordinary sender, admission, billing, and brand-footer settings. Requires email send authority in addition to the declared contact grants, including the topic subscription change.
|
|
1704
1808
|
*/
|
|
1705
1809
|
static subscribe<ThrowOnError extends boolean = false>(parameters: {
|
|
1706
1810
|
email: string;
|
|
1707
|
-
|
|
1811
|
+
topicId: TopicId;
|
|
1708
1812
|
from: {
|
|
1709
1813
|
email: string;
|
|
1710
1814
|
name?: string | null | undefined;
|
|
1711
1815
|
};
|
|
1712
|
-
unsubscribeGroupId?: UnsubscribeId | null | undefined;
|
|
1713
1816
|
templateSlug?: string | null | undefined;
|
|
1714
1817
|
consentIp?: string | null | undefined;
|
|
1715
1818
|
consentSource?: string | null | undefined;
|
|
@@ -1725,10 +1828,10 @@ export declare class ContactGroups {
|
|
|
1725
1828
|
* Returns the organization's contact groups, newest first, filterable by type and active state. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
1726
1829
|
*/
|
|
1727
1830
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1728
|
-
limit?:
|
|
1831
|
+
limit?: number | null | undefined;
|
|
1729
1832
|
cursor?: Cursor | null | undefined;
|
|
1730
1833
|
type?: "static" | "dynamic" | "smart" | Array<"static" | "dynamic" | "smart"> | null | undefined;
|
|
1731
|
-
isActive?:
|
|
1834
|
+
isActive?: boolean | null | undefined;
|
|
1732
1835
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsListResponses, ContactGroupsListErrors, ThrowOnError>;
|
|
1733
1836
|
/**
|
|
1734
1837
|
* Create a contact group
|
|
@@ -1784,7 +1887,7 @@ export declare class ContactGroups {
|
|
|
1784
1887
|
/**
|
|
1785
1888
|
* Remove members from a contact group
|
|
1786
1889
|
*
|
|
1787
|
-
* Removes one or more contacts from a contact group, returning the count of removed members.
|
|
1890
|
+
* Removes one or more contacts from a contact group, returning the count of removed members. One request carries at most 1000 ids.
|
|
1788
1891
|
*/
|
|
1789
1892
|
static removeMembers<ThrowOnError extends boolean = false>(parameters: {
|
|
1790
1893
|
id: ContactGroupId;
|
|
@@ -1797,13 +1900,13 @@ export declare class ContactGroups {
|
|
|
1797
1900
|
*/
|
|
1798
1901
|
static getMembers<ThrowOnError extends boolean = false>(parameters: {
|
|
1799
1902
|
id: ContactGroupId;
|
|
1800
|
-
limit?:
|
|
1903
|
+
limit?: number | null | undefined;
|
|
1801
1904
|
cursor?: Cursor | null | undefined;
|
|
1802
1905
|
}, options?: Options<never, ThrowOnError>): RequestResult<ContactGroupsGetMembersResponses, ContactGroupsGetMembersErrors, ThrowOnError>;
|
|
1803
1906
|
/**
|
|
1804
1907
|
* Add members to a contact group
|
|
1805
1908
|
*
|
|
1806
|
-
* Adds one or more contacts to a contact group, returning counts of added and skipped members.
|
|
1909
|
+
* Adds one or more contacts to a contact group, returning counts of added and skipped members. One request carries at most 1000 ids.
|
|
1807
1910
|
*/
|
|
1808
1911
|
static addMembers<ThrowOnError extends boolean = false>(parameters: {
|
|
1809
1912
|
id: ContactGroupId;
|
|
@@ -1885,91 +1988,167 @@ export declare class CustomFields {
|
|
|
1885
1988
|
export declare class CustomFields2 {
|
|
1886
1989
|
static customFields: typeof CustomFields;
|
|
1887
1990
|
}
|
|
1888
|
-
export declare class
|
|
1991
|
+
export declare class Topics {
|
|
1889
1992
|
/**
|
|
1890
|
-
* List
|
|
1993
|
+
* List topics
|
|
1891
1994
|
*
|
|
1892
|
-
*
|
|
1995
|
+
* Lists visible topics, default first then by name. The organization holds at most 200 topics, so the list is bounded and unpaged.
|
|
1893
1996
|
*/
|
|
1894
|
-
static list<ThrowOnError extends boolean = false>(
|
|
1997
|
+
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1998
|
+
namespaceId?: NamespaceId | null | undefined;
|
|
1999
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsListResponses, TopicsListErrors, ThrowOnError>;
|
|
1895
2000
|
/**
|
|
1896
|
-
* Create
|
|
2001
|
+
* Create a topic
|
|
1897
2002
|
*
|
|
1898
|
-
* Creates a
|
|
2003
|
+
* Creates a topic in the caller's or requested namespace. The subscription default is opt_out when omitted. Publishing defaults must be compatible with that namespace. An organization holds at most 200 topics.
|
|
1899
2004
|
*/
|
|
1900
2005
|
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
1901
2006
|
name: string;
|
|
1902
2007
|
description?: string | null | null | undefined;
|
|
1903
|
-
|
|
2008
|
+
namespaceId?: NamespaceId | null | null | undefined;
|
|
2009
|
+
default?: "opt_out" | "opt_in" | null | undefined;
|
|
2010
|
+
defaultSenderId?: EmailSenderId | null | null | undefined;
|
|
2011
|
+
replyMailboxId?: MailboxId | null | null | undefined;
|
|
2012
|
+
templateId?: TemplateId | null | null | undefined;
|
|
2013
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsCreateResponses, TopicsCreateErrors, ThrowOnError>;
|
|
2014
|
+
/**
|
|
2015
|
+
* Check topic subscriptions
|
|
2016
|
+
*
|
|
2017
|
+
* Name exactly one contactId, email, or phone and a channel. Returns effective status, using the topic default when no explicit subscription exists. topicIds is an optional comma-separated list. Addresses resolve within the requested namespace; an unknown address returns contactId null and the effective defaults.
|
|
2018
|
+
*/
|
|
2019
|
+
static checkSubscription<ThrowOnError extends boolean = false>(parameters: {
|
|
2020
|
+
contactId?: ContactId | null | undefined;
|
|
2021
|
+
email?: string | null | undefined;
|
|
2022
|
+
phone?: string | null | undefined;
|
|
2023
|
+
namespaceId?: NamespaceId | null | undefined;
|
|
2024
|
+
channel: "email";
|
|
2025
|
+
topicIds?: string | null | undefined;
|
|
2026
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsCheckSubscriptionResponses, TopicsCheckSubscriptionErrors, ThrowOnError>;
|
|
1904
2027
|
/**
|
|
1905
|
-
* Delete
|
|
2028
|
+
* Delete a topic
|
|
1906
2029
|
*
|
|
1907
|
-
*
|
|
2030
|
+
* Refuses the default topic and any topic a scheduled or running campaign uses.
|
|
1908
2031
|
*/
|
|
1909
2032
|
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1910
|
-
id:
|
|
1911
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
2033
|
+
id: TopicId;
|
|
2034
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsRemoveResponses, TopicsRemoveErrors, ThrowOnError>;
|
|
2035
|
+
/**
|
|
2036
|
+
* Get a topic
|
|
2037
|
+
*
|
|
2038
|
+
* Returns a visible topic, its publishing defaults, and explicit subscription counts by channel and status. Individual subscriptions are read through listSubscriptions.
|
|
2039
|
+
*/
|
|
2040
|
+
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
2041
|
+
id: TopicId;
|
|
2042
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsGetResponses, TopicsGetErrors, ThrowOnError>;
|
|
1912
2043
|
/**
|
|
1913
|
-
* Update
|
|
2044
|
+
* Update a topic
|
|
1914
2045
|
*
|
|
1915
|
-
* Updates the
|
|
2046
|
+
* Updates named fields. Changing the default does not change any explicit subscription status. Null clears a publishing default.
|
|
1916
2047
|
*/
|
|
1917
2048
|
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
1918
|
-
id:
|
|
2049
|
+
id: TopicId;
|
|
1919
2050
|
name?: string | null | undefined;
|
|
1920
2051
|
description?: string | null | null | undefined;
|
|
1921
|
-
|
|
2052
|
+
default?: "opt_out" | "opt_in" | null | undefined;
|
|
2053
|
+
defaultSenderId?: EmailSenderId | null | null | undefined;
|
|
2054
|
+
replyMailboxId?: MailboxId | null | null | undefined;
|
|
2055
|
+
templateId?: TemplateId | null | null | undefined;
|
|
2056
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsUpdateResponses, TopicsUpdateErrors, ThrowOnError>;
|
|
1922
2057
|
/**
|
|
1923
|
-
* Make
|
|
2058
|
+
* Make a topic the default
|
|
1924
2059
|
*
|
|
1925
|
-
* Makes this
|
|
2060
|
+
* Makes this the default category of messages in its namespace. Existing explicit subscription statuses remain unchanged.
|
|
1926
2061
|
*/
|
|
1927
2062
|
static setDefault<ThrowOnError extends boolean = false>(parameters: {
|
|
1928
|
-
id:
|
|
1929
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<
|
|
2063
|
+
id: TopicId;
|
|
2064
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsSetDefaultResponses, TopicsSetDefaultErrors, ThrowOnError>;
|
|
1930
2065
|
/**
|
|
1931
|
-
*
|
|
2066
|
+
* List topic subscriptions
|
|
1932
2067
|
*
|
|
1933
|
-
* Returns
|
|
2068
|
+
* Returns explicit per-channel subscriptions, newest first, optionally filtered by channel and status. Pass nextCursor as cursor to continue; nextCursor is null on the last page. Contacts without an explicit subscription are absent from this list.
|
|
1934
2069
|
*/
|
|
1935
|
-
static
|
|
1936
|
-
id:
|
|
1937
|
-
|
|
1938
|
-
|
|
2070
|
+
static listSubscriptions<ThrowOnError extends boolean = false>(parameters: {
|
|
2071
|
+
id: TopicId;
|
|
2072
|
+
limit?: number | null | undefined;
|
|
2073
|
+
cursor?: Cursor | null | undefined;
|
|
2074
|
+
channel?: "email" | null | undefined;
|
|
2075
|
+
status?: "subscribed" | "unsubscribed" | null | undefined;
|
|
2076
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsListSubscriptionsResponses, TopicsListSubscriptionsErrors, ThrowOnError>;
|
|
1939
2077
|
/**
|
|
1940
|
-
*
|
|
2078
|
+
* Set topic subscriptions
|
|
1941
2079
|
*
|
|
1942
|
-
*
|
|
2080
|
+
* Upserts explicit subscribed or unsubscribed status for one channel. Each contact is named by ID, email, or phone. New addresses create contacts in the topic's namespace. Repeating the same status is idempotent.
|
|
1943
2081
|
*/
|
|
1944
|
-
static
|
|
1945
|
-
id:
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
2082
|
+
static setSubscriptions<ThrowOnError extends boolean = false>(parameters: {
|
|
2083
|
+
id: TopicId;
|
|
2084
|
+
contacts: Array<TopicContactRef>;
|
|
2085
|
+
channel: "email";
|
|
2086
|
+
status: "subscribed" | "unsubscribed";
|
|
2087
|
+
source?: string | null | undefined;
|
|
2088
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicsSetSubscriptionsResponses, TopicsSetSubscriptionsErrors, ThrowOnError>;
|
|
2089
|
+
}
|
|
2090
|
+
export declare class Topics2 {
|
|
2091
|
+
static topics: typeof Topics;
|
|
2092
|
+
}
|
|
2093
|
+
export declare class TopicForms {
|
|
1949
2094
|
/**
|
|
1950
|
-
*
|
|
2095
|
+
* List topic forms
|
|
1951
2096
|
*
|
|
1952
|
-
*
|
|
2097
|
+
* Lists the signup forms belonging to the visible topic. Requires topicSignup. Forms contain exact HTTPS allowed origins, bounded confirmation and success copy, an optional HTTPS redirect, and a public key for hosted or embedded signup.
|
|
1953
2098
|
*/
|
|
1954
|
-
static
|
|
1955
|
-
id:
|
|
1956
|
-
|
|
1957
|
-
source?: "link" | "api" | "manual" | "complaint" | null | undefined;
|
|
1958
|
-
}, options?: Options<never, ThrowOnError>): RequestResult<UnsubscribeAddMembersResponses, UnsubscribeAddMembersErrors, ThrowOnError>;
|
|
2099
|
+
static list<ThrowOnError extends boolean = false>(parameters: {
|
|
2100
|
+
id: TopicId;
|
|
2101
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicFormsListResponses, TopicFormsListErrors, ThrowOnError>;
|
|
1959
2102
|
/**
|
|
1960
|
-
*
|
|
2103
|
+
* Create a topic form
|
|
1961
2104
|
*
|
|
1962
|
-
*
|
|
2105
|
+
* Creates a signup form for the visible topic and returns 201. The server generates its opaque public key. allowedOrigins contains exact HTTPS origins; the canonical web origin and current topic link origin are also accepted. Copy is plain text and redirectUrl is HTTPS or null. Requires topicSignup.
|
|
1963
2106
|
*/
|
|
1964
|
-
static
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
|
|
2107
|
+
static create<ThrowOnError extends boolean = false>(parameters: {
|
|
2108
|
+
id: TopicId;
|
|
2109
|
+
allowedOrigins: Array<string>;
|
|
2110
|
+
confirmationTitle: string;
|
|
2111
|
+
confirmationMessage: string;
|
|
2112
|
+
successTitle: string;
|
|
2113
|
+
successMessage: string;
|
|
2114
|
+
redirectUrl: string | null;
|
|
2115
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicFormsCreateResponses, TopicFormsCreateErrors, ThrowOnError>;
|
|
2116
|
+
/**
|
|
2117
|
+
* Delete a topic form
|
|
2118
|
+
*
|
|
2119
|
+
* Deletes a form belonging to the visible topic. Its public key immediately stops accepting signups. Existing email confirmation links keep their snapshotted copy and remain valid until expiry. Requires topicSignup.
|
|
2120
|
+
*/
|
|
2121
|
+
static remove<ThrowOnError extends boolean = false>(parameters: {
|
|
2122
|
+
id: TopicId;
|
|
2123
|
+
formId: string;
|
|
2124
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicFormsRemoveResponses, TopicFormsRemoveErrors, ThrowOnError>;
|
|
2125
|
+
/**
|
|
2126
|
+
* Get a topic form
|
|
2127
|
+
*
|
|
2128
|
+
* Returns a signup form belonging to the visible topic, including its public key and current link origin. Forms outside the caller namespace or organization return 404. Requires topicSignup.
|
|
2129
|
+
*/
|
|
2130
|
+
static get<ThrowOnError extends boolean = false>(parameters: {
|
|
2131
|
+
id: TopicId;
|
|
2132
|
+
formId: string;
|
|
2133
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicFormsGetResponses, TopicFormsGetErrors, ThrowOnError>;
|
|
2134
|
+
/**
|
|
2135
|
+
* Update a topic form
|
|
2136
|
+
*
|
|
2137
|
+
* Updates only the supplied form fields. allowedOrigins replaces the complete exact-origin allowlist; redirectUrl null clears the success redirect. The public key remains stable. Requires topicSignup.
|
|
2138
|
+
*/
|
|
2139
|
+
static update<ThrowOnError extends boolean = false>(parameters: {
|
|
2140
|
+
id: TopicId;
|
|
2141
|
+
formId: string;
|
|
2142
|
+
allowedOrigins?: Array<string> | null | undefined;
|
|
2143
|
+
confirmationTitle?: string | null | undefined;
|
|
2144
|
+
confirmationMessage?: string | null | undefined;
|
|
2145
|
+
successTitle?: string | null | undefined;
|
|
2146
|
+
successMessage?: string | null | undefined;
|
|
2147
|
+
redirectUrl?: string | null | null | undefined;
|
|
2148
|
+
}, options?: Options<never, ThrowOnError>): RequestResult<TopicFormsUpdateResponses, TopicFormsUpdateErrors, ThrowOnError>;
|
|
1970
2149
|
}
|
|
1971
|
-
export declare class
|
|
1972
|
-
static
|
|
2150
|
+
export declare class TopicForms2 {
|
|
2151
|
+
static topicForms: typeof TopicForms;
|
|
1973
2152
|
}
|
|
1974
2153
|
export declare class Analytics {
|
|
1975
2154
|
/**
|
|
@@ -2000,7 +2179,7 @@ export declare class Analytics {
|
|
|
2000
2179
|
static getTopContacts<ThrowOnError extends boolean = false>(parameters?: {
|
|
2001
2180
|
after?: string | null | undefined;
|
|
2002
2181
|
before?: string | null | undefined;
|
|
2003
|
-
limit?:
|
|
2182
|
+
limit?: number | null | undefined;
|
|
2004
2183
|
sortBy?: "sent" | "received" | "total" | null | undefined;
|
|
2005
2184
|
}, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsGetTopContactsResponses, AnalyticsGetTopContactsErrors, ThrowOnError>;
|
|
2006
2185
|
/**
|
|
@@ -2044,7 +2223,7 @@ export declare class Templates {
|
|
|
2044
2223
|
* Returns template summaries, newest first, filterable by category, channel, status, project, and search. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read a template's compiled content, current publication, and input schema with `GET /v1/templates/{id}`.
|
|
2045
2224
|
*/
|
|
2046
2225
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2047
|
-
limit?:
|
|
2226
|
+
limit?: number | null | undefined;
|
|
2048
2227
|
cursor?: Cursor | null | undefined;
|
|
2049
2228
|
category?: "transactional" | "marketing" | "support" | "notification" | "verification" | "reminder" | "alert" | null | undefined;
|
|
2050
2229
|
channel?: "email" | null | undefined;
|
|
@@ -2052,7 +2231,7 @@ export declare class Templates {
|
|
|
2052
2231
|
search?: string | null | undefined;
|
|
2053
2232
|
projectId?: TemplateProjectId | null | undefined;
|
|
2054
2233
|
namespaceId?: NamespaceId | null | undefined;
|
|
2055
|
-
shared?:
|
|
2234
|
+
shared?: boolean | null | undefined;
|
|
2056
2235
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListResponses, TemplatesListErrors, ThrowOnError>;
|
|
2057
2236
|
/**
|
|
2058
2237
|
* Create a template
|
|
@@ -2078,7 +2257,7 @@ export declare class Templates {
|
|
|
2078
2257
|
* Returns the organization's template families with their members, newest first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
2079
2258
|
*/
|
|
2080
2259
|
static listFamilies<ThrowOnError extends boolean = false>(parameters?: {
|
|
2081
|
-
limit?:
|
|
2260
|
+
limit?: number | null | undefined;
|
|
2082
2261
|
cursor?: Cursor | null | undefined;
|
|
2083
2262
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListFamiliesResponses, TemplatesListFamiliesErrors, ThrowOnError>;
|
|
2084
2263
|
/**
|
|
@@ -2295,7 +2474,7 @@ export declare class Templates {
|
|
|
2295
2474
|
*/
|
|
2296
2475
|
static workspaceHistory<ThrowOnError extends boolean = false>(parameters: {
|
|
2297
2476
|
id: TemplateId;
|
|
2298
|
-
limit?:
|
|
2477
|
+
limit?: number | null | undefined;
|
|
2299
2478
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesWorkspaceHistoryResponses, TemplatesWorkspaceHistoryErrors, ThrowOnError>;
|
|
2300
2479
|
/**
|
|
2301
2480
|
* Check a template project workspace
|
|
@@ -2359,7 +2538,7 @@ export declare class Templates {
|
|
|
2359
2538
|
*/
|
|
2360
2539
|
static listInputContracts<ThrowOnError extends boolean = false>(parameters: {
|
|
2361
2540
|
id: TemplateId;
|
|
2362
|
-
limit?:
|
|
2541
|
+
limit?: number | null | undefined;
|
|
2363
2542
|
cursor?: VersionCursor | null | undefined;
|
|
2364
2543
|
}, options?: Options<never, ThrowOnError>): RequestResult<TemplatesListInputContractsResponses, TemplatesListInputContractsErrors, ThrowOnError>;
|
|
2365
2544
|
/**
|
|
@@ -2490,7 +2669,7 @@ export declare class Webhooks {
|
|
|
2490
2669
|
* Returns the organization's webhook endpoints, oldest first, with each endpoint's delivery counts, optionally filtered by a search term matched against name and URL, and by status. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
2491
2670
|
*/
|
|
2492
2671
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2493
|
-
limit?:
|
|
2672
|
+
limit?: number | null | undefined;
|
|
2494
2673
|
cursor?: Cursor | null | undefined;
|
|
2495
2674
|
search?: string | null | undefined;
|
|
2496
2675
|
status?: "active" | "disabled" | null | undefined;
|
|
@@ -2564,7 +2743,7 @@ export declare class Webhooks {
|
|
|
2564
2743
|
*/
|
|
2565
2744
|
static getLogs<ThrowOnError extends boolean = false>(parameters: {
|
|
2566
2745
|
id: WebhookEndpointId;
|
|
2567
|
-
limit?:
|
|
2746
|
+
limit?: number | null | undefined;
|
|
2568
2747
|
cursor?: Cursor | null | undefined;
|
|
2569
2748
|
}, options?: Options<never, ThrowOnError>): RequestResult<WebhooksGetLogsResponses, WebhooksGetLogsErrors, ThrowOnError>;
|
|
2570
2749
|
/**
|
|
@@ -2686,7 +2865,7 @@ export declare class ApiKeys {
|
|
|
2686
2865
|
* Returns the organization's API keys, newest first, filterable by status and a search term matched against name and description. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
2687
2866
|
*/
|
|
2688
2867
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2689
|
-
limit?:
|
|
2868
|
+
limit?: number | null | undefined;
|
|
2690
2869
|
cursor?: Cursor | null | undefined;
|
|
2691
2870
|
status?: "active" | "revoked" | null | undefined;
|
|
2692
2871
|
search?: string | null | undefined;
|
|
@@ -2754,7 +2933,7 @@ export declare class ApiKeys {
|
|
|
2754
2933
|
*/
|
|
2755
2934
|
static getActivity<ThrowOnError extends boolean = false>(parameters: {
|
|
2756
2935
|
id: ApiKeyId;
|
|
2757
|
-
limit?:
|
|
2936
|
+
limit?: number | null | undefined;
|
|
2758
2937
|
cursor?: Cursor | null | undefined;
|
|
2759
2938
|
}, options?: Options<never, ThrowOnError>): RequestResult<ApiKeysGetActivityResponses, ApiKeysGetActivityErrors, ThrowOnError>;
|
|
2760
2939
|
}
|
|
@@ -2794,7 +2973,7 @@ export declare class Mailboxes {
|
|
|
2794
2973
|
* Returns summaries of the mailboxes the caller can read, newest first, filterable by creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read a mailbox's endpoints and metadata with `GET /v1/mailboxes/{id}`.
|
|
2795
2974
|
*/
|
|
2796
2975
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2797
|
-
limit?:
|
|
2976
|
+
limit?: number | null | undefined;
|
|
2798
2977
|
cursor?: Cursor | null | undefined;
|
|
2799
2978
|
after?: string | null | undefined;
|
|
2800
2979
|
before?: string | null | undefined;
|
|
@@ -2901,7 +3080,7 @@ export declare class Mailboxes {
|
|
|
2901
3080
|
*/
|
|
2902
3081
|
static listGrants<ThrowOnError extends boolean = false>(parameters: {
|
|
2903
3082
|
id: MailboxId;
|
|
2904
|
-
limit?:
|
|
3083
|
+
limit?: number | null | undefined;
|
|
2905
3084
|
cursor?: Cursor | null | undefined;
|
|
2906
3085
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesListGrantsResponses, MailboxesListGrantsErrors, ThrowOnError>;
|
|
2907
3086
|
/**
|
|
@@ -3040,16 +3219,16 @@ export declare class Mailboxes {
|
|
|
3040
3219
|
*/
|
|
3041
3220
|
static listThreads<ThrowOnError extends boolean = false>(parameters: {
|
|
3042
3221
|
id: MailboxId;
|
|
3043
|
-
limit?:
|
|
3222
|
+
limit?: number | null | undefined;
|
|
3044
3223
|
cursor?: Cursor | null | undefined;
|
|
3045
3224
|
after?: string | null | undefined;
|
|
3046
3225
|
before?: string | null | undefined;
|
|
3047
3226
|
q?: string | null | undefined;
|
|
3048
3227
|
folder?: MailboxThreadFolder | null | undefined;
|
|
3049
3228
|
label?: MailboxLabelId | null | undefined;
|
|
3050
|
-
unread?:
|
|
3051
|
-
starred?:
|
|
3052
|
-
snoozed?:
|
|
3229
|
+
unread?: boolean | null | undefined;
|
|
3230
|
+
starred?: boolean | null | undefined;
|
|
3231
|
+
snoozed?: boolean | null | undefined;
|
|
3053
3232
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesListThreadsResponses, MailboxesListThreadsErrors, ThrowOnError>;
|
|
3054
3233
|
/**
|
|
3055
3234
|
* Get a mailbox thread
|
|
@@ -3102,7 +3281,7 @@ export declare class Mailboxes {
|
|
|
3102
3281
|
static listThreadMessages<ThrowOnError extends boolean = false>(parameters: {
|
|
3103
3282
|
id: MailboxId;
|
|
3104
3283
|
threadId: MailboxThreadId;
|
|
3105
|
-
limit?:
|
|
3284
|
+
limit?: number | null | undefined;
|
|
3106
3285
|
cursor?: Cursor | null | undefined;
|
|
3107
3286
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesListThreadMessagesResponses, MailboxesListThreadMessagesErrors, ThrowOnError>;
|
|
3108
3287
|
/**
|
|
@@ -3113,7 +3292,7 @@ export declare class Mailboxes {
|
|
|
3113
3292
|
static getThreadContent<ThrowOnError extends boolean = false>(parameters: {
|
|
3114
3293
|
id: MailboxId;
|
|
3115
3294
|
threadId: MailboxThreadId;
|
|
3116
|
-
limit?:
|
|
3295
|
+
limit?: number | null | undefined;
|
|
3117
3296
|
cursor?: Cursor | null | undefined;
|
|
3118
3297
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesGetThreadContentResponses, MailboxesGetThreadContentErrors, ThrowOnError>;
|
|
3119
3298
|
/**
|
|
@@ -3124,7 +3303,7 @@ export declare class Mailboxes {
|
|
|
3124
3303
|
static listThreadNotes<ThrowOnError extends boolean = false>(parameters: {
|
|
3125
3304
|
id: MailboxId;
|
|
3126
3305
|
threadId: MailboxThreadId;
|
|
3127
|
-
limit?:
|
|
3306
|
+
limit?: number | null | undefined;
|
|
3128
3307
|
cursor?: Cursor | null | undefined;
|
|
3129
3308
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesListThreadNotesResponses, MailboxesListThreadNotesErrors, ThrowOnError>;
|
|
3130
3309
|
/**
|
|
@@ -3273,7 +3452,7 @@ export declare class Mailboxes {
|
|
|
3273
3452
|
*/
|
|
3274
3453
|
static listQuarantine<ThrowOnError extends boolean = false>(parameters: {
|
|
3275
3454
|
id: MailboxId;
|
|
3276
|
-
limit?:
|
|
3455
|
+
limit?: number | null | undefined;
|
|
3277
3456
|
cursor?: Cursor | null | undefined;
|
|
3278
3457
|
after?: string | null | undefined;
|
|
3279
3458
|
before?: string | null | undefined;
|
|
@@ -3303,7 +3482,7 @@ export declare class Mailboxes {
|
|
|
3303
3482
|
*/
|
|
3304
3483
|
static listDrafts<ThrowOnError extends boolean = false>(parameters: {
|
|
3305
3484
|
id: MailboxId;
|
|
3306
|
-
limit?:
|
|
3485
|
+
limit?: number | null | undefined;
|
|
3307
3486
|
cursor?: Cursor | null | undefined;
|
|
3308
3487
|
threadId?: MailboxThreadId | null | undefined;
|
|
3309
3488
|
}, options?: Options<never, ThrowOnError>): RequestResult<MailboxesListDraftsResponses, MailboxesListDraftsErrors, ThrowOnError>;
|
|
@@ -3378,7 +3557,7 @@ export declare class Mailboxes {
|
|
|
3378
3557
|
*/
|
|
3379
3558
|
static listActions<ThrowOnError extends boolean = false>(parameters: {
|
|
3380
3559
|
id: MailboxId;
|
|
3381
|
-
limit?:
|
|
3560
|
+
limit?: number | null | undefined;
|
|
3382
3561
|
cursor?: Cursor | null | undefined;
|
|
3383
3562
|
threadId?: MailboxThreadId | null | undefined;
|
|
3384
3563
|
state?: "proposed" | "allowed" | "approvalRequired" | "policyDenied" | "approved" | "approvalDenied" | "executing" | "executed" | "failed" | "queued" | "accepted" | "completed" | "notSent" | "uncertain" | null | undefined;
|
|
@@ -3438,7 +3617,7 @@ export declare class Mailboxes {
|
|
|
3438
3617
|
*/
|
|
3439
3618
|
static listEvents<ThrowOnError extends boolean = false>(parameters: {
|
|
3440
3619
|
id: MailboxId;
|
|
3441
|
-
limit?:
|
|
3620
|
+
limit?: number | null | undefined;
|
|
3442
3621
|
cursor?: Cursor | null | undefined;
|
|
3443
3622
|
after?: string | null | undefined;
|
|
3444
3623
|
before?: string | null | undefined;
|
|
@@ -3454,7 +3633,7 @@ export declare class Namespaces {
|
|
|
3454
3633
|
* Returns namespace summaries, newest first, filterable by creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read a namespace's metadata with `GET /v1/namespaces/{id}`.
|
|
3455
3634
|
*/
|
|
3456
3635
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
3457
|
-
limit?:
|
|
3636
|
+
limit?: number | null | undefined;
|
|
3458
3637
|
cursor?: Cursor | null | undefined;
|
|
3459
3638
|
after?: string | null | undefined;
|
|
3460
3639
|
before?: string | null | undefined;
|
|
@@ -3537,7 +3716,7 @@ export declare class Extensions {
|
|
|
3537
3716
|
* Returns the organization's published extensions with their latest version, newest first, filterable by creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.
|
|
3538
3717
|
*/
|
|
3539
3718
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
3540
|
-
limit?:
|
|
3719
|
+
limit?: number | null | undefined;
|
|
3541
3720
|
cursor?: Cursor | null | undefined;
|
|
3542
3721
|
after?: string | null | undefined;
|
|
3543
3722
|
before?: string | null | undefined;
|
|
@@ -3574,7 +3753,7 @@ export declare class Extensions {
|
|
|
3574
3753
|
*/
|
|
3575
3754
|
static listVersions<ThrowOnError extends boolean = false>(parameters: {
|
|
3576
3755
|
id: string;
|
|
3577
|
-
limit?:
|
|
3756
|
+
limit?: number | null | undefined;
|
|
3578
3757
|
cursor?: Cursor | null | undefined;
|
|
3579
3758
|
}, options?: Options<never, ThrowOnError>): RequestResult<ExtensionsListVersionsResponses, ExtensionsListVersionsErrors, ThrowOnError>;
|
|
3580
3759
|
/**
|
|
@@ -3597,7 +3776,7 @@ export declare class ExtensionInstallations {
|
|
|
3597
3776
|
* Returns summaries of the organization's extension installations, newest first, filterable by creation time (`after`, `before`). Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Read an installation's permissions, scope, and webhook with `GET /v1/extension-installations/{id}`.
|
|
3598
3777
|
*/
|
|
3599
3778
|
static list<ThrowOnError extends boolean = false>(parameters?: {
|
|
3600
|
-
limit?:
|
|
3779
|
+
limit?: number | null | undefined;
|
|
3601
3780
|
cursor?: Cursor | null | undefined;
|
|
3602
3781
|
after?: string | null | undefined;
|
|
3603
3782
|
before?: string | null | undefined;
|