repzo 1.0.155 → 1.0.157

package/src/oas/integration-action-log.yaml

@@ -0,0 +1,361 @@
+openapi: 3.0.0
+info:
+  title: Integration Action Log API
+  description: API for managing integration action logs
+  version: 1.0.0
+  contact:
+    name: Repzo
+    url: https://repzo.com
+
+servers:
+  - url: https://sv.api.repzo.me
+    description: Production server
+  - url: https://staging.sv.api.repzo.me
+    description: Staging server
+
+tags:
+  - name: Integration Action Log
+    description: Operations related to integration action log management
+
+paths:
+  /integration-action-log:
+    get:
+      tags:
+        - Integration Action Log
+      summary: Get all integration action log records
+      description: Retrieve a list of all integration action log records with optional filtering and pagination
+      parameters:
+        - name: limit
+          in: query
+          description: Maximum number of records to return
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 50
+        - name: offset
+          in: query
+          description: Number of records to skip for pagination
+          required: false
+          schema:
+            type: integer
+            minimum: 0
+            default: 0
+        - name: sort
+          in: query
+          description: Field to sort by
+          required: false
+          schema:
+            type: string
+        - name: order
+          in: query
+          description: Sort order (asc or desc)
+          required: false
+          schema:
+            type: string
+            enum: [asc, desc]
+            default: desc
+        - name: filter
+          in: query
+          description: Filter conditions in JSON format
+          required: false
+          schema:
+            type: string
+        - name: search
+          in: query
+          description: Search term for text fields
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: List of integration action log records retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/IntegrationActionLog"
+                  total:
+                    type: integer
+                    description: Total number of records
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    post:
+      tags:
+        - Integration Action Log
+      summary: Create a new integration action log record
+      description: Create a new integration action log record with the provided data
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/IntegrationActionLogInput"
+      responses:
+        "201":
+          description: Integration action log record created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/IntegrationActionLog"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /integration-action-log/{id}:
+    get:
+      tags:
+        - Integration Action Log
+      summary: Get integration action log record by ID
+      description: Retrieve a specific integration action log record by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Integration action log record ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Integration action log record retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/IntegrationActionLog"
+        "404":
+          description: Integration action log record not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    put:
+      tags:
+        - Integration Action Log
+      summary: Update integration action log record
+      description: Update an existing integration action log record with new data
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Integration action log record ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/IntegrationActionLogInput"
+      responses:
+        "200":
+          description: Integration action log record updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/IntegrationActionLog"
+        "400":
+          description: Bad request
+        "404":
+          description: Integration action log record not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    delete:
+      tags:
+        - Integration Action Log
+      summary: Delete integration action log record
+      description: Delete an existing integration action log record
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Integration action log record ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Integration action log record deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  message:
+                    type: string
+                    example: Integration action log record deleted successfully
+        "404":
+          description: Integration action log record not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    IntegrationActionLog:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the integration action log record
+          example: "60f7b1b3e4b0e8b3f8b3f8b3"
+        integrationId:
+          type: string
+          description: Integration identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        actionType:
+          type: string
+          enum: [create, update, delete, sync, webhook]
+          description: Type of action performed
+          example: "create"
+        entityType:
+          type: string
+          description: Type of entity affected
+          example: "product"
+        entityId:
+          type: string
+          description: ID of the affected entity
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        status:
+          type: string
+          enum: [pending, success, failed, retrying]
+          description: Status of the action
+          example: "success"
+        payload:
+          type: object
+          additionalProperties: true
+          description: Action payload data
+        response:
+          type: object
+          additionalProperties: true
+          description: Response data from the action
+        errorMessage:
+          type: string
+          description: Error message if action failed
+        retryCount:
+          type: integer
+          minimum: 0
+          default: 0
+          description: Number of retry attempts
+        executionTime:
+          type: number
+          description: Execution time in milliseconds
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+        createdAt:
+          type: string
+          format: date-time
+          description: Record creation timestamp
+          example: "2023-01-15T08:00:00Z"
+        updatedAt:
+          type: string
+          format: date-time
+          description: Record last update timestamp
+          example: "2023-01-15T10:30:00Z"
+      required:
+        - integrationId
+        - actionType
+        - entityType
+        - status
+
+    IntegrationActionLogInput:
+      type: object
+      properties:
+        integrationId:
+          type: string
+          description: Integration identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        actionType:
+          type: string
+          enum: [create, update, delete, sync, webhook]
+          description: Type of action performed
+          example: "create"
+        entityType:
+          type: string
+          description: Type of entity affected
+          example: "product"
+        entityId:
+          type: string
+          description: ID of the affected entity
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        status:
+          type: string
+          enum: [pending, success, failed, retrying]
+          description: Status of the action
+          example: "success"
+        payload:
+          type: object
+          additionalProperties: true
+          description: Action payload data
+        response:
+          type: object
+          additionalProperties: true
+          description: Response data from the action
+        errorMessage:
+          type: string
+          description: Error message if action failed
+        retryCount:
+          type: integer
+          minimum: 0
+          default: 0
+          description: Number of retry attempts
+        executionTime:
+          type: number
+          description: Execution time in milliseconds
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+      required:
+        - integrationId
+        - actionType
+        - entityType
+        - status
+
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
+
+security:
+  - ApiKeyAuth: []

package/src/oas/integration-app.yaml

@@ -0,0 +1,303 @@
+openapi: 3.0.3
+info:
+  title: Repzo API - Integration App
+  version: 1.0.0
+  description: OpenAPI specification for Repzo Integration App endpoints.
+servers:
+  - url: https://sv.api.repzo.me
+paths:
+  /integration-app:
+    get:
+      summary: Find integration apps
+      operationId: findIntegrationApps
+      parameters:
+        - in: query
+          name: params
+          schema:
+            type: object
+            properties:
+              _id:
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
+              search:
+                type: string
+              name:
+                type: string
+              category:
+                type: string
+              status:
+                type: string
+                enum: [active, inactive, pending]
+              from_updatedAt:
+                type: number
+              from__id:
+                type: string
+              to__id:
+                type: string
+              sortBy:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    field:
+                      type: string
+                      enum: [_id, createdAt, updatedAt, name]
+                    type:
+                      type: string
+                      enum: [asc, desc]
+          description: Query parameters for filtering integration apps
+      responses:
+        "200":
+          description: A list of integration apps
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/IntegrationAppFindResult"
+    post:
+      summary: Create an integration app
+      operationId: createIntegrationApp
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/IntegrationAppCreateBody"
+      responses:
+        "201":
+          description: Integration app created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/IntegrationAppCreateResult"
+  /integration-app/{id}:
+    get:
+      summary: Get an integration app by ID
+      operationId: getIntegrationApp
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Integration app details
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/IntegrationAppGetResult"
+    put:
+      summary: Update an integration app
+      operationId: updateIntegrationApp
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/IntegrationAppUpdateBody"
+      responses:
+        "200":
+          description: Integration app updated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/IntegrationAppUpdateResult"
+components:
+  schemas:
+    IntegrationAppFindResult:
+      type: object
+      description: Result of finding integration apps
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/IntegrationAppSchema"
+        total_result:
+          type: number
+          description: Total number of integration apps
+        current_count:
+          type: number
+          description: Count of integration apps in current page
+        total_pages:
+          type: number
+          description: Total number of pages
+        current_page:
+          type: number
+          description: Current page number
+        per_page:
+          type: number
+          description: Number of integration apps per page
+    IntegrationAppSchema:
+      type: object
+      description: Integration app schema
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the integration app
+        name:
+          type: string
+          description: Name of the integration app
+        description:
+          type: string
+          description: Description of the integration app
+        category:
+          type: string
+          description: Category of the integration
+        version:
+          type: string
+          description: Version of the integration app
+        status:
+          type: string
+          enum: [active, inactive, pending]
+          description: Status of the integration app
+        available_app:
+          type: string
+          description: Available app reference
+        company_namespace:
+          type: string
+          description: Company namespace
+        config:
+          type: object
+          additionalProperties: true
+          description: Configuration settings for the integration
+        credentials:
+          type: object
+          additionalProperties: true
+          description: Credentials for the integration
+        endpoints:
+          type: object
+          additionalProperties: true
+          description: API endpoints configuration
+        webhooks:
+          type: object
+          additionalProperties: true
+          description: Webhook configuration
+        sync_settings:
+          type: object
+          additionalProperties: true
+          description: Synchronization settings
+        last_sync:
+          type: string
+          format: date-time
+          description: Last synchronization timestamp
+        error_count:
+          type: number
+          description: Number of errors encountered
+        success_count:
+          type: number
+          description: Number of successful operations
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+        createdAt:
+          type: string
+          format: date-time
+          description: Creation timestamp
+        updatedAt:
+          type: string
+          format: date-time
+          description: Last update timestamp
+        __v:
+          type: number
+          description: Version number
+    IntegrationAppCreateBody:
+      type: object
+      description: Body for creating an integration app
+      required:
+        - name
+        - available_app
+        - company_namespace
+      properties:
+        name:
+          type: string
+          description: Name of the integration app
+        description:
+          type: string
+          description: Description of the integration app
+        available_app:
+          type: string
+          description: Available app reference
+        company_namespace:
+          type: string
+          description: Company namespace
+        config:
+          type: object
+          additionalProperties: true
+          description: Configuration settings for the integration
+        credentials:
+          type: object
+          additionalProperties: true
+          description: Credentials for the integration
+        endpoints:
+          type: object
+          additionalProperties: true
+          description: API endpoints configuration
+        webhooks:
+          type: object
+          additionalProperties: true
+          description: Webhook configuration
+        sync_settings:
+          type: object
+          additionalProperties: true
+          description: Synchronization settings
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+    IntegrationAppCreateResult:
+      $ref: "#/components/schemas/IntegrationAppSchema"
+      description: Result of creating an integration app
+    IntegrationAppGetResult:
+      $ref: "#/components/schemas/IntegrationAppSchema"
+      description: Result of getting an integration app
+    IntegrationAppUpdateBody:
+      type: object
+      description: Body for updating an integration app
+      properties:
+        name:
+          type: string
+          description: Name of the integration app
+        description:
+          type: string
+          description: Description of the integration app
+        status:
+          type: string
+          enum: [active, inactive, pending]
+          description: Status of the integration app
+        config:
+          type: object
+          additionalProperties: true
+          description: Configuration settings for the integration
+        credentials:
+          type: object
+          additionalProperties: true
+          description: Credentials for the integration
+        endpoints:
+          type: object
+          additionalProperties: true
+          description: API endpoints configuration
+        webhooks:
+          type: object
+          additionalProperties: true
+          description: Webhook configuration
+        sync_settings:
+          type: object
+          additionalProperties: true
+          description: Synchronization settings
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+    IntegrationAppUpdateResult:
+      $ref: "#/components/schemas/IntegrationAppSchema"
+      description: Result of updating an integration app