@capibox/bridge-nextjs-client 0.0.12 → 0.0.14

package/dist/index.d.mts

@@ -11,75 +11,659 @@ type ParamsLandingPageResponse = {
     };
 };
 
-declare const browser: {
-    mail: {
-        sendToRecipient: (data: {
-            subject: string;
+interface components {
+    schemas: {
+        SendMailToRecipientDto: {
+            /**
+             * @description Email recipient address
+             * @example recipient@example.com
+             */
             to: string;
-            htmlPart?: string | undefined;
-            textPart?: string | undefined;
-        }) => Promise<{
-            success: boolean;
-        }>;
-        sendToSupport: (data: {
+            /**
+             * @description Email subject
+             * @example Important information about your account
+             */
             subject: string;
-            htmlPart?: string | undefined;
-            textPart?: string | undefined;
-        }) => Promise<{
-            success: boolean;
-        }>;
-    };
-    session: {
-        append: (data: {
-            email?: string | undefined;
-            currency?: string | undefined;
-            language?: string | undefined;
-        }) => Promise<{
+            /**
+             * @description HTML content of the email
+             * @example <p>Hello, this is an <strong>important</strong> message.</p>
+             */
+            htmlPart?: string;
+            /**
+             * @description Plain text content of the email
+             * @example Hello, this is an important message.
+             */
+            textPart?: string;
+        };
+        SendMailResponseDto: {
+            /**
+             * @description Success status
+             * @example true
+             */
             success: boolean;
-            data: {
-                uuid: string;
-            };
-        }>;
-        create: (data: {
+        };
+        SendMailToSupportDto: {
+            /**
+             * @description Email subject
+             * @example Important information about your account
+             */
+            subject: string;
+            /**
+             * @description HTML content of the email
+             * @example <p>Hello, this is an <strong>important</strong> message.</p>
+             */
+            htmlPart?: string;
+            /**
+             * @description Plain text content of the email
+             * @example Hello, this is an important message.
+             */
+            textPart?: string;
+        };
+        ProjectResponseDto: {
+            /**
+             * @description The unique identifier of the project
+             * @example 1
+             */
+            id: number;
+            /**
+             * @description The title of the project
+             * @example My Awesome Project
+             */
+            title: string;
+            /**
+             * @description The unique UUID of the project used for authentication
+             * @example 123e4567-e89b-12d3-a456-426614174000
+             */
+            uuid: string;
+            /**
+             * @description The URL of the project
+             * @example https://myproject.example.com
+             */
+            url: string;
+            /**
+             * @description The support email address for the project
+             * @example support@example.com
+             */
+            support_email: string;
+            /**
+             * @description The slug of the project
+             * @example my-awesome-project
+             */
             slug: string;
-            email?: string | undefined;
-            currency?: string | undefined;
-            language?: string | undefined;
-            quizData?: Record<string, any> | undefined;
-        }) => Promise<{
+        };
+        CreateProjectDto: {
+            /**
+             * @description The title of the project
+             * @example My Awesome Project
+             */
+            title: string;
+            /**
+             * @description The unique UUID of the project used for authentication
+             * @example 123e4567-e89b-12d3-a456-426614174000
+             */
+            uuid: string;
+            /**
+             * @description The URL of the project
+             * @example https://myproject.example.com
+             */
+            url: string;
+            /**
+             * @description The support email address for the project
+             * @example support@example.com
+             */
+            support_email: string;
+            /**
+             * @description The slug of the project
+             * @example my-awesome-project
+             */
+            slug: string;
+        };
+        UpdateProjectDto: {
+            /**
+             * @description The title of the project
+             * @example My Awesome Project
+             */
+            title?: string;
+            /**
+             * @description The unique UUID of the project used for authentication
+             * @example 123e4567-e89b-12d3-a456-426614174000
+             */
+            uuid?: string;
+            /**
+             * @description The URL of the project
+             * @example https://myproject.example.com
+             */
+            url?: string;
+            /**
+             * @description The support email address for the project
+             * @example support@example.com
+             */
+            support_email?: string;
+            /**
+             * @description The slug of the project
+             * @example my-awesome-project
+             */
+            slug?: string;
+        };
+        IntegrationResponseDto: {
+            /**
+             * @description The unique identifier of the integration
+             * @example 1
+             */
+            id: number;
+            /**
+             * @description The title of the integration
+             * @example My Facebook Integration
+             */
+            title: string;
+            /**
+             * @description The ID of the project this integration belongs to
+             * @example 1
+             */
+            projectId: number;
+            /**
+             * @description The type of integration
+             * @example facebook
+             */
+            type: string;
+            /**
+             * @description The URL for the integration
+             * @example https://example.com/api
+             */
+            url: string;
+            /**
+             * @description Additional options for the integration
+             * @example {
+             *       "apiKey": "abc123",
+             *       "enabled": true
+             *     }
+             */
+            options?: Record<string, never>;
+            /** @description The project this integration belongs to */
+            project?: components["schemas"]["ProjectResponseDto"];
+        };
+        CreateIntegrationDto: {
+            /**
+             * @description The type of integration
+             * @example facebook
+             */
+            type: string;
+            /**
+             * @description The title of the integration
+             * @example My Facebook Integration
+             */
+            title: string;
+            /**
+             * @description The ID of the project this integration belongs to
+             * @example 1
+             */
+            projectId: number;
+            /**
+             * @description Additional options for the integration
+             * @example {
+             *       "apiKey": "abc123",
+             *       "enabled": true
+             *     }
+             */
+            options?: Record<string, never>;
+            /**
+             * @description The URL for the integration
+             * @example https://example.com/api
+             */
+            url?: string;
+        };
+        UpdateIntegrationDto: {
+            /**
+             * @description The title of the integration
+             * @example Updated Facebook Integration
+             */
+            title?: string;
+            /**
+             * @description The ID of the project this integration belongs to
+             * @example 1
+             */
+            projectId?: number;
+            /**
+             * @description The type of integration
+             * @example facebook
+             */
+            type?: string;
+            /**
+             * @description The URL for the integration
+             * @example https://example.com/api
+             */
+            url?: string;
+            /**
+             * @description Description of the integration
+             * @example This is a Facebook integration for our project
+             */
+            _description?: string;
+            /**
+             * @description Additional options for the integration
+             * @example {
+             *       "apiKey": "abc123",
+             *       "enabled": true
+             *     }
+             */
+            options?: Record<string, never>;
+        };
+        CreateWebhookDto: {
+            /** @description The title of the webhook */
+            title?: string;
+            /** @description The events that trigger the webhook */
+            events: string[];
+            /** @description The URL endpoint to send the webhook to */
+            endpoint: string;
+            /**
+             * @description The HTTP method to use when sending the webhook
+             * @default GET
+             */
+            method: string;
+            /** @description The authorization header to use when sending the webhook */
+            authorization?: string;
+            /** @description The project associated with the webhook */
+            project?: string;
+        };
+        WebhookResponseDto: {
+            /** @description The unique identifier of the webhook */
+            id: number;
+            /** @description The title of the webhook */
+            title?: string;
+            /** @description The events that trigger the webhook */
+            events: string[];
+            /** @description The URL endpoint to send the webhook to */
+            endpoint: string;
+            /**
+             * @description The HTTP method to use when sending the webhook
+             * @default GET
+             */
+            method: string;
+            /** @description The authorization header to use when sending the webhook */
+            authorization?: string;
+            /** @description The project associated with the webhook */
+            project?: string;
+        };
+        UpdateWebhookDto: {
+            /** @description The title of the webhook */
+            title?: string;
+            /** @description The URL endpoint to send the webhook to */
+            endpoint?: string;
+            /** @description The HTTP method to use when sending the webhook */
+            method?: string;
+            /** @description The authorization header to use when sending the webhook */
+            authorization?: string;
+            /** @description The project associated with the webhook */
+            project?: string;
+        };
+        FunnelTemplatesEnumDto: {
+            /**
+             * @description Available templates for the home page
+             * @example [
+             *       "Default"
+             *     ]
+             */
+            homePageTemplate: string[];
+            /**
+             * @description Available templates for the quiz page
+             * @example [
+             *       "Default"
+             *     ]
+             */
+            quizPageTemplate: string[];
+            /**
+             * @description Available templates for the result page
+             * @example [
+             *       "Default"
+             *     ]
+             */
+            resultPageTemplate: string[];
+            /**
+             * @description Available templates for the email page
+             * @example [
+             *       "Default"
+             *     ]
+             */
+            emailPageTemplate: string[];
+            /**
+             * @description Available templates for the checkout page
+             * @example [
+             *       "Default"
+             *     ]
+             */
+            checkoutPageTemplate: string[];
+            /**
+             * @description Available templates for the upsell page
+             * @example [
+             *       "Default"
+             *     ]
+             */
+            upsellPageTemplate: string[];
+            /**
+             * @description Available templates for the payment window
+             * @example [
+             *       "Default"
+             *     ]
+             */
+            paymentWindowTemplate: string[];
+        };
+        FunnelTemplatesEnumResponseDto: {
+            /** @description Indicates if the request was successful */
             success: boolean;
-            data: {
-                uuid: string;
+            data: components["schemas"]["FunnelTemplatesEnumDto"];
+        };
+        CreateFunnelDtoBridge: {
+            angle: string;
+            version: string;
+            note?: string;
+            home_page?: string;
+            quiz_page?: string;
+            results_page?: string;
+            email_page?: string;
+            checkout_page?: string;
+            payment_window?: string;
+            upsell_page: string;
+            upsell_options?: {
+                [key: string]: unknown;
             };
-        }>;
-    };
-    crmAuth: {
-        signIn: (data: {
-            data: {
-                username: string;
-                password: string;
-                remindMe?: boolean | undefined;
+            options?: {
+                [key: string]: unknown;
             };
-        }) => Promise<{
-            token: string;
-            action: string;
-        }>;
-        signOut: () => Promise<{
-            success: 1;
-        }>;
-        verify: () => Promise<{
-            email: string;
+        };
+        FunnelResponseDto: {
+            id: number;
+            project: string;
+            angle: string;
+            version: string;
+            note?: string;
+            home_page: string;
+            quiz_page: string;
+            results_page: string;
+            email_page: string;
+            checkout_page: string;
+            payment_window: string;
+            upsell_page: string;
+            upsell_options?: Record<string, never>;
+            options?: Record<string, never>;
+        };
+        UpdateFunnelDto: {
+            project?: string;
+            angle?: string;
+            version?: string;
+            note?: string;
+            home_page?: string;
+            quiz_page?: string;
+            results_page?: string;
+            email_page?: string;
+            checkout_page?: string;
+            payment_window?: string;
+            upsell_page?: string;
+            upsell_options?: {
+                [key: string]: unknown;
+            };
+            options?: {
+                [key: string]: unknown;
+            };
+        };
+        SplitItemDto: {
+            url: string;
+            split: number;
+        };
+        CreateSplitDto: {
+            project: string;
+            url?: string;
+            splits?: components["schemas"]["SplitItemDto"][];
+            options?: {
+                [key: string]: unknown;
+            };
+            active: boolean;
+        };
+        SplitResponseDto: {
             id: number;
-            firstName: string;
-            lastName: string;
-        }>;
+            project: string;
+            url?: string;
+            splits?: components["schemas"]["SplitItemDto"][];
+            options?: Record<string, never>;
+            active: boolean;
+        };
+        UpdateSplitDto: {
+            project?: string;
+            url?: string;
+            splits?: components["schemas"]["SplitItemDto"][];
+            options?: {
+                [key: string]: unknown;
+            };
+            active?: boolean;
+        };
+        FacebookCapiPixelDto: {
+            /** @example 1234567890123456 */
+            pixelId: string;
+            /** @description Facebook CAPI Access Token */
+            accessToken: string;
+        };
+        FacebookCapiClientDataDto: {
+            /**
+             * @description The user's email address.
+             * @example joe@example.com
+             */
+            email: string;
+            /**
+             * @description The user's IP address.
+             * @example 123.123.123.123
+             */
+            ip: string;
+            /**
+             * @description The user's browser user agent string.
+             * @example Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...
+             */
+            userAgent: string;
+            /**
+             * @description The Facebook click ID.
+             * @example fb.1.1554763741205.AbCdEfGhIjKlMnOp
+             */
+            fbc: string;
+            /**
+             * @description The Facebook browser ID.
+             * @example fb.1.1558571054389.1098115397
+             */
+            fbp: string;
+        };
+        FacebookCapiEventDataDto: {
+            /** @example USD */
+            currency: string;
+            /** @example 129.99 */
+            total: number;
+            /** @example https://example.com/product/123 */
+            source_url: string;
+        };
+        FacebookCapiEventDto: {
+            /** @example EVENT_ID_123 */
+            eventId: string;
+            /** @example Purchase */
+            eventName: string;
+            /**
+             * @description Unix timestamp
+             * @example 1678886400
+             */
+            eventTime: number;
+            clientData: components["schemas"]["FacebookCapiClientDataDto"];
+            eventData: components["schemas"]["FacebookCapiEventDataDto"];
+        };
+        FacebookCapiPayloadDto: {
+            pixel: components["schemas"]["FacebookCapiPixelDto"];
+            event: components["schemas"]["FacebookCapiEventDto"];
+        };
+        TiktokCapiPixelDto: {
+            /** @example 1234567890123456 */
+            pixelId: string;
+            /** @description Tiktok CAPI Access Token */
+            accessToken: string;
+        };
+        TiktokCapiClientDataDto: {
+            /**
+             * @description The user's email address.
+             * @example joe@example.com
+             */
+            email: string;
+            /**
+             * @description The user's IP address.
+             * @example 123.123.123.123
+             */
+            ip: string;
+            /**
+             * @description The user's browser user agent string.
+             * @example Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...
+             */
+            userAgent: string;
+            /**
+             * @description The Tiktok click ID.
+             * @example fb.1.1554763741205.AbCdEfGhIjKlMnOp
+             */
+            fbc: string;
+            /**
+             * @description The Tiktok browser ID.
+             * @example fb.1.1558571054389.1098115397
+             */
+            fbp: string;
+        };
+        TiktokCapiEventDataDto: {
+            /** @example USD */
+            currency: string;
+            /** @example 129.99 */
+            total: number;
+            /** @example https://example.com/product/123 */
+            source_url: string;
+        };
+        TiktokCapiEventDto: {
+            /** @example EVENT_ID_123 */
+            eventId: string;
+            /** @example Purchase */
+            eventName: string;
+            /**
+             * @description Unix timestamp
+             * @example 1678886400
+             */
+            eventTime: number;
+            clientData: components["schemas"]["TiktokCapiClientDataDto"];
+            eventData: components["schemas"]["TiktokCapiEventDataDto"];
+        };
+        TiktokCapiPayloadDto: {
+            pixel: components["schemas"]["TiktokCapiPixelDto"];
+            event: components["schemas"]["TiktokCapiEventDto"];
+        };
+        TrackRealtimeEventDto: {
+            type: string;
+            uuid?: string;
+            pathname: string;
+            referer: string;
+            origin: string;
+            /** @example {
+             *       "session_id": "a1b2c3d4-e5f6-7890",
+             *       "status": "active"
+             *     } */
+            query: {
+                [key: string]: string;
+            };
+            /** @example {
+             *       "user_id": 12345,
+             *       "session_id": "a1b2c3d4-e5f6-7890",
+             *       "status": "active",
+             *       "retry_count": 3
+             *     } */
+            eventData?: {
+                [key: string]: string | number;
+            };
+            /** @example {
+             *       "user_id": 12345,
+             *       "session_id": "a1b2c3d4-e5f6-7890",
+             *       "status": "active",
+             *       "retry_count": 3
+             *     } */
+            attr?: {
+                [key: string]: string | number;
+            };
+            skipEvent?: boolean;
+        };
+        CreateRealtimeAttributeDtoBridge: {
+            attr_key: string;
+            attr_value: string;
+            funnel: string;
+            created_at: number;
+            uuid: string;
+        };
+        CreateRealtimeEventDtoBridge: {
+            uuid: string;
+            name: string;
+            data?: {
+                [key: string]: unknown;
+            };
+            order_id?: string;
+            created_at: number;
+            funnel: string;
+        };
+        CreateRealtimeSessionDtoBridge: {
+            uuid: string;
+            ip: string;
+            user_agent: string;
+            origin: string;
+            referer: string;
+            os: string;
+            browser: string;
+            type: string;
+        };
+        CreateRealtimeUtmDtoBridge: {
+            utm_key: string;
+            utm_value: string;
+            funnel: string;
+            created_at: number;
+            uuid: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+declare const browser: {
+    mail: {
+        sendToRecipient: (data: components["schemas"]["SendMailToRecipientDto"]) => Promise<components["schemas"]["SendMailResponseDto"]>;
+        sendToSupport: (data: components["schemas"]["SendMailToSupportDto"]) => Promise<components["schemas"]["SendMailResponseDto"]>;
+    };
+    session: {
+        append: () => Promise<void>;
+        create: () => Promise<void>;
+    };
+    crmAuth: {
+        signIn: () => Promise<void>;
+        signOut: () => Promise<void>;
+        verify: () => Promise<void>;
     };
     hooks: {
         useParamsLandingPage: () => ParamsLandingPageResponse;
     };
+    realtime: {
+        trackEvent: (type: string, uuid?: string, options?: {
+            ga?: any;
+            skipGa?: boolean;
+            path?: {
+                pathname?: string;
+                referer?: string;
+                origin?: string;
+                length?: number;
+            };
+            attr?: {
+                [key: string]: string | number;
+            };
+            eventData?: {
+                [key: string]: string | number;
+            };
+            skipEvent?: boolean;
+        }) => Promise<void>;
+    };
 };
 declare const server: {
-    middleware: (req: next_server.NextRequest) => Promise<any>;
+    middleware: (req: next_server.NextRequest) => Promise<next_server.NextResponse<unknown> | undefined>;
 };
 
 export { browser, server };