repzo 1.0.155 → 1.0.157

package/src/oas/asset-part-unit.yaml

@@ -0,0 +1,722 @@
+openapi: 3.0.0
+info:
+  title: Asset Part Unit API
+  description: API for managing asset part units (individual instances of parts)
+  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: Asset Part Unit
+    description: Operations related to asset part unit management
+
+paths:
+  /asset-part-unit:
+    get:
+      tags:
+        - Asset Part Unit
+      summary: Get all asset part units
+      description: Retrieve a list of all asset part units 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 asset part units retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/AssetPartUnit"
+                  total:
+                    type: integer
+                    description: Total number of records
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    post:
+      tags:
+        - Asset Part Unit
+      summary: Create a new asset part unit
+      description: Create a new asset part unit with the provided data
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AssetPartUnitInput"
+      responses:
+        "201":
+          description: Asset part unit created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartUnit"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /asset-part-unit/{id}:
+    get:
+      tags:
+        - Asset Part Unit
+      summary: Get asset part unit by ID
+      description: Retrieve a specific asset part unit by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part unit ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part unit retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartUnit"
+        "404":
+          description: Asset part unit not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    put:
+      tags:
+        - Asset Part Unit
+      summary: Update asset part unit
+      description: Update an existing asset part unit with new data
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part unit ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AssetPartUnitInput"
+      responses:
+        "200":
+          description: Asset part unit updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartUnit"
+        "400":
+          description: Bad request
+        "404":
+          description: Asset part unit not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    delete:
+      tags:
+        - Asset Part Unit
+      summary: Delete asset part unit
+      description: Delete an existing asset part unit
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part unit ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part unit deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  message:
+                    type: string
+                    example: Asset part unit deleted successfully
+        "404":
+          description: Asset part unit not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    AssetPartUnit:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the asset part unit
+          example: "60f7b1b3e4b0e8b3f8b3f8b3"
+        creator:
+          type: object
+          description: User who created the record
+          properties:
+            _id:
+              type: string
+            type:
+              type: string
+              enum: [admin, rep]
+            name:
+              type: string
+        editor:
+          type: object
+          description: User who last edited the record
+          properties:
+            _id:
+              type: string
+            type:
+              type: string
+              enum: [admin, rep]
+            name:
+              type: string
+        directional_status:
+          type: string
+          enum: [received, handed, picked, returned, stored]
+          description: Current directional status of the asset part unit
+        asset_part_receival:
+          type: string
+          description: Asset part receival ID
+        asset_part_return:
+          type: string
+          description: Asset part return ID (if applicable)
+        asset_part_index:
+          type: integer
+          description: Index of the asset part in the receival
+        splitted_from:
+          type: string
+          description: ID of the unit this was split from (if applicable)
+        client:
+          type: string
+          description: Client ID
+        client_name:
+          type: string
+          description: Name of the client
+        warehouse:
+          type: string
+          description: Warehouse ID
+        warehouse_name:
+          type: string
+          description: Name of the warehouse
+        receival_warehouse:
+          type: string
+          description: Receival warehouse ID
+        receival_warehouse_name:
+          type: string
+          description: Name of the receival warehouse
+        asset_part:
+          type: string
+          description: Asset part ID this unit belongs to
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        asset_part_name:
+          type: string
+          description: Name of the asset part
+        qty:
+          type: number
+          description: Quantity
+        custom_status:
+          type: string
+          description: Custom status ID
+        receival_comment:
+          type: string
+          description: Comment from receival
+        comment:
+          type: string
+          description: Additional comment
+        media:
+          type: array
+          items:
+            type: string
+          description: Array of media IDs
+        teams:
+          type: array
+          items:
+            type: string
+          description: Array of team IDs
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+        quotation_is_recommended:
+          type: boolean
+          description: Whether quotation is recommended
+        quotation_internal_approval_status:
+          type: string
+          enum: [pending, approved, completed, rejected]
+          description: Internal approval status for quotation
+        quotation_detail:
+          type: string
+          description: Quotation details
+        quotation_client_approval_status:
+          type: string
+          enum: [pending, approved, collected, rejected]
+          description: Client approval status for quotation
+        company_namespace:
+          type: array
+          items:
+            type: string
+          description: Company namespace
+        serialNumber:
+          type: string
+          description: Serial number of the part unit
+          example: "SN-EP001-2023-001"
+        batchNumber:
+          type: string
+          description: Batch number
+          example: "BATCH-2023-001"
+        lotNumber:
+          type: string
+          description: Lot number
+        manufactureDate:
+          type: string
+          format: date
+          description: Manufacturing date
+          example: "2023-01-15"
+        expiryDate:
+          type: string
+          format: date
+          description: Expiry date (if applicable)
+        receiptDate:
+          type: string
+          format: date-time
+          description: Date when the unit was received
+          example: "2023-01-20T10:00:00Z"
+        status:
+          type: string
+          enum: [available, reserved, in-use, maintenance, disposed, returned]
+          default: available
+          description: Current status of the part unit
+        condition:
+          type: string
+          enum: [new, good, fair, poor, damaged]
+          default: new
+          description: Physical condition of the part unit
+        location:
+          type: object
+          properties:
+            warehouse:
+              type: string
+              description: Warehouse ID
+            section:
+              type: string
+              description: Section within warehouse
+            shelf:
+              type: string
+              description: Shelf identifier
+            position:
+              type: string
+              description: Position on shelf
+        assignedTo:
+          type: object
+          properties:
+            asset:
+              type: string
+              description: Asset ID if installed
+            workOrder:
+              type: string
+              description: Work order ID if assigned
+            technician:
+              type: string
+              description: Technician ID if assigned
+            date:
+              type: string
+              format: date-time
+              description: Assignment date
+        installationDate:
+          type: string
+          format: date-time
+          description: Date when the unit was installed
+        lastMaintenanceDate:
+          type: string
+          format: date-time
+          description: Last maintenance date
+        nextMaintenanceDate:
+          type: string
+          format: date-time
+          description: Next scheduled maintenance date
+        warrantyExpiry:
+          type: string
+          format: date
+          description: Warranty expiry date
+        cost:
+          type: number
+          format: double
+          minimum: 0
+          description: Cost of this specific unit
+        supplier:
+          type: string
+          description: Supplier ID
+        purchaseOrder:
+          type: string
+          description: Purchase order reference
+        invoice:
+          type: string
+          description: Invoice reference
+        notes:
+          type: string
+          description: Additional notes
+        maintenanceHistory:
+          type: array
+          items:
+            type: object
+            properties:
+              date:
+                type: string
+                format: date-time
+              type:
+                type: string
+                enum: [inspection, repair, replacement, upgrade]
+              description:
+                type: string
+              technician:
+                type: string
+              cost:
+                type: number
+                format: double
+        customFields:
+          type: object
+          additionalProperties: true
+          description: Custom fields
+        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:
+        - directional_status
+        - asset_part_receival
+        - asset_part_index
+        - client
+        - client_name
+        - warehouse
+        - warehouse_name
+        - receival_warehouse
+        - receival_warehouse_name
+        - asset_part
+        - asset_part_name
+        - qty
+        - quotation_is_recommended
+        - quotation_internal_approval_status
+        - company_namespace
+
+    AssetPartUnitInput:
+      type: object
+      properties:
+        creator:
+          type: object
+          description: User who created the record
+          properties:
+            _id:
+              type: string
+            type:
+              type: string
+              enum: [admin, rep]
+            name:
+              type: string
+        directional_status:
+          type: string
+          enum: [received, handed, picked, returned, stored]
+          description: Current directional status of the asset part unit
+        asset_part_receival:
+          type: string
+          description: Asset part receival ID
+        asset_part_index:
+          type: integer
+          description: Index of the asset part in the receival
+        splitted_from:
+          type: string
+          description: ID of the unit this was split from (if applicable)
+        client:
+          type: string
+          description: Client ID
+        client_name:
+          type: string
+          description: Name of the client
+        warehouse:
+          type: string
+          description: Warehouse ID
+        warehouse_name:
+          type: string
+          description: Name of the warehouse
+        receival_warehouse:
+          type: string
+          description: Receival warehouse ID
+        receival_warehouse_name:
+          type: string
+          description: Name of the receival warehouse
+        asset_part:
+          type: string
+          description: Asset part ID this unit belongs to
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        asset_part_name:
+          type: string
+          description: Name of the asset part
+        qty:
+          type: number
+          description: Quantity
+        custom_status:
+          type: string
+          description: Custom status ID
+        receival_comment:
+          type: string
+          description: Comment from receival
+        comment:
+          type: string
+          description: Additional comment
+        media:
+          type: array
+          items:
+            type: string
+          description: Array of media IDs
+        teams:
+          type: array
+          items:
+            type: string
+          description: Array of team IDs
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+        quotation_is_recommended:
+          type: boolean
+          description: Whether quotation is recommended
+        quotation_internal_approval_status:
+          type: string
+          enum: [pending, approved, completed, rejected]
+          description: Internal approval status for quotation
+        quotation_detail:
+          type: string
+          description: Quotation details
+        quotation_client_approval_status:
+          type: string
+          enum: [pending, approved, collected, rejected]
+          description: Client approval status for quotation
+        company_namespace:
+          type: array
+          items:
+            type: string
+          description: Company namespace
+        serialNumber:
+          type: string
+          description: Serial number of the part unit
+          example: "SN-EP001-2023-001"
+        batchNumber:
+          type: string
+          description: Batch number
+          example: "BATCH-2023-001"
+        lotNumber:
+          type: string
+          description: Lot number
+        manufactureDate:
+          type: string
+          format: date
+          description: Manufacturing date
+          example: "2023-01-15"
+        expiryDate:
+          type: string
+          format: date
+          description: Expiry date (if applicable)
+        receiptDate:
+          type: string
+          format: date-time
+          description: Date when the unit was received
+          example: "2023-01-20T10:00:00Z"
+        status:
+          type: string
+          enum: [available, reserved, in-use, maintenance, disposed, returned]
+          default: available
+          description: Current status of the part unit
+        condition:
+          type: string
+          enum: [new, good, fair, poor, damaged]
+          default: new
+          description: Physical condition of the part unit
+        location:
+          type: object
+          properties:
+            warehouse:
+              type: string
+              description: Warehouse ID
+            section:
+              type: string
+              description: Section within warehouse
+            shelf:
+              type: string
+              description: Shelf identifier
+            position:
+              type: string
+              description: Position on shelf
+        assignedTo:
+          type: object
+          properties:
+            asset:
+              type: string
+              description: Asset ID if installed
+            workOrder:
+              type: string
+              description: Work order ID if assigned
+            technician:
+              type: string
+              description: Technician ID if assigned
+            date:
+              type: string
+              format: date-time
+              description: Assignment date
+        installationDate:
+          type: string
+          format: date-time
+          description: Date when the unit was installed
+        lastMaintenanceDate:
+          type: string
+          format: date-time
+          description: Last maintenance date
+        nextMaintenanceDate:
+          type: string
+          format: date-time
+          description: Next scheduled maintenance date
+        warrantyExpiry:
+          type: string
+          format: date
+          description: Warranty expiry date
+        cost:
+          type: number
+          format: double
+          minimum: 0
+          description: Cost of this specific unit
+        supplier:
+          type: string
+          description: Supplier ID
+        purchaseOrder:
+          type: string
+          description: Purchase order reference
+        invoice:
+          type: string
+          description: Invoice reference
+        notes:
+          type: string
+          description: Additional notes
+        customFields:
+          type: object
+          additionalProperties: true
+          description: Custom fields
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+      required:
+        - directional_status
+        - asset_part_receival
+        - asset_part_index
+        - client
+        - client_name
+        - warehouse
+        - receival_warehouse
+        - asset_part
+        - asset_part_name
+        - qty
+
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
+
+security:
+  - ApiKeyAuth: []