@djangocfg/ext-newsletter 1.0.2 → 1.0.3

package/dist/hooks.d.cts

@@ -0,0 +1,268 @@
+import { BulkEmailRequest, API, BulkEmailResponse, NewsletterCampaignRequest as NewsletterCampaignRequest$1, NewsletterCampaign as NewsletterCampaign$1, SendCampaignRequest, SendCampaignResponse as SendCampaignResponse$1, SubscribeRequest as SubscribeRequest$1, SubscribeResponse as SubscribeResponse$1, UnsubscribeRequest as UnsubscribeRequest$1, SuccessResponse as SuccessResponse$1, TestEmailRequest, PatchedNewsletterCampaignRequest as PatchedNewsletterCampaignRequest$1, Unsubscribe, PatchedUnsubscribeRequest, HeroProps } from './index.cjs';
+export { APIClient, APIError, APILogger, APIOptions, BulkEmailRequestSchema, BulkEmailResponseSchema, CookieStorageAdapter, DEFAULT_RETRY_CONFIG, EmailLog, EmailLogSchema, Enums, ErrorLog, ErrorResponse, ErrorResponseSchema, ExtNewsletterBulkEmailTypes, ExtNewsletterCampaignsTypes, ExtNewsletterLogsTypes, ExtNewsletterNewsletterTypes, ExtNewsletterNewslettersTypes, ExtNewsletterSubscriptionsTypes, ExtNewsletterTestingTypes, FailedAttemptInfo, FetchAdapter, Fetchers, HeroAction, HttpClientAdapter, HttpRequest, HttpResponse, LocalStorageAdapter, LoggerConfig, MemoryStorageAdapter, NetworkError, Newsletter, NewsletterCampaignRequestSchema, NewsletterCampaignSchema, NewsletterSchema, NewsletterSubscription, NewsletterSubscriptionSchema, PaginatedEmailLogList, PaginatedEmailLogListSchema, PaginatedNewsletterCampaignList, PaginatedNewsletterCampaignListSchema, PaginatedNewsletterList, PaginatedNewsletterListSchema, PaginatedNewsletterSubscriptionList, PaginatedNewsletterSubscriptionListSchema, PatchedNewsletterCampaignRequestSchema, PatchedUnsubscribeRequestSchema, REFRESH_TOKEN_KEY, RequestLog, ResponseLog, RetryConfig, Schemas, SendCampaignRequestSchema, SendCampaignResponseSchema, StorageAdapter, SubscribeRequestSchema, SubscribeResponseSchema, SuccessResponseSchema, TOKEN_KEY, TestEmailRequestSchema, UnsubscribeRequestSchema, UnsubscribeSchema, ValidationErrorDetail, ValidationErrorEvent, apiNewsletter, clearAPITokens, configureAPI, createNewsletterBulkCreate, createNewsletterCampaignsCreate, createNewsletterCampaignsSendCreate, createNewsletterSubscribeCreate, createNewsletterTestCreate, createNewsletterUnsubscribeCreate, deleteNewsletterCampaignsDestroy, dispatchValidationError, extensionConfig, formatZodError, getAPIInstance, getNewsletterCampaignsList, getNewsletterCampaignsRetrieve, getNewsletterLogsList, getNewsletterNewslettersList, getNewsletterNewslettersRetrieve, getNewsletterSubscriptionsList, isAPIConfigured, onValidationError, partialUpdateNewsletterCampaignsPartialUpdate, partialUpdateNewsletterUnsubscribePartialUpdate, reconfigureAPI, resetAPI, shouldRetry, updateNewsletterCampaignsUpdate, updateNewsletterUnsubscribeUpdate, withRetry } from './index.cjs';
+import useSWR from 'swr';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import 'consola';
+import '@djangocfg/ext-base';
+import 'zod';
+
+/**
+ * Send Bulk Email
+ *
+ * @method POST
+ * @path /cfg/newsletter/bulk/
+ */
+declare function useCreateNewsletterBulkCreate(): (data: BulkEmailRequest, client?: API) => Promise<BulkEmailResponse>;
+
+/**
+ * SWR Hooks for Campaigns
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * List Newsletter Campaigns
+ *
+ * @method GET
+ * @path /cfg/newsletter/campaigns/
+ */
+declare function useNewsletterCampaignsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedNewsletterCampaignList>>;
+/**
+ * Create Newsletter Campaign
+ *
+ * @method POST
+ * @path /cfg/newsletter/campaigns/
+ */
+declare function useCreateNewsletterCampaignsCreate(): (data: NewsletterCampaignRequest$1, client?: API) => Promise<NewsletterCampaign$1>;
+/**
+ * Get Campaign Details
+ *
+ * @method GET
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function useNewsletterCampaignsRetrieve(id: number, client?: API): ReturnType<typeof useSWR<NewsletterCampaign>>;
+/**
+ * Update Campaign
+ *
+ * @method PUT
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function useUpdateNewsletterCampaignsUpdate(): (id: number, data: NewsletterCampaignRequest$1, client?: API) => Promise<NewsletterCampaign$1>;
+/**
+ * Delete Campaign
+ *
+ * @method DELETE
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function useDeleteNewsletterCampaignsDestroy(): (id: number, client?: API) => Promise<void>;
+/**
+ * Send Newsletter Campaign
+ *
+ * @method POST
+ * @path /cfg/newsletter/campaigns/send/
+ */
+declare function useCreateNewsletterCampaignsSendCreate(): (data: SendCampaignRequest, client?: API) => Promise<SendCampaignResponse$1>;
+
+/**
+ * SWR Hooks for Logs
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * List Email Logs
+ *
+ * @method GET
+ * @path /cfg/newsletter/logs/
+ */
+declare function useNewsletterLogsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedEmailLogList>>;
+
+/**
+ * SWR Hooks for Newsletters
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * List Active Newsletters
+ *
+ * @method GET
+ * @path /cfg/newsletter/newsletters/
+ */
+declare function useNewsletterNewslettersList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedNewsletterList>>;
+/**
+ * Get Newsletter Details
+ *
+ * @method GET
+ * @path /cfg/newsletter/newsletters/{id}/
+ */
+declare function useNewsletterNewslettersRetrieve(id: number, client?: API): ReturnType<typeof useSWR<Newsletter>>;
+
+/**
+ * SWR Hooks for Subscriptions
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * Subscribe to Newsletter
+ *
+ * @method POST
+ * @path /cfg/newsletter/subscribe/
+ */
+declare function useCreateNewsletterSubscribeCreate(): (data: SubscribeRequest$1, client?: API) => Promise<SubscribeResponse$1>;
+/**
+ * List User Subscriptions
+ *
+ * @method GET
+ * @path /cfg/newsletter/subscriptions/
+ */
+declare function useNewsletterSubscriptionsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedNewsletterSubscriptionList>>;
+/**
+ * Unsubscribe from Newsletter
+ *
+ * @method POST
+ * @path /cfg/newsletter/unsubscribe/
+ */
+declare function useCreateNewsletterUnsubscribeCreate(): (data: UnsubscribeRequest$1, client?: API) => Promise<SuccessResponse$1>;
+
+/**
+ * Test Email Sending
+ *
+ * @method POST
+ * @path /cfg/newsletter/test/
+ */
+declare function useCreateNewsletterTestCreate(): (data: TestEmailRequest, client?: API) => Promise<BulkEmailResponse>;
+
+/**
+ * API operation
+ *
+ * @method PATCH
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function usePartialUpdateNewsletterCampaignsPartialUpdate(): (id: number, data?: PatchedNewsletterCampaignRequest$1, client?: API) => Promise<NewsletterCampaign$1>;
+/**
+ * API operation
+ *
+ * @method PUT
+ * @path /cfg/newsletter/unsubscribe/
+ */
+declare function useUpdateNewsletterUnsubscribeUpdate(): (data: UnsubscribeRequest$1, client?: API) => Promise<Unsubscribe>;
+/**
+ * API operation
+ *
+ * @method PATCH
+ * @path /cfg/newsletter/unsubscribe/
+ */
+declare function usePartialUpdateNewsletterUnsubscribePartialUpdate(): (data?: PatchedUnsubscribeRequest, client?: API) => Promise<Unsubscribe>;
+
+/**
+ * Newsletter Types
+ * Centralized type definitions for newsletter context
+ */
+
+type NewsletterCampaign = NonNullable<Awaited<ReturnType<typeof useNewsletterCampaignsRetrieve>>['data']>;
+type NewsletterCampaignRequest = Parameters<ReturnType<typeof useUpdateNewsletterCampaignsUpdate>>[1];
+type PatchedNewsletterCampaignRequest = Parameters<ReturnType<typeof usePartialUpdateNewsletterCampaignsPartialUpdate>>[1];
+type NewsletterSubscription = NonNullable<Awaited<ReturnType<typeof useNewsletterSubscriptionsList>>['data']> extends {
+    results: infer T;
+} ? T extends Array<infer U> ? U : never : never;
+type SubscribeRequest = Parameters<ReturnType<typeof useCreateNewsletterSubscribeCreate>>[0];
+type SubscribeResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterSubscribeCreate>>>;
+type UnsubscribeRequest = Parameters<ReturnType<typeof useCreateNewsletterUnsubscribeCreate>>[0];
+type SuccessResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterUnsubscribeCreate>>>;
+type SendCampaignResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterCampaignsSendCreate>>>;
+
+interface NewsletterContextValue {
+    campaigns: NewsletterCampaign[];
+    isLoadingCampaigns: boolean;
+    campaignsError: Error | null;
+    pagination?: {
+        count: number;
+        next: number | null;
+        previous: number | null;
+    };
+    getCampaign: (id: number) => {
+        data?: NewsletterCampaign;
+        error?: Error;
+        isLoading: boolean;
+    };
+    createCampaign: (data: NewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+    updateCampaign: (id: number, data: NewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+    partialUpdateCampaign: (id: number, data: PatchedNewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+    deleteCampaign: (id: number) => Promise<void>;
+    sendCampaign: (campaignId: number) => Promise<SendCampaignResponse>;
+    subscriptions: NewsletterSubscription[];
+    isLoadingSubscriptions: boolean;
+    subscriptionsError: Error | null;
+    subscribe: (data: SubscribeRequest) => Promise<SubscribeResponse>;
+    unsubscribe: (data: UnsubscribeRequest) => Promise<SuccessResponse>;
+}
+interface NewsletterProviderProps {
+    children: ReactNode;
+    page?: number;
+    pageSize?: number;
+}
+declare function NewsletterProvider({ children, page, pageSize }: NewsletterProviderProps): react_jsx_runtime.JSX.Element;
+declare function useNewsletterContext(): NewsletterContextValue;
+
+declare function Hero({ title, description, primaryAction, secondaryAction, showNewsletter, newsletterPlaceholder, newsletterButtonText, onNewsletterSubmit, className, }: HeroProps): react_jsx_runtime.JSX.Element;
+
+export { API, BulkEmailRequest, BulkEmailResponse, Hero, HeroProps, NewsletterCampaign$1 as NewsletterCampaign, NewsletterCampaignRequest$1 as NewsletterCampaignRequest, Hero as NewsletterHero, NewsletterProvider, PatchedNewsletterCampaignRequest$1 as PatchedNewsletterCampaignRequest, PatchedUnsubscribeRequest, SendCampaignRequest, SendCampaignResponse$1 as SendCampaignResponse, SubscribeRequest$1 as SubscribeRequest, SubscribeResponse$1 as SubscribeResponse, SuccessResponse$1 as SuccessResponse, TestEmailRequest, Unsubscribe, UnsubscribeRequest$1 as UnsubscribeRequest, useCreateNewsletterBulkCreate, useCreateNewsletterCampaignsCreate, useCreateNewsletterCampaignsSendCreate, useCreateNewsletterSubscribeCreate, useCreateNewsletterTestCreate, useCreateNewsletterUnsubscribeCreate, useDeleteNewsletterCampaignsDestroy, useNewsletterCampaignsList, useNewsletterCampaignsRetrieve, useNewsletterContext, useNewsletterLogsList, useNewsletterNewslettersList, useNewsletterNewslettersRetrieve, useNewsletterSubscriptionsList, usePartialUpdateNewsletterCampaignsPartialUpdate, usePartialUpdateNewsletterUnsubscribePartialUpdate, useUpdateNewsletterCampaignsUpdate, useUpdateNewsletterUnsubscribeUpdate };

package/dist/hooks.d.ts

@@ -0,0 +1,268 @@
+import { BulkEmailRequest, API, BulkEmailResponse, NewsletterCampaignRequest as NewsletterCampaignRequest$1, NewsletterCampaign as NewsletterCampaign$1, SendCampaignRequest, SendCampaignResponse as SendCampaignResponse$1, SubscribeRequest as SubscribeRequest$1, SubscribeResponse as SubscribeResponse$1, UnsubscribeRequest as UnsubscribeRequest$1, SuccessResponse as SuccessResponse$1, TestEmailRequest, PatchedNewsletterCampaignRequest as PatchedNewsletterCampaignRequest$1, Unsubscribe, PatchedUnsubscribeRequest, HeroProps } from './index.js';
+export { APIClient, APIError, APILogger, APIOptions, BulkEmailRequestSchema, BulkEmailResponseSchema, CookieStorageAdapter, DEFAULT_RETRY_CONFIG, EmailLog, EmailLogSchema, Enums, ErrorLog, ErrorResponse, ErrorResponseSchema, ExtNewsletterBulkEmailTypes, ExtNewsletterCampaignsTypes, ExtNewsletterLogsTypes, ExtNewsletterNewsletterTypes, ExtNewsletterNewslettersTypes, ExtNewsletterSubscriptionsTypes, ExtNewsletterTestingTypes, FailedAttemptInfo, FetchAdapter, Fetchers, HeroAction, HttpClientAdapter, HttpRequest, HttpResponse, LocalStorageAdapter, LoggerConfig, MemoryStorageAdapter, NetworkError, Newsletter, NewsletterCampaignRequestSchema, NewsletterCampaignSchema, NewsletterSchema, NewsletterSubscription, NewsletterSubscriptionSchema, PaginatedEmailLogList, PaginatedEmailLogListSchema, PaginatedNewsletterCampaignList, PaginatedNewsletterCampaignListSchema, PaginatedNewsletterList, PaginatedNewsletterListSchema, PaginatedNewsletterSubscriptionList, PaginatedNewsletterSubscriptionListSchema, PatchedNewsletterCampaignRequestSchema, PatchedUnsubscribeRequestSchema, REFRESH_TOKEN_KEY, RequestLog, ResponseLog, RetryConfig, Schemas, SendCampaignRequestSchema, SendCampaignResponseSchema, StorageAdapter, SubscribeRequestSchema, SubscribeResponseSchema, SuccessResponseSchema, TOKEN_KEY, TestEmailRequestSchema, UnsubscribeRequestSchema, UnsubscribeSchema, ValidationErrorDetail, ValidationErrorEvent, apiNewsletter, clearAPITokens, configureAPI, createNewsletterBulkCreate, createNewsletterCampaignsCreate, createNewsletterCampaignsSendCreate, createNewsletterSubscribeCreate, createNewsletterTestCreate, createNewsletterUnsubscribeCreate, deleteNewsletterCampaignsDestroy, dispatchValidationError, extensionConfig, formatZodError, getAPIInstance, getNewsletterCampaignsList, getNewsletterCampaignsRetrieve, getNewsletterLogsList, getNewsletterNewslettersList, getNewsletterNewslettersRetrieve, getNewsletterSubscriptionsList, isAPIConfigured, onValidationError, partialUpdateNewsletterCampaignsPartialUpdate, partialUpdateNewsletterUnsubscribePartialUpdate, reconfigureAPI, resetAPI, shouldRetry, updateNewsletterCampaignsUpdate, updateNewsletterUnsubscribeUpdate, withRetry } from './index.js';
+import useSWR from 'swr';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import 'consola';
+import '@djangocfg/ext-base';
+import 'zod';
+
+/**
+ * Send Bulk Email
+ *
+ * @method POST
+ * @path /cfg/newsletter/bulk/
+ */
+declare function useCreateNewsletterBulkCreate(): (data: BulkEmailRequest, client?: API) => Promise<BulkEmailResponse>;
+
+/**
+ * SWR Hooks for Campaigns
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * List Newsletter Campaigns
+ *
+ * @method GET
+ * @path /cfg/newsletter/campaigns/
+ */
+declare function useNewsletterCampaignsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedNewsletterCampaignList>>;
+/**
+ * Create Newsletter Campaign
+ *
+ * @method POST
+ * @path /cfg/newsletter/campaigns/
+ */
+declare function useCreateNewsletterCampaignsCreate(): (data: NewsletterCampaignRequest$1, client?: API) => Promise<NewsletterCampaign$1>;
+/**
+ * Get Campaign Details
+ *
+ * @method GET
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function useNewsletterCampaignsRetrieve(id: number, client?: API): ReturnType<typeof useSWR<NewsletterCampaign>>;
+/**
+ * Update Campaign
+ *
+ * @method PUT
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function useUpdateNewsletterCampaignsUpdate(): (id: number, data: NewsletterCampaignRequest$1, client?: API) => Promise<NewsletterCampaign$1>;
+/**
+ * Delete Campaign
+ *
+ * @method DELETE
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function useDeleteNewsletterCampaignsDestroy(): (id: number, client?: API) => Promise<void>;
+/**
+ * Send Newsletter Campaign
+ *
+ * @method POST
+ * @path /cfg/newsletter/campaigns/send/
+ */
+declare function useCreateNewsletterCampaignsSendCreate(): (data: SendCampaignRequest, client?: API) => Promise<SendCampaignResponse$1>;
+
+/**
+ * SWR Hooks for Logs
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * List Email Logs
+ *
+ * @method GET
+ * @path /cfg/newsletter/logs/
+ */
+declare function useNewsletterLogsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedEmailLogList>>;
+
+/**
+ * SWR Hooks for Newsletters
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * List Active Newsletters
+ *
+ * @method GET
+ * @path /cfg/newsletter/newsletters/
+ */
+declare function useNewsletterNewslettersList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedNewsletterList>>;
+/**
+ * Get Newsletter Details
+ *
+ * @method GET
+ * @path /cfg/newsletter/newsletters/{id}/
+ */
+declare function useNewsletterNewslettersRetrieve(id: number, client?: API): ReturnType<typeof useSWR<Newsletter>>;
+
+/**
+ * SWR Hooks for Subscriptions
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * Subscribe to Newsletter
+ *
+ * @method POST
+ * @path /cfg/newsletter/subscribe/
+ */
+declare function useCreateNewsletterSubscribeCreate(): (data: SubscribeRequest$1, client?: API) => Promise<SubscribeResponse$1>;
+/**
+ * List User Subscriptions
+ *
+ * @method GET
+ * @path /cfg/newsletter/subscriptions/
+ */
+declare function useNewsletterSubscriptionsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedNewsletterSubscriptionList>>;
+/**
+ * Unsubscribe from Newsletter
+ *
+ * @method POST
+ * @path /cfg/newsletter/unsubscribe/
+ */
+declare function useCreateNewsletterUnsubscribeCreate(): (data: UnsubscribeRequest$1, client?: API) => Promise<SuccessResponse$1>;
+
+/**
+ * Test Email Sending
+ *
+ * @method POST
+ * @path /cfg/newsletter/test/
+ */
+declare function useCreateNewsletterTestCreate(): (data: TestEmailRequest, client?: API) => Promise<BulkEmailResponse>;
+
+/**
+ * API operation
+ *
+ * @method PATCH
+ * @path /cfg/newsletter/campaigns/{id}/
+ */
+declare function usePartialUpdateNewsletterCampaignsPartialUpdate(): (id: number, data?: PatchedNewsletterCampaignRequest$1, client?: API) => Promise<NewsletterCampaign$1>;
+/**
+ * API operation
+ *
+ * @method PUT
+ * @path /cfg/newsletter/unsubscribe/
+ */
+declare function useUpdateNewsletterUnsubscribeUpdate(): (data: UnsubscribeRequest$1, client?: API) => Promise<Unsubscribe>;
+/**
+ * API operation
+ *
+ * @method PATCH
+ * @path /cfg/newsletter/unsubscribe/
+ */
+declare function usePartialUpdateNewsletterUnsubscribePartialUpdate(): (data?: PatchedUnsubscribeRequest, client?: API) => Promise<Unsubscribe>;
+
+/**
+ * Newsletter Types
+ * Centralized type definitions for newsletter context
+ */
+
+type NewsletterCampaign = NonNullable<Awaited<ReturnType<typeof useNewsletterCampaignsRetrieve>>['data']>;
+type NewsletterCampaignRequest = Parameters<ReturnType<typeof useUpdateNewsletterCampaignsUpdate>>[1];
+type PatchedNewsletterCampaignRequest = Parameters<ReturnType<typeof usePartialUpdateNewsletterCampaignsPartialUpdate>>[1];
+type NewsletterSubscription = NonNullable<Awaited<ReturnType<typeof useNewsletterSubscriptionsList>>['data']> extends {
+    results: infer T;
+} ? T extends Array<infer U> ? U : never : never;
+type SubscribeRequest = Parameters<ReturnType<typeof useCreateNewsletterSubscribeCreate>>[0];
+type SubscribeResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterSubscribeCreate>>>;
+type UnsubscribeRequest = Parameters<ReturnType<typeof useCreateNewsletterUnsubscribeCreate>>[0];
+type SuccessResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterUnsubscribeCreate>>>;
+type SendCampaignResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterCampaignsSendCreate>>>;
+
+interface NewsletterContextValue {
+    campaigns: NewsletterCampaign[];
+    isLoadingCampaigns: boolean;
+    campaignsError: Error | null;
+    pagination?: {
+        count: number;
+        next: number | null;
+        previous: number | null;
+    };
+    getCampaign: (id: number) => {
+        data?: NewsletterCampaign;
+        error?: Error;
+        isLoading: boolean;
+    };
+    createCampaign: (data: NewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+    updateCampaign: (id: number, data: NewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+    partialUpdateCampaign: (id: number, data: PatchedNewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+    deleteCampaign: (id: number) => Promise<void>;
+    sendCampaign: (campaignId: number) => Promise<SendCampaignResponse>;
+    subscriptions: NewsletterSubscription[];
+    isLoadingSubscriptions: boolean;
+    subscriptionsError: Error | null;
+    subscribe: (data: SubscribeRequest) => Promise<SubscribeResponse>;
+    unsubscribe: (data: UnsubscribeRequest) => Promise<SuccessResponse>;
+}
+interface NewsletterProviderProps {
+    children: ReactNode;
+    page?: number;
+    pageSize?: number;
+}
+declare function NewsletterProvider({ children, page, pageSize }: NewsletterProviderProps): react_jsx_runtime.JSX.Element;
+declare function useNewsletterContext(): NewsletterContextValue;
+
+declare function Hero({ title, description, primaryAction, secondaryAction, showNewsletter, newsletterPlaceholder, newsletterButtonText, onNewsletterSubmit, className, }: HeroProps): react_jsx_runtime.JSX.Element;
+
+export { API, BulkEmailRequest, BulkEmailResponse, Hero, HeroProps, NewsletterCampaign$1 as NewsletterCampaign, NewsletterCampaignRequest$1 as NewsletterCampaignRequest, Hero as NewsletterHero, NewsletterProvider, PatchedNewsletterCampaignRequest$1 as PatchedNewsletterCampaignRequest, PatchedUnsubscribeRequest, SendCampaignRequest, SendCampaignResponse$1 as SendCampaignResponse, SubscribeRequest$1 as SubscribeRequest, SubscribeResponse$1 as SubscribeResponse, SuccessResponse$1 as SuccessResponse, TestEmailRequest, Unsubscribe, UnsubscribeRequest$1 as UnsubscribeRequest, useCreateNewsletterBulkCreate, useCreateNewsletterCampaignsCreate, useCreateNewsletterCampaignsSendCreate, useCreateNewsletterSubscribeCreate, useCreateNewsletterTestCreate, useCreateNewsletterUnsubscribeCreate, useDeleteNewsletterCampaignsDestroy, useNewsletterCampaignsList, useNewsletterCampaignsRetrieve, useNewsletterContext, useNewsletterLogsList, useNewsletterNewslettersList, useNewsletterNewslettersRetrieve, useNewsletterSubscriptionsList, usePartialUpdateNewsletterCampaignsPartialUpdate, usePartialUpdateNewsletterUnsubscribePartialUpdate, useUpdateNewsletterCampaignsUpdate, useUpdateNewsletterUnsubscribeUpdate };