@erp-galoper/types 1.0.1535 → 1.0.1536

package/openapi.ts

@@ -20980,11 +20980,16 @@ export interface paths {
          * @description Endpoint for updating sync store configuration (Shopify or WooCommerce)
          *
          *     Can update platform-specific fields:
-         *     - Shopify: storeDomain, accessToken, apiVersion
+         *     - Shopify: storeDomain, accessToken, apiVersion, shopifyClientId, shopifyClientSecret
          *     - WooCommerce: storeUrl, consumerKey, consumerSecret, apiVersion
          *
+         *     Note: If Shopify OAuth credentials (Client ID/Secret) are updated:
+         *     - Access token will be cleared automatically
+         *     - Store status will be set to 'pending'
+         *     - User must reinstall the app to get a new access token
+         *
          *     Possible Responses:
-         *     - 200: syncStoreUpdated
+         *     - 200: syncStoreUpdated, oauthCredentialsUpdatedReinstallRequired
          *     - 400: validationFailed, onlineStoreSettingNotConfigured, connectionFailed
          *     - 404: storeDoesNotExist
          *     - 403: permissionDenied
@@ -21038,9 +21043,14 @@ export interface paths {
          *     Can update all fields EXCEPT storeDomain (domain cannot be changed after creation).
          *     Only provide the fields you want to update.
          *
+         *     Note: If Shopify OAuth credentials (Client ID/Secret) are updated:
+         *     - Access token will be cleared automatically
+         *     - Store status will be set to 'pending'
+         *     - User must reinstall the app to get a new access token
+         *
          *     Possible Responses:
-         *     - 200: syncStoreUpdated
-         *     - 400: validationFailed, connectionFailed
+         *     - 200: syncStoreUpdated, oauthCredentialsUpdatedReinstallRequired
+         *     - 400: validationFailed, connectionFailed, storeDomainImmutable
          *     - 404: storeDoesNotExist
          *     - 403: permissionDenied
          *     - 500: unexpectedError
@@ -21372,6 +21382,77 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/integrations/sync/shopify/app": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Shopify App Entry
+         * @description Shopify App Entry Point
+         *
+         *     This is the main App URL that Shopify redirects to when the user installs your app.
+         *     It checks if the store is already authenticated:
+         *     - If YES: Shows app interface (or redirects to your frontend)
+         *     - If NO: Initiates OAuth flow
+         *
+         *     Query Parameters (sent by Shopify):
+         *     - shop: Shopify store domain (e.g., mystore.myshopify.com)
+         *     - host: Base64 encoded shop/id (used for embedded apps)
+         *
+         *     This should be set as your "App URL" in Shopify Partner Dashboard
+         */
+        get: operations["integration_sync_views_shopify_app_entry"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/integrations/sync/shopify/oauth/callback": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Shopify Oauth Callback
+         * @description Shopify OAuth callback endpoint
+         *
+         *     Shopify redirects here after the user approves the app installation.
+         *     This endpoint:
+         *     1. Verifies the HMAC signature
+         *     2. Exchanges the temporary code for a permanent access token
+         *     3. Fetches shop information
+         *     4. Creates or updates the SyncStore configuration
+         *
+         *     Query Parameters (automatically sent by Shopify):
+         *     - shop: Shopify store domain
+         *     - code: Temporary authorization code
+         *     - hmac: HMAC signature for verification
+         *     - timestamp: Request timestamp
+         *     - state: Optional state parameter (if provided during install)
+         *     - host: Optional Shopify host parameter
+         *
+         *     Returns:
+         *     - 200: Installation successful, store created/updated
+         *     - 400: Validation failed or HMAC verification failed
+         *     - 500: Token exchange or store creation failed
+         */
+        get: operations["integration_sync_views_shopify_oauth_callback"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/integrations/whatsapp/setup/": {
         parameters: {
             query?: never;
@@ -56352,12 +56433,13 @@ export interface components {
          *
          *     For Shopify:
          *     - storeDomain: Store domain (e.g., mystore.myshopify.com)
-         *     - accessToken: Shopify API access token
+         *     - shopifyClientId: Shopify app Client ID (for OAuth)
+         *     - shopifyClientSecret: Shopify app Client Secret (for OAuth)
          *     - apiVersion: Shopify API version (default: 2024-01)
          *
          *     For WooCommerce:
          *     - storeDomain: Store domain (e.g., mystore.com)
-         *     - accessToken: WooCommerce consumer key
+         *     - consumerKey: WooCommerce consumer key
          *     - consumerSecret: WooCommerce consumer secret
          *     - apiVersion: WooCommerce API version (default: wc/v3)
          */
@@ -56375,10 +56457,15 @@ export interface components {
              */
             storeDomain?: string | null;
             /**
-             * Accesstoken
-             * @description [SHOPIFY ONLY] API access token
+             * Shopifyclientid
+             * @description [SHOPIFY ONLY] Shopify app Client ID for OAuth
              */
-            accessToken?: string | null;
+            shopifyClientId?: string | null;
+            /**
+             * Shopifyclientsecret
+             * @description [SHOPIFY ONLY] Shopify app Client Secret for OAuth
+             */
+            shopifyClientSecret?: string | null;
             /**
              * Consumerkey
              * @description [WOOCOMMERCE ONLY] Consumer key
@@ -56409,10 +56496,15 @@ export interface components {
              */
             storeName?: string | null;
             /**
-             * Accesstoken
-             * @description [SHOPIFY ONLY] API access token
+             * Shopifyclientid
+             * @description [SHOPIFY ONLY] Shopify app Client ID
+             */
+            shopifyClientId?: string | null;
+            /**
+             * Shopifyclientsecret
+             * @description [SHOPIFY ONLY] Shopify app Client Secret
              */
-            accessToken?: string | null;
+            shopifyClientSecret?: string | null;
             /**
              * Consumerkey
              * @description [WOOCOMMERCE ONLY] Consumer key
@@ -56598,6 +56690,25 @@ export interface components {
          * @enum {string}
          */
         PaymentMethodType: "credit_card" | "debit_card" | "cash_on_delivery" | "bank_transfer" | "paypal" | "apple_pay" | "google_pay" | "shopify_payments" | "manual" | "other";
+        /**
+         * ShopifyOAuthResponseSchema
+         * @description Schema for successful OAuth installation response
+         */
+        ShopifyOAuthResponseSchema: {
+            /** Success */
+            success: boolean;
+            /** Message */
+            message: string;
+            /**
+             * Store Id
+             * Format: uuid
+             */
+            store_id: string;
+            /** Store Name */
+            store_name: string;
+            /** Shop Domain */
+            shop_domain: string;
+        };
         /**
          * WhatsAppIntegrationResponseSchema
          * @description Schema for returning WhatsApp integration information.
@@ -100532,6 +100643,131 @@ export interface operations {
                     "application/json": components["schemas"]["MessageResponse"];
                 };
             };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+        };
+    };
+    integration_sync_views_shopify_app_entry: {
+        parameters: {
+            query: {
+                /** @description Shopify store domain */
+                shop: string;
+                /** @description Shopify host parameter */
+                host?: string | null;
+                /** @description Embedded app indicator */
+                embedded?: string | null;
+                /** @description HMAC signature */
+                hmac?: string | null;
+                /** @description Shopify ID token */
+                id_token?: string | null;
+                /** @description User locale */
+                locale?: string | null;
+                /** @description Session ID */
+                session?: string | null;
+                /** @description Request timestamp */
+                timestamp?: string | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": Record<string, never>;
+                };
+            };
+            /** @description Found */
+            302: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessages"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+        };
+    };
+    integration_sync_views_shopify_oauth_callback: {
+        parameters: {
+            query: {
+                shop: string;
+                code: string;
+                hmac: string;
+                timestamp: string;
+                state?: string | null;
+                host?: string | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ShopifyOAuthResponseSchema"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessages"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
         };
     };
     integration_whatsapp_views_get_whatsapp_integration: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erp-galoper/types",
-  "version": "1.0.1535",
+  "version": "1.0.1536",
   "main": "openapi.ts",
   "types": "openapi.ts",
   "files": ["openapi.ts"],