@plyaz/types 1.12.3 → 1.13.0

package/dist/api/client/types.d.ts

@@ -3,7 +3,7 @@
  * Defines the client interface and options
  */
 import type { ApiHandlerMethods, FetchResponse, RequestConfig, ResponseError } from 'fetchff';
-import type { ApiConfig } from '../config';
+import type { ApiConfig, ConfigState } from '../config';
 import type { ConfigUpdateStrategy, EventScopeWithTemporary, HandlerStrategy } from '../events';
 import type { EndpointTypes } from '../endpoints';
 import type { UnknownRecord } from 'type-fest';
@@ -37,6 +37,65 @@ export type ApiClientOptions = ApiConfig;
  * Note: Full type definition requires EndpointTypes and endpoints from api package
  */
 export type ApiClientInstance<EndpointsList = UnknownRecord> = ApiHandlerMethods<EndpointTypes, EndpointsList>;
+/**
+ * Minimal event manager interface for EnhanceClientParams
+ * This avoids circular dependency while maintaining type safety
+ */
+export interface EventManagerLike<TEventManager = unknown> {
+    readonly emitter: TEventManager extends {
+        getEmitter(): infer E;
+    } ? E : unknown;
+    addHandler(event: string, handler: Function | Function[], options?: unknown): () => void;
+    updateConfig(updates: Partial<ApiConfig>, options?: unknown): void;
+    clearTemporaryOverrides(): void;
+    checkConflicts(): ConfigConflict[];
+    getDebugInfo(): DebugInfo;
+    startMonitoring(): void;
+    stopMonitoring(): void;
+    isMonitoring(): boolean;
+    getEventStats(): {
+        totalEvents: number;
+        totalListeners: number;
+        listenerCount: number;
+        recentEvents: Array<{
+            type: string;
+            timestamp: number;
+            data?: unknown;
+        }>;
+        overrideCount: number;
+        eventCountsByType: Record<string, number>;
+    };
+    getActiveScopes(): EventScopeWithTemporary[];
+    emitError(error: ApiPackageErrorLike): void;
+    emitRequestStart(config: RequestConfig): void;
+    emitResponseReceived<TData = unknown>(response: FetchResponse<TData>): void;
+    emitRetryAttempt<TResponse = unknown>(error: ResponseError<TResponse>, attemptNumber: number, config?: RequestConfig): void;
+    dispose(): void;
+}
+/**
+ * Parameters for enhancing client with runtime configuration methods
+ * Used internally by createApiClient to add config management methods
+ *
+ * @internal
+ */
+export interface EnhanceClientParams<TEventManager = unknown, TEndpointsList = UnknownRecord, TClient = ApiHandlerMethods<EndpointTypes, TEndpointsList>> {
+    /** Client instance with events already attached */
+    clientWithEvents: ApiClientWithEvents<TEventManager, TEndpointsList>;
+    /** Mutable container holding current config state */
+    stateContainer: {
+        current: ConfigState;
+    };
+    /** Event manager instance for lifecycle events */
+    eventManager: EventManagerLike<TEventManager>;
+    /** Base fetchff client instance */
+    client: TClient;
+    /** Unique client identifier */
+    clientId: string;
+    /** Global configuration */
+    globalConfig: ApiConfig;
+    /** Client creation options */
+    options: ApiClientOptions;
+}
 /**
  * Event handler registration options
  */

package/dist/api/endpoints/campaigns/types.d.ts

@@ -62,6 +62,20 @@ export interface ParticipantFilters {
     limit?: number;
     offset?: number;
 }
+/**
+ * Parameters for useCampaignParticipants hook
+ */
+export interface UseCampaignParticipantsParams {
+    campaignId: string;
+    filters?: ParticipantFilters;
+}
+/**
+ * Parameters for useUpdateCampaign hook
+ */
+export interface UpdateCampaignParams {
+    campaignId: string;
+    data: UpdateCampaignDto;
+}
 /**
  * Campaign endpoint types for TypeScript
  * Using fetchff's Req type to properly define endpoints

package/dist/api/endpoints/index.d.ts

@@ -1,3 +1,4 @@
 export type * from './campaigns';
 export type * from './health';
+export type * from './infobip';
 export type * from './types';

package/dist/api/endpoints/infobip/endpoints.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Infobip Email Endpoint Type Definitions
+ *
+ * This file contains endpoint type definitions for essential email operations:
+ * - Send email (with attachment support)
+ * - Email validation
+ * - Email bulk operations
+ * - Email webhooks
+ *
+ * All types are derived from generated OpenAPI specifications.
+ *
+ * @see ./types.ts
+ */
+import type { Endpoint, Req } from 'fetchff';
+import type { InfobipSendEmailRequest, InfobipSendEmailResponse, InfobipSendAdvancedEmailRequest, InfobipSendAdvancedEmailResponse, InfobipSendEmailMimeRequest, InfobipSendEmailMimeResponse, InfobipValidateEmailRequest, InfobipValidateEmailResponse, InfobipBulkValidateEmailsRequest, InfobipBulkValidateEmailsResponse, InfobipGetValidationsParams, InfobipGetValidationsResponse, InfobipGetEmailReportsParams, InfobipGetEmailReportsResponse, InfobipGetEmailLogsParams, InfobipGetEmailLogsResponse, InfobipGetScheduledEmailsParams, InfobipGetScheduledEmailsResponse, InfobipGetScheduledEmailStatusesParams, InfobipGetScheduledEmailStatusesResponse, InfobipRescheduleEmailsParams, InfobipRescheduleEmailsRequest, InfobipRescheduleEmailsResponse, InfobipUpdateScheduledEmailStatusesParams, InfobipUpdateScheduledEmailStatusesRequest, InfobipUpdateScheduledEmailStatusesResponse, InfobipEmailDeliveryReportWebhook, InfobipEmailTrackingReportWebhook, InfobipInboundEmailWebhook } from './types';
+/**
+ * Infobip Email API endpoint types
+ * Complete type definitions for essential email endpoints
+ */
+export interface InfobipEmailEndpointTypes {
+    /**
+     * POST /email/3/send - Send email message
+     * Supports both simple text and HTML emails with attachments
+     */
+    sendEmail: Endpoint<Req<InfobipSendEmailResponse, InfobipSendEmailRequest>>;
+    /**
+     * POST /email/4/send - Send advanced email message
+     * Full email customization with advanced features
+     */
+    sendAdvancedEmail: Endpoint<Req<InfobipSendAdvancedEmailResponse, InfobipSendAdvancedEmailRequest>>;
+    /**
+     * POST /email/3/mime - Send email via MIME format
+     * Send pre-formatted MIME messages
+     */
+    sendEmailMime: Endpoint<Req<InfobipSendEmailMimeResponse, InfobipSendEmailMimeRequest>>;
+    /**
+     * POST /email/2/validation - Validate single email address
+     * Check if an email address is valid and deliverable
+     */
+    validateEmail: Endpoint<Req<InfobipValidateEmailResponse, InfobipValidateEmailRequest>>;
+    /**
+     * POST /email/2/validations - Bulk validate email addresses
+     * Submit multiple email addresses for validation (async operation)
+     * Returns 202 with validation request ID
+     */
+    bulkValidateEmails: Endpoint<Req<InfobipBulkValidateEmailsResponse, InfobipBulkValidateEmailsRequest>>;
+    /**
+     * GET /email/2/validations - Get validation results
+     * Retrieve results of bulk email validation requests
+     */
+    getValidations: Endpoint<Req<InfobipGetValidationsResponse, never, InfobipGetValidationsParams>>;
+    /**
+     * GET /email/1/reports - Get email delivery reports
+     * Retrieve delivery status for sent emails
+     */
+    getEmailReports: Endpoint<Req<InfobipGetEmailReportsResponse, never, InfobipGetEmailReportsParams>>;
+    /**
+     * GET /email/1/logs - Get email logs
+     * Retrieve detailed logs for email messages
+     */
+    getEmailLogs: Endpoint<Req<InfobipGetEmailLogsResponse, never, InfobipGetEmailLogsParams>>;
+    /**
+     * GET /email/1/bulks - Get scheduled email bulks
+     * Retrieve information about scheduled email batches
+     */
+    getScheduledEmails: Endpoint<Req<InfobipGetScheduledEmailsResponse, never, InfobipGetScheduledEmailsParams>>;
+    /**
+     * GET /email/1/bulks/status - Get scheduled email statuses
+     * Get status of scheduled email batches
+     */
+    getScheduledEmailStatuses: Endpoint<Req<InfobipGetScheduledEmailStatusesResponse, never, InfobipGetScheduledEmailStatusesParams>>;
+    /**
+     * PUT /email/1/bulks - Reschedule email messages
+     * Change the send time for scheduled emails
+     */
+    rescheduleEmails: Endpoint<Req<InfobipRescheduleEmailsResponse, InfobipRescheduleEmailsRequest, InfobipRescheduleEmailsParams>>;
+    /**
+     * PUT /email/1/bulks/status - Update scheduled email statuses
+     * Pause, resume, or cancel scheduled emails
+     */
+    updateScheduledEmailStatuses: Endpoint<Req<InfobipUpdateScheduledEmailStatusesResponse, InfobipUpdateScheduledEmailStatusesRequest, InfobipUpdateScheduledEmailStatusesParams>>;
+}
+/**
+ * Infobip Email Webhook payload types
+ * Types for incoming webhook payloads from Infobip
+ */
+export interface InfobipEmailWebhookTypes {
+    /**
+     * Webhook: POST receive-email-delivery-reports
+     * Delivery status update webhook payload
+     */
+    deliveryReport: InfobipEmailDeliveryReportWebhook;
+    /**
+     * Webhook: POST receive-email-tracking-reports
+     * Tracking events webhook payload (opens, clicks, bounces, etc.)
+     */
+    trackingReport: InfobipEmailTrackingReportWebhook;
+    /**
+     * Webhook: POST receive-inbound-email
+     * Inbound email received webhook payload
+     */
+    inboundEmail: InfobipInboundEmailWebhook;
+}
+/**
+ * All Infobip endpoint types
+ * Email operations and webhooks
+ */
+export interface InfobipEndpointTypes extends InfobipEmailEndpointTypes {
+}
+/**
+ * All Infobip webhook types
+ * Email webhooks
+ */
+export interface InfobipWebhookTypes extends InfobipEmailWebhookTypes {
+}