repzo 1.0.155 → 1.0.157

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

@@ -0,0 +1,573 @@
+openapi: 3.0.0
+info:
+  title: Return Asset Part Unit API
+  description: API for managing returns of asset part units
+  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: Return Asset Part Unit
+    description: Operations related to returning asset part units
+
+paths:
+  /return-asset-part-unit:
+    get:
+      tags:
+        - Return Asset Part Unit
+      summary: Get all asset part unit returns
+      description: Retrieve a list of all asset part unit returns 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 unit returns retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/ReturnAssetPartUnit"
+                  total:
+                    type: integer
+                    description: Total number of records
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    post:
+      tags:
+        - Return Asset Part Unit
+      summary: Create a new asset part unit return
+      description: Create a new asset part unit return with the provided data
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ReturnAssetPartUnitInput"
+      responses:
+        "201":
+          description: Asset part unit return created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ReturnAssetPartUnit"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /return-asset-part-unit/{id}:
+    get:
+      tags:
+        - Return Asset Part Unit
+      summary: Get asset part unit return by ID
+      description: Retrieve a specific asset part unit return by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part unit return ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part unit return retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ReturnAssetPartUnit"
+        "404":
+          description: Asset part unit return not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    put:
+      tags:
+        - Return Asset Part Unit
+      summary: Update asset part unit return
+      description: Update an existing asset part unit return with new data
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part unit return ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ReturnAssetPartUnitInput"
+      responses:
+        "200":
+          description: Asset part unit return updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ReturnAssetPartUnit"
+        "400":
+          description: Bad request
+        "404":
+          description: Asset part unit return not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    delete:
+      tags:
+        - Return Asset Part Unit
+      summary: Delete asset part unit return
+      description: Delete an existing asset part unit return
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part unit return ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part unit return deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  message:
+                    type: string
+                    example: Asset part unit return deleted successfully
+        "404":
+          description: Asset part unit return not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    ReturnAssetPartUnit:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the return
+          example: "60f7b1b3e4b0e8b3f8b3f8b3"
+        returnNumber:
+          type: string
+          description: Unique return number
+          example: "RET-2023-001"
+        assetPartUnit:
+          type: string
+          description: Asset part unit ID being returned
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        serialNumber:
+          type: string
+          description: Serial number of the part unit
+          example: "SN-EP001-2023-001"
+        returnType:
+          type: string
+          enum: [warranty, defective, excess, end-of-lease, maintenance]
+          description: Type of return
+          example: "defective"
+        returnReason:
+          type: string
+          description: Reason for return
+          example: "Part failed after 30 days of use"
+        returnedBy:
+          type: string
+          description: User who initiated the return
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        authorizedBy:
+          type: string
+          description: User who authorized the return
+          example: "60f7b1b3e4b0e8b3f8b3f8b6"
+        returnDate:
+          type: string
+          format: date-time
+          description: Date when the return was processed
+          example: "2023-01-15T10:00:00Z"
+        requestDate:
+          type: string
+          format: date-time
+          description: Date when the return was requested
+          example: "2023-01-14T10:00:00Z"
+        originalInstallDate:
+          type: string
+          format: date-time
+          description: Original installation date
+          example: "2023-01-01T10:00:00Z"
+        originalWorkOrder:
+          type: string
+          description: Original work order ID
+          example: "60f7b1b3e4b0e8b3f8b3f8b7"
+        originalAsset:
+          type: string
+          description: Original asset ID where it was installed
+          example: "60f7b1b3e4b0e8b3f8b3f8b8"
+        status:
+          type: string
+          enum:
+            [
+              requested,
+              approved,
+              in-transit,
+              received,
+              processed,
+              completed,
+              rejected,
+            ]
+          default: requested
+          description: Status of the return
+        condition:
+          type: string
+          enum: [new, good, fair, poor, damaged, defective]
+          description: Condition of the returned part
+          example: "defective"
+        returnLocation:
+          type: object
+          properties:
+            warehouse:
+              type: string
+              description: Warehouse where part is returned
+            section:
+              type: string
+              description: Section within warehouse
+            shelf:
+              type: string
+              description: Shelf identifier
+            position:
+              type: string
+              description: Position on shelf
+        supplier:
+          type: string
+          description: Supplier ID if returning to supplier
+        creditAmount:
+          type: number
+          format: double
+          minimum: 0
+          description: Credit amount for the return
+        currency:
+          type: string
+          description: Currency code
+          example: "USD"
+        replacementRequired:
+          type: boolean
+          default: false
+          description: Whether a replacement is required
+        replacementPartUnit:
+          type: string
+          description: Replacement part unit ID if applicable
+        warrantyStatus:
+          type: string
+          enum: [in-warranty, out-of-warranty, extended-warranty]
+          description: Warranty status at time of return
+        qualityInspection:
+          type: object
+          properties:
+            performed:
+              type: boolean
+              default: false
+              description: Whether quality inspection was performed
+            inspectedBy:
+              type: string
+              description: User who performed inspection
+            inspectionDate:
+              type: string
+              format: date-time
+              description: Inspection date
+            findings:
+              type: string
+              description: Inspection findings
+            disposition:
+              type: string
+              enum: [scrap, rework, return-to-supplier, restock]
+              description: Disposition based on inspection
+        documents:
+          type: array
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+              url:
+                type: string
+                format: uri
+              type:
+                type: string
+                enum: [return-authorization, photo, inspection-report, other]
+        notes:
+          type: string
+          description: Additional notes
+        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:
+        - returnNumber
+        - assetPartUnit
+        - returnType
+        - returnReason
+        - returnedBy
+
+    ReturnAssetPartUnitInput:
+      type: object
+      properties:
+        returnNumber:
+          type: string
+          description: Unique return number
+          example: "RET-2023-001"
+        assetPartUnit:
+          type: string
+          description: Asset part unit ID being returned
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        serialNumber:
+          type: string
+          description: Serial number of the part unit
+          example: "SN-EP001-2023-001"
+        returnType:
+          type: string
+          enum: [warranty, defective, excess, end-of-lease, maintenance]
+          description: Type of return
+          example: "defective"
+        returnReason:
+          type: string
+          description: Reason for return
+          example: "Part failed after 30 days of use"
+        returnedBy:
+          type: string
+          description: User who initiated the return
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        authorizedBy:
+          type: string
+          description: User who authorized the return
+          example: "60f7b1b3e4b0e8b3f8b3f8b6"
+        returnDate:
+          type: string
+          format: date-time
+          description: Date when the return was processed
+          example: "2023-01-15T10:00:00Z"
+        requestDate:
+          type: string
+          format: date-time
+          description: Date when the return was requested
+          example: "2023-01-14T10:00:00Z"
+        originalInstallDate:
+          type: string
+          format: date-time
+          description: Original installation date
+          example: "2023-01-01T10:00:00Z"
+        originalWorkOrder:
+          type: string
+          description: Original work order ID
+          example: "60f7b1b3e4b0e8b3f8b3f8b7"
+        originalAsset:
+          type: string
+          description: Original asset ID where it was installed
+          example: "60f7b1b3e4b0e8b3f8b3f8b8"
+        status:
+          type: string
+          enum:
+            [
+              requested,
+              approved,
+              in-transit,
+              received,
+              processed,
+              completed,
+              rejected,
+            ]
+          default: requested
+          description: Status of the return
+        condition:
+          type: string
+          enum: [new, good, fair, poor, damaged, defective]
+          description: Condition of the returned part
+          example: "defective"
+        returnLocation:
+          type: object
+          properties:
+            warehouse:
+              type: string
+              description: Warehouse where part is returned
+            section:
+              type: string
+              description: Section within warehouse
+            shelf:
+              type: string
+              description: Shelf identifier
+            position:
+              type: string
+              description: Position on shelf
+        supplier:
+          type: string
+          description: Supplier ID if returning to supplier
+        creditAmount:
+          type: number
+          format: double
+          minimum: 0
+          description: Credit amount for the return
+        currency:
+          type: string
+          description: Currency code
+          example: "USD"
+        replacementRequired:
+          type: boolean
+          default: false
+          description: Whether a replacement is required
+        replacementPartUnit:
+          type: string
+          description: Replacement part unit ID if applicable
+        warrantyStatus:
+          type: string
+          enum: [in-warranty, out-of-warranty, extended-warranty]
+          description: Warranty status at time of return
+        qualityInspection:
+          type: object
+          properties:
+            performed:
+              type: boolean
+              default: false
+              description: Whether quality inspection was performed
+            inspectedBy:
+              type: string
+              description: User who performed inspection
+            inspectionDate:
+              type: string
+              format: date-time
+              description: Inspection date
+            findings:
+              type: string
+              description: Inspection findings
+            disposition:
+              type: string
+              enum: [scrap, rework, return-to-supplier, restock]
+              description: Disposition based on inspection
+        documents:
+          type: array
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+              url:
+                type: string
+                format: uri
+              type:
+                type: string
+                enum: [return-authorization, photo, inspection-report, other]
+        notes:
+          type: string
+          description: Additional notes
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+      required:
+        - returnNumber
+        - assetPartUnit
+        - returnType
+        - returnReason
+        - returnedBy
+
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
+
+security:
+  - ApiKeyAuth: []