@kanda-libs/ks-schema 1.0.151 → 1.0.153

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kanda-libs/ks-schema",
-  "version": "1.0.151",
+  "version": "1.0.153",
   "description": "Kanda Service OpenAPI Schema",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/schema.yaml

@@ -1141,6 +1141,42 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
 
+  /api/job/{id}/override:
+    post:
+      operationId: overrideJob
+      summary: >
+        kanda staff to override a job status and trigger comms to be sent (if applicable),
+        only allowed when job is applied for finance or financed.
+      tags:
+        - Job
+      parameters:
+        - name: id
+          in: path
+          description: job id
+          required: true
+          schema:
+            type: string
+            minLength: 1
+      requestBody:
+        description: job override to be applied to job
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/JobOverride"
+      responses:
+        200:
+          description: got existing job with finance status set to paid
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Job"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+
   /api/job/{id}/companyInfo:
     post:
       operationId: jobCompanyInfo
@@ -3050,7 +3086,7 @@ components:
           title: Were you told about any potential feed in tariffs, savings, returns or Renewable Heat incentive and do you understand that the actual amounts  you  receive, and your estimated returns/savings were based on varying factors including you own energy consumption and any returns/savings/payback periods are not linked to your repayments on this agreement.
           enum:
             - "Yes I understand"
-            - "No I don't understand"
+            - "No I do not understand"
         signature:
           type: object
           title: sat note customer signature
@@ -3943,6 +3979,21 @@ components:
           title: source
           readOnly: true
 
+    JobOverride:
+      type: object
+      title: job override
+      required:
+        - action
+      properties:
+        action:
+          type: string
+          title: action
+          enum:
+            - "mark_job_as_pending"
+            - "mark_job_as_accepted"
+            - "mark_job_as_declined"
+            - "mark_job_as_cancelled"
+
     Error:
       type: object
       required: