@erp-galoper/types 1.0.1169 → 1.0.1171

package/openapi.ts

@@ -2791,6 +2791,70 @@ export interface paths {
         patch: operations["common_facility_views_update_facility"];
         trace?: never;
     };
+    "/api/v1/payment-provider/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Payment Provider
+         * @description Endpoint for get payment provider
+         *     Possible Responses:
+         *     - 200:
+         *         - PaymentProviderSchema
+         *     - 403:
+         *         - permissionDenied
+         *     - 404:
+         *         - paymentProviderDoesNotExist
+         *     - 500:
+         *         - internalServerError
+         *     - Permission Key:
+         *         - paymentprovider : [ view ]
+         */
+        get: operations["common_payment_method_views_get_payment_provider"];
+        /**
+         * Update Payment Provider
+         * @description Endpoint for update payment provider
+         *     Possible Responses:
+         *     - 200:
+         *         - paymentProviderUpdated
+         *     - 400:
+         *         - creditCardPaymentMethodNotFound
+         *     - 403:
+         *         - permissionDenied
+         *     - 404:
+         *         - paymentProviderDoesNotExist
+         *     - 500:
+         *         - internalServerError
+         *     - Permission Key:
+         *         - paymentprovider : [ change ]
+         */
+        put: operations["common_payment_method_views_update_payment_provider"];
+        /**
+         * Create Payment Provider
+         * @description Endpoint for create payment provider
+         *     Possible Responses:
+         *     - 201:
+         *         - paymentProviderCreated
+         *     - 400:
+         *         - creditCardPaymentMethodNotFound
+         *         - paymentProviderAlreadyExists
+         *     - 403:
+         *         - permissionDenied
+         *     - 500:
+         *         - internalServerError
+         *     - Permission Key:
+         *         - paymentprovider : [ add ]
+         */
+        post: operations["common_payment_method_views_create_payment_provider"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/payment_methods/": {
         parameters: {
             query?: never;
@@ -21317,7 +21381,7 @@ export interface components {
          * BasePermissionsSchema_Sales_SalespricelistEnum
          * @enum {string}
          */
-        BasePermissionsSchema_Sales_SalespricelistEnum: "add" | "approve" | "cancel" | "change" | "delete" | "export" | "resettodraft" | "view";
+        BasePermissionsSchema_Sales_SalespricelistEnum: "add" | "approve" | "cancel" | "change" | "delete" | "export" | "migratetopos" | "resettodraft" | "view";
         /**
          * BasePermissionsSchema_Sales_SalesquotationEnum
          * @enum {string}
@@ -21822,6 +21886,12 @@ export interface components {
              * @default []
              */
             paymentmethod: components["schemas"]["BasePermissionsSchema_Settings_Miscellaneous_PaymentmethodEnum"][];
+            /**
+             * Paymentprovider
+             * @description paymentprovider actions
+             * @default []
+             */
+            paymentprovider: components["schemas"]["BasePermissionsSchema_Settings_Miscellaneous_PaymentproviderEnum"][];
             /**
              * Reason
              * @description reason actions
@@ -21922,6 +21992,11 @@ export interface components {
          * @constant
          */
         BasePermissionsSchema_Settings_Miscellaneous_PaymentmethodEnum: "view";
+        /**
+         * BasePermissionsSchema_Settings_Miscellaneous_PaymentproviderEnum
+         * @enum {string}
+         */
+        BasePermissionsSchema_Settings_Miscellaneous_PaymentproviderEnum: "add" | "change" | "delete" | "view";
         /**
          * BasePermissionsSchema_Settings_Miscellaneous_ReasonEnum
          * @enum {string}
@@ -26144,6 +26219,56 @@ export interface components {
             name: string;
             branch: components["schemas"]["BranchInfo"];
         };
+        /**
+         * PaymentProviderFeeTypeEnum
+         * @enum {string}
+         */
+        PaymentProviderFeeTypeEnum: "embedded" | "surcharge";
+        /** PaymentProviderResponseSchema */
+        PaymentProviderResponseSchema: {
+            /** Code */
+            code: string;
+            /** Message */
+            message: string;
+            data: components["schemas"]["PaymentProviderSchema"];
+        };
+        /** PaymentProviderSchema */
+        PaymentProviderSchema: {
+            /**
+             * Datecreated
+             * Format: date-time
+             */
+            dateCreated: string;
+            /** Datemodified */
+            dateModified: string | null;
+            createdBy: components["schemas"]["RecordUserSchema"];
+            modifiedBy: components["schemas"]["RecordUserSchema"] | null;
+            /** Id */
+            id: number;
+            /** Providername */
+            providerName: string;
+            feeType: components["schemas"]["PaymentProviderFeeTypeEnum"];
+            /** Feepercentage */
+            feePercentage: number;
+        };
+        /** CreateUpdatePaymentProviderSchema */
+        CreateUpdatePaymentProviderSchema: {
+            /**
+             * Paymentmethod
+             * @description - This field should be disabled
+             *         - get credit card payment method using route /api/v1/payment_methods/ and filter by name equals {Credit Card}
+             */
+            paymentMethod: number;
+            /** Providername */
+            providerName: string;
+            /**
+             * @description - embedded: fee is included in the amount charged to the customer
+             *         - surcharge: fee is added on top of the amount charged to the customer
+             */
+            feeType: components["schemas"]["PaymentProviderFeeTypeEnum"];
+            /** Feepercentage */
+            feePercentage: number;
+        };
         /** ListPaymentMethod */
         ListPaymentMethod: {
             /** Id */
@@ -50648,15 +50773,16 @@ export interface components {
         CreateUpdateActivity: {
             /**
              * Id
-             * @description - Required when updating an existing activuty (nested) via api/v1/task/ update task
-             *             - Must be omitted when creating a new activity (nested or separately)
+             * @description - Creating a new Activity (Nested or Standalone): MUST be omitted (or set to null).
+             *                 - Updating a Activity Nested in a Task: REQUIRED within the activity object in the request body to identify the existing activity being modified.
+             *                 - Updating a Standalone Activity (via api/v1/task/activity/ ): Omitted in the request body (ID is derived from the URL).
              */
             id?: string | null;
             /**
              * Task Id
-             * @description - Required only when creating an activity separately via api/v1/task/activity create activity
-             *             - Must be omitted when updating an existing activity via api/v1/task/activity (task cannot be replaced)
-             *             - Must be omitted when creating/updating a task via api/v1/task/
+             * @description - Creating a Activity Separately (via api/v1/task/activity/ create endpoint): REQUIRED to link the new activity to a parent task.
+             *                 - Creating/Updating a Task with Nested Activities (via /task/ endpoint): MUST be omitted
+             *                 - Updating an Existing Activity: MUST be omitted, as the parent task association is immutable and cannot be changed.
              */
             task_id: string | null;
             /** Name */
@@ -50708,15 +50834,16 @@ export interface components {
         CreateUpdateComment: {
             /**
              * Id
-             * @description - Required when updating an existing comment (nested) via api/v1/task/ update task
-             *             - Must be omitted when creating a new comment (nested or separately)
+             * @description - Creating a new Comment (Nested or Standalone): MUST be omitted (or set to null).
+             *                 - Updating a Comment Nested in a Task: REQUIRED within the comment object in the request body to identify the existing comment being modified.
+             *                 - Updating a Standalone Comment (via api/v1/task/comment/ ): Omitted in the request body (ID is derived from the URL).
              */
             id?: string | null;
             /**
              * Task Id
-             * @description - Required only when creating a comment separately via api/v1/task/comment create comment
-             *             - Must be omitted when updating an existing comment via api/v1/task/comment (task cannot be replaced)
-             *             - Must be omitted when creating/updating a task via api/v1/task/
+             * @description - Creating a Comment Separately (via /comment/ create endpoint): REQUIRED to link the new comment to a parent task.
+             *                 - Creating/Updating a Task with Nested Comments (via /task/ endpoint): MUST be omitted
+             *                 - Updating an Existing Comment: MUST be omitted, as the parent task association is immutable and cannot be changed.
              */
             task_id: string | null;
             /**
@@ -50824,17 +50951,20 @@ export interface components {
         CreateUpdateTask: {
             /**
              * Id
-             * @description - since subtasks references this schema (List["CreateUpdateTask"]), and it should provide id for update
-             *             - Required only when updating an existing subtask nested in a task via api/v1/task/ create task
-             *             - Must be omitted when creating a new subtask (nested or separately)
+             * @description The unique identifier (UUID) of the Task or Subtask.
+             *                 - Creating a new Task/Subtask: MUST be omitted (or set to null).
+             *                 - Updating a Parent Task: Omitted in the request body (ID is derived from the URL).
+             *                 - Updating a Nested Subtask: REQUIRED within the subtask object to identify the existing subtask being modified.
              */
             id?: string | null;
             /**
              * Parenttaskid
-             * @description - Required if api/v1/task create task is used to create a subtask separately
-             *             - Must be omitted when updating an existing subtask via api/v1/task/ (parent task cannot be replaced)
-             *             - Must be omitted when creating/updating a subtask via api/v1/task/
-             *             - If this field is filled, subtasks:List["CreateUpdateTask"] must be null (subtasks can't have subtasks)
+             * @description The UUID of the parent task. This field explicitly marks the current object as a subtask.
+             *                 - Creating a Subtask Separately (via api/v1/task/): REQUIRED to link the new subtask to a parent.
+             *                 - Creating/Updating a Task with Nested Subtasks: MUST be omitted.
+             *                 - Updating an Existing Subtask: MUST be omitted, as a subtask's parent cannot be replaced.
+             *
+             *             If 'parent_task' is provided, the 'subtasks: List["CreateUpdateTask"]' field must be null or an empty list, as subtasks cannot have subtasks (max depth of 1).
              */
             parentTaskID?: string | null;
             /**
@@ -50863,8 +50993,11 @@ export interface components {
             statusId?: string | null;
             /**
              * Templatetaskid
-             * @description - The ID of the task template this task is based on
-             *                 - Required for creation (POST), but can be omitted for update (PUT/PATCH)
+             * @description The UUID of the Task Template used as the basis for this task.
+             *
+             *             Usage Rules:
+             *             1. For Creation (POST): This field is Optional. Provide a value only if the new task is being generated from an existing template.
+             *             2. For Update (PUT/PATCH): This field **MUST be omitted**. The template association is immutable and cannot be changed or replaced after the task has been created.
              */
             templateTaskId?: string | null;
             /**
@@ -50884,10 +51017,9 @@ export interface components {
             dependenciesIds?: string[];
             /**
              * Subtasks
-             * @description A list of subtasks for this task.
-             *                 - Optional field (nullable)
-             *                 - Only parent tasks can have subtasks
-             *                 - Subtasks cannot have their own subtasks
+             * @description - A list of nested subtasks to be created or updated under this task.
+             *                 - Subtasks cannot have their own subtasks . If a task has a value for `parent_task_id`, this `subtasks` field MUST be empty (`[]` or null).
+             *                 - Task Type: Only top-level tasks (tasks with `parent_task_id` omitted) can contain subtasks.
              */
             subtasks?: components["schemas"]["CreateUpdateTask"][];
             /** Comments */
@@ -50904,11 +51036,11 @@ export interface components {
             repeatEndDate?: string | null;
             /** Repeatevery */
             repeatEvery?: number | null;
-            /** @description Required For Creation and Must be Omitted for update */
+            /** @description Optional For Creation and Must be Omitted for update */
             documentContentType?: components["schemas"]["CombinedModelName"] | null;
             /**
              * Documentid
-             * @description Required For Creation and Must be Omitted for update
+             * @description Optional For Creation and Must be Omitted for update
              */
             documentId?: string | null;
         };
@@ -56620,6 +56752,164 @@ export interface operations {
             };
         };
     };
+    common_payment_method_views_get_payment_provider: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentProviderSchema"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                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"];
+                };
+            };
+        };
+    };
+    common_payment_method_views_update_payment_provider: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateUpdatePaymentProviderSchema"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentProviderResponseSchema"];
+                };
+            };
+            /** @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 Not Found */
+            404: {
+                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"];
+                };
+            };
+        };
+    };
+    common_payment_method_views_create_payment_provider: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateUpdatePaymentProviderSchema"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentProviderResponseSchema"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     common_payment_method_views_list_payment_methods: {
         parameters: {
             query?: never;

package/package.json

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