@solytude/listmonk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Listmonk TypeScript SDK
+ *
+ * Production-grade TypeScript SDK for the listmonk email marketing platform API.
+ *
+ * @example
+ * ```typescript
+ * import { Listmonk } from '@solytude/listmonk';
+ *
+ * const client = new Listmonk({
+ *   url: 'https://listmonk.example.com',
+ *   auth: { username: 'admin', password: 'secret' },
+ * });
+ * ```
+ *
+ * @packageDocumentation
+ */
+export { Listmonk } from "./client";
+export type { ClientOptions, ClientOptionsInput, AuthCredentials, } from "./types/config";
+export type { RequestHook, ResponseHook, RequestInfo, ResponseInfo, HttpMethod, } from "./http/hooks";
+export { ListmonkError, ListmonkApiError, ListmonkBadRequestError, ListmonkAuthenticationError, ListmonkPermissionDeniedError, ListmonkNotFoundError, ListmonkRateLimitError, ListmonkInternalServerError, ListmonkValidationError, ListmonkNetworkError, ListmonkTimeoutError, ListmonkConfigurationError, } from "./errors";
+export { HttpClient, type RequestOptions } from "./http/client";
+export { APIResource, type ResourceRequestOptions } from "./http/resource";
+export { SubscribersResource } from "./resources/subscribers";
+export { ListsResource } from "./resources/lists";
+export { CampaignsResource } from "./resources/campaigns";
+export { TemplatesResource } from "./resources/templates";
+export { TransactionalResource } from "./resources/tx";
+export { MediaResource } from "./resources/media";
+export { ImportResource } from "./resources/import";
+export { BouncesResource } from "./resources/bounces";
+export { SettingsResource } from "./resources/settings";
+export { DashboardResource } from "./resources/dashboard";
+export { AdminResource } from "./resources/admin";
+export { MaintenanceResource } from "./resources/maintenance";
+export { PublicResource } from "./resources/public";
+export { streamSSE, type SSEOptions } from "./http/sse";
+export type { Subscriber, SubscriberStatus, SubscriptionStatus, ListSubscription, BounceRecord, BounceType, BounceCampaign, SubscriberAttribs, CreateSubscriberRequest, UpdateSubscriberRequest, ListSubscribersOptions, ListSubscribersResponse, ModifyListsRequest, ModifyListsForListRequest, ModifyListsByQueryRequest, QueryOperationRequest, BulkOperationResponse, SubscriberExportResponse, SubscriberProfile, ExportSubscription, CampaignView, LinkClick, ListAction, } from "./resources/subscribers";
+export type { PagedAsyncIterableIterator } from "./types/pagination";
+export { SubscriberSchema, SubscriberStatusSchema, SubscriptionStatusSchema, ListSubscriptionSchema, BounceRecordSchema, BounceTypeSchema, BounceCampaignSchema, SubscriberAttribsSchema, CreateSubscriberRequestSchema, UpdateSubscriberRequestSchema, ListSubscribersOptionsSchema, ListSubscribersResponseSchema, ModifyListsRequestSchema, ModifyListsForListRequestSchema, ModifyListsByQueryRequestSchema, QueryOperationRequestSchema, BulkOperationResponseSchema, SubscriberExportResponseSchema, ListActionSchema, } from "./resources/subscribers";
+export type { List, PublicList, ListType, ListOptin, ListStatus, CreateListRequest, UpdateListRequest, ListListsOptions, ListListsResponse, BulkDeleteByQueryRequest as ListsBulkDeleteByQueryRequest, } from "./resources/lists";
+export { ListSchema, PublicListSchema, ListTypeSchema, ListOptinSchema, ListStatusSchema, CreateListRequestSchema, UpdateListRequestSchema, ListListsOptionsSchema, ListListsResponseSchema, BulkDeleteByQueryRequestSchema as ListsBulkDeleteByQueryRequestSchema, } from "./resources/lists";
+export type { Campaign, CampaignStatus, CampaignType, CampaignContentType, AnalyticsType, Header, CampaignList, CampaignStats, AnalyticsData, LinkAnalytics, CreateCampaignRequest, UpdateCampaignRequest, ListCampaignsOptions, ListCampaignsResponse, UpdateStatusRequest, SendTestRequest, ArchiveRequest, GetAnalyticsOptions, PreviewResponse, PreviewOptions, BulkDeleteByQueryRequest, } from "./resources/campaigns";
+export { CampaignStatusSchema, CampaignTypeSchema, CampaignContentTypeSchema, AnalyticsTypeSchema, HeaderSchema, CampaignListSchema, CampaignSchema, CampaignStatsSchema, AnalyticsDataSchema, LinkAnalyticsSchema, CreateCampaignRequestSchema, UpdateCampaignRequestSchema, ListCampaignsOptionsSchema, ListCampaignsResponseSchema, UpdateStatusRequestSchema, SendTestRequestSchema, ArchiveRequestSchema, GetAnalyticsOptionsSchema, PreviewResponseSchema, PreviewOptionsSchema, BulkDeleteByQueryRequestSchema as CampaignsBulkDeleteByQueryRequestSchema, } from "./resources/campaigns";
+export type { Template, TemplateType, TemplatePreview, CreateTemplateRequest, UpdateTemplateRequest, ListTemplatesOptions, LivePreviewRequest, ListTemplatesResponse, } from "./resources/templates";
+export { TemplateTypeSchema, TemplateSchema, TemplatePreviewSchema, CreateTemplateRequestSchema, UpdateTemplateRequestSchema, ListTemplatesOptionsSchema, LivePreviewRequestSchema, ListTemplatesResponseSchema, } from "./resources/templates";
+export type { SubscriberMode, TransactionalContentType, TransactionalAttachment, TransactionalRequest, SendTransactionalRequestInput, } from "./resources/tx";
+export { SubscriberModeSchema, TransactionalContentTypeSchema, SendTransactionalRequestSchema, TransactionalResponseSchema, } from "./resources/tx";
+export type { Media, MediaUploadInput, MediaUploadObject, } from "./resources/media";
+export { MediaSchema, MediaUploadObjectSchema, ListMediaResponseSchema, DeleteResponseSchema as MediaDeleteResponseSchema, } from "./resources/media";
+export type { Bounce, BounceType as BouncesModuleBounceType, BounceCampaign as BouncesModuleBounceCampaign, ListBouncesOptions, ListBouncesResponse, } from "./resources/bounces";
+export { BounceSchema as BouncesModuleBounceSchema, BounceTypeSchema as BouncesModuleBounceTypeSchema, BounceCampaignSchema as BouncesModuleBounceCampaignSchema, ListBouncesOptionsSchema, ListBouncesResponseSchema, BulkDeleteIdsSchema as BouncesBulkDeleteIdsSchema, PositiveIdSchema as BouncesPositiveIdSchema, DeleteResponseSchema as BouncesDeleteResponseSchema, } from "./resources/bounces";
+export type { ImportMode, ImportOptions, ImportParams, ImportStatus, ImportConfig, ImportFileInput, ImportFileObject, } from "./resources/import";
+export { ImportModeSchema, ImportOptionsSchema, ImportParamsSchema, ImportStatusSchema, ImportConfigSchema, ImportFileObjectSchema, ImportLogsResponseSchema, DeleteImportResponseSchema, parseImportLogs, } from "./resources/import";
+export type { SmtpAuthProtocol, TlsType, UploadProvider, CaptchaProvider, ServerHealth, ServerConfig, Settings, SettingsUpdateResponse, SmtpConfig, MessengerConfig, SecurityCaptcha, SecurityOidc, BouncePostmark, BounceForwardEmail, BounceBox, SmtpTestConfig, SmtpTestResult, } from "./resources/settings";
+export { SmtpAuthProtocolSchema, TlsTypeSchema, UploadProviderSchema, CaptchaProviderSchema, ServerHealthSchema, ServerConfigSchema, SecurityCaptchaSchema, SecurityOidcSchema, SmtpConfigSchema, MessengerConfigSchema, BouncePostmarkSchema, BounceForwardEmailSchema, BounceBoxSchema, SettingsSchema, SettingsUpdateResponseSchema, SmtpTestConfigSchema, SmtpTestResultSchema, } from "./resources/settings";
+export type { DashboardCounts, DashboardCharts, ChartDataPoint, } from "./resources/dashboard";
+export { DashboardCountsSchema, DashboardChartsSchema, ChartDataPointSchema, } from "./resources/dashboard";
+export type { ReloadResponse, LogsResponse, SSEEvent, SSEStreamOptions, } from "./resources/admin";
+export { ReloadResponseSchema, LogsResponseSchema, SSEEventSchema, } from "./resources/admin";
+export type { SubscriberGcType, AnalyticsGcType, GcCountResult, GcAnalyticsResult, } from "./resources/maintenance";
+export { SubscriberGcTypeSchema, AnalyticsGcTypeSchema, GcCountResultSchema, GcAnalyticsResultSchema, Rfc3339DateSchema, } from "./resources/maintenance";
+export type { CaptchaAlgorithm, PublicList as PublicModulePublicList, PublicSubscribeRequest, PublicSubscribeResponse, AltchaCaptchaChallenge, } from "./resources/public";
+export { CaptchaAlgorithmSchema, PublicListSchema as PublicModulePublicListSchema, PublicListsResponseSchema, PublicSubscribeRequestSchema, PublicSubscribeResponseSchema, AltchaCaptchaChallengeSchema, } from "./resources/public";