@ikonintegration/module-contractor-api 1.0.16 → 1.0.18

package/dist/Api.d.ts

@@ -5,60 +5,6 @@ export interface ErrorResponse {
     /** Error code */
     errCode: string;
 }
-export interface CreateCodeSchema {
-    /** Unique code identifier (1-50 alphanumeric characters) */
-    codeID: CodeIDSchema;
-    /**
-     * ID of the department this code belongs to
-     * @minLength 1
-     * @example "DEPT-2a1b3c4d5e6f"
-     */
-    departmentID: string;
-    /**
-     * Description of the code (1-255 characters)
-     * @minLength 1
-     * @maxLength 255
-     * @example "Consulting services for safety audits"
-     */
-    description: string;
-}
-/**
- * Unique code identifier (1-50 alphanumeric characters)
- * @minLength 1
- * @maxLength 50
- * @pattern ^[a-zA-Z0-9]+$
- * @example "ACC001"
- */
-export type CodeIDSchema = string;
-/** Created code */
-export interface PostCodeResponseSchema {
-    /** Code identifier */
-    codeID: string;
-    /** Associated department ID */
-    departmentID: string;
-    /** Code description */
-    description: string;
-}
-export interface UpdateCodeSchema {
-    /**
-     * Updated description of the code (1-255 characters)
-     * @minLength 1
-     * @maxLength 255
-     * @example "Updated consulting services description"
-     */
-    description: string;
-}
-/** Updated code */
-export interface PutCodeResponseSchema {
-    /** Code identifier */
-    codeID: string;
-    /** Associated department ID */
-    departmentID: string;
-    /** Updated code description */
-    description: string;
-}
-/** Code deletion result (empty body) */
-export type DeleteCodeResponseSchema = object;
 /** Codes list */
 export interface GetCodesResponseSchema {
     /** List of codes */
@@ -948,17 +894,17 @@ export interface UpdateSubmissionSchema {
     contractNumber?: string;
     /** PO number (optional) */
     poNumber?: string;
-    /**
-     * Department ID
-     * @minLength 1
-     */
-    departmentID?: string;
     /** Updated service invoice line items */
     invoices?: UpdateInvoiceInputSchema[];
     /** Updated expense reimbursement line items */
-    expenses?: ExpenseInputSchema[];
+    expenses?: UpdateExpenseInputSchema[];
 }
 export interface UpdateInvoiceInputSchema {
+    /**
+     * Existing invoice ID (omit to create new)
+     * @example "INV-abc123"
+     */
+    invoiceID?: string;
     /**
      * Invoice description
      * @minLength 1
@@ -989,10 +935,69 @@ export interface UpdateInvoiceInputSchema {
      * @example "PO-1234"
      */
     poNumber?: string;
+    /** File attachments for this invoice */
+    attachments?: AttachmentSchema[];
+}
+export interface UpdateExpenseInputSchema {
     /**
-     * File attachments for this invoice
-     * @default []
+     * Existing expense ID (omit to create new)
+     * @example "EXP-abc123"
      */
+    expenseID?: string;
+    /**
+     * Expense description
+     * @minLength 1
+     * @example "Hotel stay"
+     */
+    description: string;
+    /**
+     * Expense date (epoch ms)
+     * @example 1700000000000
+     */
+    date: number;
+    /**
+     * Expense type
+     * @example "Accommodation"
+     */
+    type: UpdateExpenseInputSchemaTypeEnum;
+    /**
+     * Pre-tax amount
+     * @min 0
+     * @example 150
+     */
+    preTaxAmount: number;
+    /**
+     * Tax amount
+     * @min 0
+     * @default 0
+     * @example 7.5
+     */
+    taxAmount?: number;
+    /**
+     * Number of nights (Accommodation)
+     * @min 0
+     * @exclusiveMin true
+     * @example 2
+     */
+    nights?: number;
+    /**
+     * Meal type (Meal expenses)
+     * @example "Lunch"
+     */
+    mealType?: UpdateExpenseInputSchemaMealTypeEnum;
+    /**
+     * Number of kilometres (Mileage)
+     * @min 0
+     * @exclusiveMin true
+     * @example 100
+     */
+    numKilometres?: number;
+    /**
+     * Transportation type (Transportation expenses)
+     * @example "Taxi"
+     */
+    transportationType?: UpdateExpenseInputSchemaTransportationTypeEnum;
+    /** File attachments for this expense */
     attachments?: AttachmentSchema[];
 }
 /** Updated submission */
@@ -1036,6 +1041,34 @@ export interface PostApproveResponseSchema {
     /** New submission status after approval */
     status: string;
 }
+export interface CreateSubmissionCodeSchema {
+    /**
+     * Description of the code (1-255 characters)
+     * @minLength 1
+     * @maxLength 255
+     * @example "Consulting services for safety audits"
+     */
+    description: string;
+}
+export interface SubmissionCodeMutationResponseSchema {
+    /** Code identifier */
+    codeID: string;
+    /** Derived department ID */
+    departmentID: string;
+    /** Code description */
+    description: string;
+}
+export interface UpdateSubmissionCodeSchema {
+    /**
+     * Description of the code (1-255 characters)
+     * @minLength 1
+     * @maxLength 255
+     * @example "Consulting services for safety audits"
+     */
+    description: string;
+}
+/** Deletion result (empty body) */
+export type DeleteSubmissionCodeResponseSchema = object;
 export interface PutSubmissionCodesSchema {
     /** Array of codes to assign to the submission sections */
     codes: SubmissionCodeItemSchema[];
@@ -1149,6 +1182,16 @@ export interface PostReassignResponseSchema {
     /** Reassignment confirmation */
     reassigned: boolean;
 }
+/** Rejection reason payload */
+export interface PostRejectBodySchema {
+    /**
+     * Reason for rejecting the submission
+     * @minLength 1
+     * @maxLength 500
+     * @example "Missing supporting documentation"
+     */
+    reason: string;
+}
 /** Rejection result */
 export interface PostRejectResponseSchema {
     /** Submission ID */
@@ -1455,6 +1498,37 @@ export declare enum UpdateSubmissionSchemaTypeEnum {
     Submission = "Submission",
     Reimbursement = "Reimbursement"
 }
+/**
+ * Expense type
+ * @example "Accommodation"
+ */
+export declare enum UpdateExpenseInputSchemaTypeEnum {
+    Accommodation = "Accommodation",
+    Meal = "Meal",
+    Mileage = "Mileage",
+    Transportation = "Transportation",
+    Other = "Other"
+}
+/**
+ * Meal type (Meal expenses)
+ * @example "Lunch"
+ */
+export declare enum UpdateExpenseInputSchemaMealTypeEnum {
+    Breakfast = "Breakfast",
+    Lunch = "Lunch",
+    Dinner = "Dinner"
+}
+/**
+ * Transportation type (Transportation expenses)
+ * @example "Taxi"
+ */
+export declare enum UpdateExpenseInputSchemaTransportationTypeEnum {
+    AirTravel = "Air travel",
+    Taxi = "Taxi",
+    Ferry = "Ferry",
+    Rental = "Rental",
+    Other = "Other"
+}
 /** Content type */
 export declare enum GetPdfResponseSchemaContentTypeEnum {
     ApplicationPdf = "application/pdf"
@@ -1466,12 +1540,13 @@ export declare enum GetPdfResponseSchemaContentTypeEnum {
 export declare enum GuestFileMetadataSchemaContentTypeEnum {
     ApplicationPdf = "application/pdf"
 }
-export type CreateCodeData = PostCodeResponseSchema;
-export type CreateCodeError = ErrorResponse;
-export type UpdateCodeData = PutCodeResponseSchema;
-export type UpdateCodeError = ErrorResponse;
-export type DeleteCodeData = DeleteCodeResponseSchema;
-export type DeleteCodeError = ErrorResponse;
+export interface ListCodesParams {
+    /**
+     * Filter codes by department. If omitted, all codes are returned.
+     * @example "DEPT_abc123"
+     */
+    departmentID?: string;
+}
 export type ListCodesData = GetCodesResponseSchema;
 export type ListCodesError = ErrorResponse;
 export type CreateSearchData = CodeSearchResponse;
@@ -1541,6 +1616,12 @@ export interface GetSubmissionParams {
      * @example "true"
      */
     consistentRead?: ConsistentReadEnum;
+    /**
+     * Owner user identifier (submission partition key)
+     * @minLength 1
+     * @example "USR-2RvYIFNJR3CrJHKO0NqgGa1EwcS"
+     */
+    userId: string;
     /**
      * Submission identifier
      * @minLength 1
@@ -1572,6 +1653,12 @@ export type DeleteSubmissionData = DeleteSubmissionResponseSchema;
 export type DeleteSubmissionError = ErrorResponse;
 export type CreateApproveData = PostApproveResponseSchema;
 export type CreateApproveError = ErrorResponse;
+export type CreateCodeData = SubmissionCodeMutationResponseSchema;
+export type CreateCodeError = ErrorResponse;
+export type UpdateCodeData = SubmissionCodeMutationResponseSchema;
+export type UpdateCodeError = ErrorResponse;
+export type DeleteCodeData = DeleteSubmissionCodeResponseSchema;
+export type DeleteCodeError = ErrorResponse;
 export type UpdateCodesData = PutSubmissionCodesResponseSchema;
 export type UpdateCodesError = ErrorResponse;
 export type CreateFileData = PostFileResponseSchema;
@@ -1678,7 +1765,7 @@ export declare enum ListSubmissionsParams1TypeEnum {
 }
 export type ListExportData = GetSubmissionsExportResponseSchema;
 export type ListExportError = ErrorResponse;
-export type CreateSearchOutput1 = SubmissionSearchResponse;
+export type CreateSearchData1 = SubmissionSearchResponse;
 export type CreateSearchErrorData = ErrorResponse;
 import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
 export type QueryParamsType = Record<string | number, any>;
@@ -1723,43 +1810,11 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Contractor Module API
- * @version 1.0.16
+ * @version 1.0.18
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
-    code: {
-        /**
-         * @description Creates a new charging code associated with a department. Only Super Administrators can create codes.
-         *
-         * @tags Codes
-         * @name CreateCode
-         * @summary Create Code
-         * @request POST:/code
-         * @secure
-         */
-        createCode: (data: CreateCodeSchema, params?: RequestParams) => Promise<PostCodeResponseSchema>;
-        /**
-         * @description Updates an existing charging code description. Only Super Administrators can update codes.
-         *
-         * @tags Codes
-         * @name UpdateCode
-         * @summary Update Code
-         * @request PUT:/code/{codeID}
-         * @secure
-         */
-        updateCode: (codeId: string, data: UpdateCodeSchema, params?: RequestParams) => Promise<PutCodeResponseSchema>;
-        /**
-         * @description Deletes a charging code. Prevents deletion if the code is referenced by existing submissions. Only Super Administrators can delete codes.
-         *
-         * @tags Codes
-         * @name DeleteCode
-         * @summary Delete Code
-         * @request DELETE:/code/{codeID}
-         * @secure
-         */
-        deleteCode: (codeId: string, params?: RequestParams) => Promise<object>;
-    };
     codes: {
         /**
          * @description Returns all codes or codes filtered by department. Administrators and above can list codes.
@@ -1770,7 +1825,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/codes
          * @secure
          */
-        listCodes: (params?: RequestParams) => Promise<GetCodesResponseSchema>;
+        listCodes: (query: ListCodesParams, params?: RequestParams) => Promise<GetCodesResponseSchema>;
         /**
          * @description Search billing codes by description and code ID.
          *
@@ -1914,7 +1969,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     settings: {
         /**
-         * @description Retrieves system settings. Administrators have read-only access. Super Administrators have full access.
+         * @description Retrieves system settings. Administrators and users have read-only access. Super Administrators have full access.
          *
          * @tags Settings
          * @name ListSettings
@@ -1936,145 +1991,175 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     submission: {
         /**
-         * @description Creates a new draft submission for the authenticated contractor. Validates invoice number uniqueness, calculates totals, and validates expenses against configured maximums.
+         * @description Creates a new draft submission for the specified contractor. Validates invoice number uniqueness, calculates totals, and validates expenses against configured maximums. USER callers can only create for themselves; ADMIN/SYSADMIN can create on behalf of a contractor.
          *
          * @tags Submissions
          * @name CreateSubmission
          * @summary Create draft submission
-         * @request POST:/submission
+         * @request POST:/submission/{userID}
          * @secure
          */
-        createSubmission: (data: CreateSubmissionSchema, params?: RequestParams) => Promise<PostSubmissionResponseSchema>;
+        createSubmission: (userId: string, data: CreateSubmissionSchema, params?: RequestParams) => Promise<PostSubmissionResponseSchema>;
         /**
          * @description Returns a single submission with all invoices, expenses, and assigned codes in a single DynamoDB query using an ElectroDB collection. Access is scoped by role: contractors see only their own, admins see their department, accountants/superadmins see any.
          *
          * @tags Submissions
          * @name GetSubmission
          * @summary View submission detail
-         * @request GET:/submission/{submissionID}
+         * @request GET:/submission/{userID}/{submissionID}
          * @secure
          */
-        getSubmission: ({ submissionId, ...query }: GetSubmissionParams, params?: RequestParams) => Promise<GetSubmissionResponseSchema>;
+        getSubmission: ({ userId, submissionId, ...query }: GetSubmissionParams, params?: RequestParams) => Promise<GetSubmissionResponseSchema>;
         /**
          * @description Updates an existing submission. Edit permissions are determined by the caller role and the submission status. Contractors can fully edit Draft/Rejected submissions and update only PO on Submitted/Administrator_Approved. Admins can edit non-calculated fields on non-Paid submissions. Recalculates totals when line items change.
          *
          * @tags Submissions
          * @name UpdateSubmission
          * @summary Update submission
-         * @request PUT:/submission/{submissionID}
+         * @request PUT:/submission/{userID}/{submissionID}
          * @secure
          */
-        updateSubmission: (submissionId: string, data: UpdateSubmissionSchema, params?: RequestParams) => Promise<PutSubmissionResponseSchema>;
+        updateSubmission: (userId: string, submissionId: string, data: UpdateSubmissionSchema, params?: RequestParams) => Promise<PutSubmissionResponseSchema>;
         /**
          * @description Deletes a submission and all related invoices, expenses, and codes. Admin/SuperAdmin only. Cannot delete paid submissions. Notifies the contractor and any reviewing accountant.
          *
          * @tags Submissions
          * @name DeleteSubmission
          * @summary Delete submission
-         * @request DELETE:/submission/{submissionID}
+         * @request DELETE:/submission/{userID}/{submissionID}
          * @secure
          */
-        deleteSubmission: (submissionId: string, params?: RequestParams) => Promise<DeleteSubmissionResponseSchema>;
+        deleteSubmission: (userId: string, submissionId: string, params?: RequestParams) => Promise<DeleteSubmissionResponseSchema>;
         /**
          * @description Admin: transitions Submitted → Administrator_Approved (notifies accountants + contractor). Accountant: transitions Administrator_Approved → Payment_Pending (notifies contractor).
          *
          * @tags Submissions
          * @name CreateApprove
          * @summary Approve a submission
-         * @request POST:/submission/{submissionID}/approve
+         * @request POST:/submission/{userID}/{submissionID}/approve
+         * @secure
+         */
+        createApprove: (userId: string, submissionId: string, params?: RequestParams) => Promise<PostApproveResponseSchema>;
+        /**
+         * @description Creates a new billing code bound to the parent submission's department. The codeID is System-generated and the departmentID is derived from the submission, so neither is taken from the request. Admin only.
+         *
+         * @tags Submissions
+         * @name CreateCode
+         * @summary Create code on submission
+         * @request POST:/submission/{userID}/{submissionID}/code
+         * @secure
+         */
+        createCode: (userId: string, submissionId: string, data: CreateSubmissionCodeSchema, params?: RequestParams) => Promise<SubmissionCodeMutationResponseSchema>;
+        /**
+         * @description Updates the description of a billing code addressed by codeID and derived from the parent submission's department. Admin only.
+         *
+         * @tags Submissions
+         * @name UpdateCode
+         * @summary Update a submission code
+         * @request PUT:/submission/{userID}/{submissionID}/code/{codeID}
+         * @secure
+         */
+        updateCode: (userId: string, submissionId: string, codeId: string, data: UpdateSubmissionCodeSchema, params?: RequestParams) => Promise<SubmissionCodeMutationResponseSchema>;
+        /**
+         * @description Deletes a billing code owned by the submission's department. The owning departmentID is derived from the parent submission. Fails if the code is still referenced by any submission. Admin only.
+         *
+         * @tags Submissions
+         * @name DeleteCode
+         * @summary Delete a code from a submission
+         * @request DELETE:/submission/{userID}/{submissionID}/code/{codeID}
          * @secure
          */
-        createApprove: (submissionId: string, params?: RequestParams) => Promise<PostApproveResponseSchema>;
+        deleteCode: (userId: string, submissionId: string, codeId: string, params?: RequestParams) => Promise<object>;
         /**
          * @description Assigns codes to Service and/or Reimbursement sections of a submission with optional notes. Only codes belonging to the submission's assigned department are allowed. Admin only.
          *
          * @tags Submissions
          * @name UpdateCodes
          * @summary Assign codes to submission sections
-         * @request PUT:/submission/{submissionID}/codes
+         * @request PUT:/submission/{userID}/{submissionID}/codes
          * @secure
          */
-        updateCodes: (submissionId: string, data: PutSubmissionCodesSchema, params?: RequestParams) => Promise<PutSubmissionCodesResponseSchema>;
+        updateCodes: (userId: string, submissionId: string, data: PutSubmissionCodesSchema, params?: RequestParams) => Promise<PutSubmissionCodesResponseSchema>;
         /**
          * @description Validates file constraints (size, type, count) and returns a presigned IKFS URL for uploading a file attachment to a submission line item. Max 10 MB, max 5 files per line item.
          *
          * @tags Submissions
          * @name CreateFile
          * @summary Get presigned upload URL for a file attachment
-         * @request POST:/submission/{submissionID}/file
+         * @request POST:/submission/{userID}/{submissionID}/file
          * @secure
          */
-        createFile: (submissionId: string, data: FileUploadRequestSchema, params?: RequestParams) => Promise<PostFileResponseSchema>;
+        createFile: (userId: string, submissionId: string, data: FileUploadRequestSchema, params?: RequestParams) => Promise<PostFileResponseSchema>;
         /**
          * @description Returns a presigned IKFS URL for downloading a file attachment associated with a submission line item.
          *
          * @tags Submissions
          * @name GetFile
          * @summary Get presigned download URL for a file attachment
-         * @request GET:/submission/{submissionID}/file/{fileID}
+         * @request GET:/submission/{userID}/{submissionID}/file/{fileID}
          * @secure
          */
-        getFile: (submissionId: string, fileId: string, params?: RequestParams) => Promise<GetFileResponseSchema>;
+        getFile: (userId: string, submissionId: string, fileId: string, params?: RequestParams) => Promise<GetFileResponseSchema>;
         /**
          * @description Transitions a Payment_Pending submission to Paid. Only Accountants may perform this action. Notifies the approving administrator.
          *
          * @tags Submissions
          * @name CreatePaid
          * @summary Mark a submission as paid
-         * @request POST:/submission/{submissionID}/paid
+         * @request POST:/submission/{userID}/{submissionID}/paid
          * @secure
          */
-        createPaid: (submissionId: string, params?: RequestParams) => Promise<PostPaidResponseSchema>;
+        createPaid: (userId: string, submissionId: string, params?: RequestParams) => Promise<PostPaidResponseSchema>;
         /**
          * @description Generates and returns a PDF summary of the submission including invoices, expenses, and assigned codes. Returns the PDF as a base64-encoded string.
          *
          * @tags Submissions
          * @name GetPdf
          * @summary Generate submission summary PDF
-         * @request GET:/submission/{submissionID}/pdf
+         * @request GET:/submission/{userID}/{submissionID}/pdf
          * @secure
          */
-        getPdf: (submissionId: string, params?: RequestParams) => Promise<GetPDFResponseSchema>;
+        getPdf: (userId: string, submissionId: string, params?: RequestParams) => Promise<GetPDFResponseSchema>;
         /**
          * @description Updates the PO number on a submission. Contractors can update PO on Submitted or Administrator_Approved submissions. Admins can update PO on any non-Paid submission.
          *
          * @tags Submissions
          * @name PutSubmission
          * @summary Update submission PO number
-         * @request PUT:/submission/{submissionID}/po
+         * @request PUT:/submission/{userID}/{submissionID}/po
          * @secure
          */
-        putSubmission: (submissionId: string, data: UpdatePOSchema, params?: RequestParams) => Promise<PutPOResponseSchema>;
+        putSubmission: (userId: string, submissionId: string, data: UpdatePOSchema, params?: RequestParams) => Promise<PutPOResponseSchema>;
         /**
          * @description Reassigns a submission to a new department. Removes all codes from the original department. Notifies new department admins and the contractor. Admin/SuperAdmin only.
          *
          * @tags Submissions
          * @name CreateReassign
          * @summary Reassign submission to a different department
-         * @request POST:/submission/{submissionID}/reassign
+         * @request POST:/submission/{userID}/{submissionID}/reassign
          * @secure
          */
-        createReassign: (submissionId: string, data: ReassignSubmissionSchema, params?: RequestParams) => Promise<PostReassignResponseSchema>;
+        createReassign: (userId: string, submissionId: string, data: ReassignSubmissionSchema, params?: RequestParams) => Promise<PostReassignResponseSchema>;
         /**
-         * @description Admin rejects a Submitted submission; Accountant rejects an Administrator_Approved submission. RSA-sourced submissions cannot be rejected. Notifies the contractor.
+         * @description Admin rejects a Submitted submission; Accountant rejects an Administrator_Approved submission. RSA-sourced submissions cannot be rejected. Notifies the contractor with the provided reason.
          *
          * @tags Submissions
          * @name CreateReject
          * @summary Reject a submission
-         * @request POST:/submission/{submissionID}/reject
+         * @request POST:/submission/{userID}/{submissionID}/reject
          * @secure
          */
-        createReject: (submissionId: string, params?: RequestParams) => Promise<PostRejectResponseSchema>;
+        createReject: (userId: string, submissionId: string, data: PostRejectBodySchema, params?: RequestParams) => Promise<PostRejectResponseSchema>;
         /**
          * @description Transitions a Draft or Rejected submission to Submitted. Only the owning contractor may submit. Routes the submission to department administrators and sends notifications.
          *
          * @tags Submissions
          * @name CreateSubmit
          * @summary Submit a draft or rejected submission
-         * @request POST:/submission/{submissionID}/submit
+         * @request POST:/submission/{userID}/{submissionID}/submit
          * @secure
          */
-        createSubmit: (submissionId: string, params?: RequestParams) => Promise<PostSubmitResponseSchema>;
+        createSubmit: (userId: string, submissionId: string, params?: RequestParams) => Promise<PostSubmitResponseSchema>;
         /**
          * @description Public endpoint for guest contractors to submit a single invoice without authentication. Requires reCAPTCHA verification. The submission goes directly to Submitted status (no Draft). When file metadata is provided, the response includes a presigned upload URL for the frontend to PUT the file to.
          *