@ikonintegration/module-contractor-api 1.0.1 → 1.0.2

package/dist/Api.d.ts

@@ -5,7 +5,7 @@ export interface ErrorResponse {
     /** Error code */
     errCode: string;
 }
-export interface Input5Sa03P3Swr {
+export interface InputEbucity1Z4 {
     /**
      * Unique code identifier (1-50 alphanumeric characters)
      * @minLength 1
@@ -28,7 +28,7 @@ export interface Input5Sa03P3Swr {
      */
     description: string;
 }
-export interface Input6Szg153Vfz {
+export interface InputLrvyo8663G {
     /**
      * Updated description of the code (1-255 characters)
      * @minLength 1
@@ -37,7 +37,7 @@ export interface Input6Szg153Vfz {
      */
     description: string;
 }
-export interface InputWt47Z10Aoc {
+export interface InputX0At7Jc9N {
     /**
      * Full name of the contractor
      * @minLength 1
@@ -75,7 +75,7 @@ export interface InputWt47Z10Aoc {
         hourlyValue: number;
     }[];
 }
-export interface InputZ2Opzvmwkr {
+export interface InputO4N90Uymjl {
     /**
      * Maximum nightly accommodation amount (positive, up to two decimal places)
      * @min 0
@@ -112,14 +112,14 @@ export interface InputZ2Opzvmwkr {
      */
     transportationMax?: number;
 }
-export interface InputKfp90Ivmgu {
+export interface Input4M0Lv5Ahsw {
     /**
      * The contractor's local status. Set to 'active' to enable or 'disabled' to disable the account.
      * @example "active"
      */
-    status: InputKfp90IvmguStatusEnum;
+    status: Input4M0Lv5AhswStatusEnum;
 }
-export interface InputNzq8Jtcdc2 {
+export interface InputD79Au0K6W5 {
     /**
      * Name of the department (1-150 characters)
      * @minLength 1
@@ -135,7 +135,7 @@ export interface InputNzq8Jtcdc2 {
      */
     contactEmails: string[];
 }
-export interface InputLxhfu0Cggl {
+export interface InputTktzkj8J4D {
     /**
      * Updated name of the department (1-150 characters)
      * @minLength 1
@@ -151,7 +151,7 @@ export interface InputLxhfu0Cggl {
      */
     contactEmails?: string[];
 }
-export interface InputSfun2X2Orx {
+export interface InputGxh0Yjattn {
     /**
      * The user ID of the administrator to associate with the department
      * @minLength 1
@@ -159,7 +159,7 @@ export interface InputSfun2X2Orx {
      */
     userID: string;
 }
-export interface InputJ71Z8Sh3A4 {
+export interface InputEh0Dqq1G7Q {
     /**
      * Mileage rate in dollars per kilometre (positive, up to two decimal places)
      * @min 0
@@ -168,7 +168,7 @@ export interface InputJ71Z8Sh3A4 {
      */
     mileageRate: number;
 }
-export interface InputR2Nacgh1Y4 {
+export interface InputTiewwv56Cc {
     /**
      * Maximum nightly accommodation amount (positive, up to two decimal places)
      * @min 0
@@ -205,7 +205,7 @@ export interface InputR2Nacgh1Y4 {
      */
     transportationMax: number;
 }
-export interface Input3Q3Xamu93G {
+export interface InputBt0Uuj40Knj {
     /**
      * Number of days between reminder emails (positive integer)
      * @min 0
@@ -215,7 +215,7 @@ export interface Input3Q3Xamu93G {
     reminderIntervalDays: number;
 }
 /** Create a new draft submission */
-export interface InputVdrvfe8Erz {
+export interface InputIjeu6D8I3B {
     /**
      * Department ID
      * @minLength 1
@@ -237,7 +237,7 @@ export interface InputVdrvfe8Erz {
      * Submission type
      * @example "Submission"
      */
-    type: InputVdrvfe8ErzTypeEnum;
+    type: InputIjeu6D8I3BTypeEnum;
     /**
      * Invoice number or "N/A"
      * @minLength 1
@@ -344,7 +344,7 @@ export interface InputVdrvfe8Erz {
          * Expense type
          * @example "Accommodation"
          */
-        type: InputVdrvfe8ErzTypeEnum1;
+        type: InputIjeu6D8I3BTypeEnum1;
         /**
          * Pre-tax amount
          * @min 0
@@ -369,7 +369,7 @@ export interface InputVdrvfe8Erz {
          * Meal type (Meal expenses)
          * @example "Lunch"
          */
-        mealType?: InputVdrvfe8ErzMealTypeEnum;
+        mealType?: InputIjeu6D8I3BMealTypeEnum;
         /**
          * Number of kilometres (Mileage)
          * @min 0
@@ -381,7 +381,7 @@ export interface InputVdrvfe8Erz {
          * Transportation type (Transportation expenses)
          * @example "Taxi"
          */
-        transportationType?: InputVdrvfe8ErzTransportationTypeEnum;
+        transportationType?: InputIjeu6D8I3BTransportationTypeEnum;
         /**
          * File attachments for this expense
          * @default []
@@ -416,7 +416,7 @@ export interface InputVdrvfe8Erz {
     }[];
 }
 /** Update an existing submission */
-export interface InputY4A9Ylrb3A {
+export interface InputKvk7Y9Qob6 {
     /**
      * Submission description
      * @minLength 1
@@ -425,7 +425,7 @@ export interface InputY4A9Ylrb3A {
     /** Submission date (epoch ms) */
     date?: number;
     /** Submission type */
-    type?: InputY4A9Ylrb3ATypeEnum;
+    type?: InputKvk7Y9Qob6TypeEnum;
     /**
      * Invoice number or "N/A"
      * @minLength 1
@@ -526,7 +526,7 @@ export interface InputY4A9Ylrb3A {
          * Expense type
          * @example "Accommodation"
          */
-        type: InputY4A9Ylrb3ATypeEnum1;
+        type: InputKvk7Y9Qob6TypeEnum1;
         /**
          * Pre-tax amount
          * @min 0
@@ -551,7 +551,7 @@ export interface InputY4A9Ylrb3A {
          * Meal type (Meal expenses)
          * @example "Lunch"
          */
-        mealType?: InputY4A9Ylrb3AMealTypeEnum;
+        mealType?: InputKvk7Y9Qob6MealTypeEnum;
         /**
          * Number of kilometres (Mileage)
          * @min 0
@@ -563,7 +563,7 @@ export interface InputY4A9Ylrb3A {
          * Transportation type (Transportation expenses)
          * @example "Taxi"
          */
-        transportationType?: InputY4A9Ylrb3ATransportationTypeEnum;
+        transportationType?: InputKvk7Y9Qob6TransportationTypeEnum;
         /**
          * File attachments for this expense
          * @default []
@@ -597,11 +597,11 @@ export interface InputY4A9Ylrb3A {
         }[];
     }[];
 }
-export interface Input723Ap5Bsp6G {
+export interface InputZuufi5Flop {
     /** Array of codes to assign to the submission sections */
     codes: {
         /** The section to assign the code to */
-        section: Input723Ap5Bsp6GSectionEnum;
+        section: InputZuufi5FlopSectionEnum;
         /**
          * The code ID to assign
          * @minLength 1
@@ -617,7 +617,7 @@ export interface Input723Ap5Bsp6G {
     }[];
 }
 /** Request a presigned upload URL for a file attachment */
-export interface InputSfhiwjjmi4 {
+export interface InputKn0Y6Bn1Yz {
     /**
      * ID of the invoice or expense line item
      * @minLength 1
@@ -644,14 +644,14 @@ export interface InputSfhiwjjmi4 {
      */
     fileName: string;
 }
-export interface InputH1Tu4Knr5H {
+export interface Input4Tvfg8Mse4 {
     /**
      * PO number to set on the submission
      * @example "PO-5678"
      */
     poNumber: string;
 }
-export interface InputPqfe8Di61L {
+export interface InputWmkkwhx1Bo {
     /**
      * The ID of the new department to reassign to
      * @minLength 1
@@ -659,7 +659,7 @@ export interface InputPqfe8Di61L {
      */
     departmentID: string;
 }
-export interface InputX2Sjifbplw {
+export interface InputJiuwxuwhbyj {
     /**
      * Google reCAPTCHA verification token
      * @example "03AGdBq26..."
@@ -714,8 +714,8 @@ export interface InputX2Sjifbplw {
      * @example 25
      */
     taxAmount?: number;
-    /** Single PDF attachment (max 1 MB) */
-    attachment: {
+    /** Single PDF attachment (max 1 MB). Optional — if omitted, the frontend should upload the file separately via POST /submission/{submissionID}/file after submission creation. */
+    attachment?: {
         /**
          * Unique file identifier
          * @example "file-abc123"
@@ -730,7 +730,7 @@ export interface InputX2Sjifbplw {
          * Content type (must be application/pdf for guest)
          * @example "application/pdf"
          */
-        contentType: InputX2SjifbplwContentTypeEnum;
+        contentType: InputJiuwxuwhbyjContentTypeEnum;
         /**
          * File size in bytes (max 1 MB)
          * @max 1048576
@@ -748,7 +748,7 @@ export interface InputX2Sjifbplw {
  * The contractor's local status. Set to 'active' to enable or 'disabled' to disable the account.
  * @example "active"
  */
-export declare enum InputKfp90IvmguStatusEnum {
+export declare enum Input4M0Lv5AhswStatusEnum {
     Active = "active",
     Disabled = "disabled"
 }
@@ -756,7 +756,7 @@ export declare enum InputKfp90IvmguStatusEnum {
  * Submission type
  * @example "Submission"
  */
-export declare enum InputVdrvfe8ErzTypeEnum {
+export declare enum InputIjeu6D8I3BTypeEnum {
     Submission = "Submission",
     Reimbursement = "Reimbursement"
 }
@@ -764,7 +764,7 @@ export declare enum InputVdrvfe8ErzTypeEnum {
  * Expense type
  * @example "Accommodation"
  */
-export declare enum InputVdrvfe8ErzTypeEnum1 {
+export declare enum InputIjeu6D8I3BTypeEnum1 {
     Accommodation = "Accommodation",
     Meal = "Meal",
     Mileage = "Mileage",
@@ -775,7 +775,7 @@ export declare enum InputVdrvfe8ErzTypeEnum1 {
  * Meal type (Meal expenses)
  * @example "Lunch"
  */
-export declare enum InputVdrvfe8ErzMealTypeEnum {
+export declare enum InputIjeu6D8I3BMealTypeEnum {
     Breakfast = "Breakfast",
     Lunch = "Lunch",
     Dinner = "Dinner"
@@ -784,7 +784,7 @@ export declare enum InputVdrvfe8ErzMealTypeEnum {
  * Transportation type (Transportation expenses)
  * @example "Taxi"
  */
-export declare enum InputVdrvfe8ErzTransportationTypeEnum {
+export declare enum InputIjeu6D8I3BTransportationTypeEnum {
     AirTravel = "Air travel",
     Taxi = "Taxi",
     Ferry = "Ferry",
@@ -792,7 +792,7 @@ export declare enum InputVdrvfe8ErzTransportationTypeEnum {
     Other = "Other"
 }
 /** Submission type */
-export declare enum InputY4A9Ylrb3ATypeEnum {
+export declare enum InputKvk7Y9Qob6TypeEnum {
     Submission = "Submission",
     Reimbursement = "Reimbursement"
 }
@@ -800,7 +800,7 @@ export declare enum InputY4A9Ylrb3ATypeEnum {
  * Expense type
  * @example "Accommodation"
  */
-export declare enum InputY4A9Ylrb3ATypeEnum1 {
+export declare enum InputKvk7Y9Qob6TypeEnum1 {
     Accommodation = "Accommodation",
     Meal = "Meal",
     Mileage = "Mileage",
@@ -811,7 +811,7 @@ export declare enum InputY4A9Ylrb3ATypeEnum1 {
  * Meal type (Meal expenses)
  * @example "Lunch"
  */
-export declare enum InputY4A9Ylrb3AMealTypeEnum {
+export declare enum InputKvk7Y9Qob6MealTypeEnum {
     Breakfast = "Breakfast",
     Lunch = "Lunch",
     Dinner = "Dinner"
@@ -820,7 +820,7 @@ export declare enum InputY4A9Ylrb3AMealTypeEnum {
  * Transportation type (Transportation expenses)
  * @example "Taxi"
  */
-export declare enum InputY4A9Ylrb3ATransportationTypeEnum {
+export declare enum InputKvk7Y9Qob6TransportationTypeEnum {
     AirTravel = "Air travel",
     Taxi = "Taxi",
     Ferry = "Ferry",
@@ -828,7 +828,7 @@ export declare enum InputY4A9Ylrb3ATransportationTypeEnum {
     Other = "Other"
 }
 /** The section to assign the code to */
-export declare enum Input723Ap5Bsp6GSectionEnum {
+export declare enum InputZuufi5FlopSectionEnum {
     Service = "Service",
     Reimbursement = "Reimbursement"
 }
@@ -836,7 +836,7 @@ export declare enum Input723Ap5Bsp6GSectionEnum {
  * Content type (must be application/pdf for guest)
  * @example "application/pdf"
  */
-export declare enum InputX2SjifbplwContentTypeEnum {
+export declare enum InputJiuwxuwhbyjContentTypeEnum {
     ApplicationPdf = "application/pdf"
 }
 export type CreateCodeData = any;
@@ -1067,7 +1067,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Contractor Module API
- * @version 1.0.1
+ * @version 1.0.2
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -1082,7 +1082,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/code
          * @secure
          */
-        createCode: (data: Input5Sa03P3Swr, params?: RequestParams) => Promise<any>;
+        createCode: (data: InputEbucity1Z4, params?: RequestParams) => Promise<any>;
         /**
          * @description Updates an existing charging code description. Only Super Administrators can update codes.
          *
@@ -1092,7 +1092,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/code/{codeID}
          * @secure
          */
-        updateCode: (codeId: string, data: Input6Szg153Vfz, params?: RequestParams) => Promise<any>;
+        updateCode: (codeId: string, data: InputLrvyo8663G, params?: RequestParams) => Promise<any>;
         /**
          * @description Deletes a charging code. Prevents deletion if the code is referenced by existing submissions. Only Super Administrators can delete codes.
          *
@@ -1126,7 +1126,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/contractor
          * @secure
          */
-        createContractor: (data: InputWt47Z10Aoc, params?: RequestParams) => Promise<any>;
+        createContractor: (data: InputX0At7Jc9N, params?: RequestParams) => Promise<any>;
         /**
          * @description View a contractor profile. Contractors can view their own profile (includes effective rates). Administrators can view any contractor profile.
          *
@@ -1146,7 +1146,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/contractor/{userID}/rates
          * @secure
          */
-        updateRates: (userId: string, data: InputZ2Opzvmwkr, params?: RequestParams) => Promise<any>;
+        updateRates: (userId: string, data: InputO4N90Uymjl, params?: RequestParams) => Promise<any>;
         /**
          * @description Triggers a password reset for the specified contractor. Only Administrators and Super Administrators can trigger password resets.
          *
@@ -1166,7 +1166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/contractor/{userID}/status
          * @secure
          */
-        updateStatus: (userId: string, data: InputKfp90Ivmgu, params?: RequestParams) => Promise<any>;
+        updateStatus: (userId: string, data: Input4M0Lv5Ahsw, params?: RequestParams) => Promise<any>;
     };
     contractors: {
         /**
@@ -1190,7 +1190,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/department
          * @secure
          */
-        createDepartment: (data: InputNzq8Jtcdc2, params?: RequestParams) => Promise<any>;
+        createDepartment: (data: InputD79Au0K6W5, params?: RequestParams) => Promise<any>;
         /**
          * @description Updates an existing department name and/or contact emails. SYSADMIN only.
          *
@@ -1200,7 +1200,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/department/{departmentID}
          * @secure
          */
-        updateDepartment: (departmentId: string, data: InputLxhfu0Cggl, params?: RequestParams) => Promise<any>;
+        updateDepartment: (departmentId: string, data: InputTktzkj8J4D, params?: RequestParams) => Promise<any>;
         /**
          * @description Deletes a department. Prevents deletion if department has active codes or associated administrators. SYSADMIN only.
          *
@@ -1220,7 +1220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/department/{departmentID}/admin
          * @secure
          */
-        createAdmin: (departmentId: string, data: InputSfun2X2Orx, params?: RequestParams) => Promise<any>;
+        createAdmin: (departmentId: string, data: InputGxh0Yjattn, params?: RequestParams) => Promise<any>;
         /**
          * @description Removes an administrator association from a department. SYSADMIN only.
          *
@@ -1234,7 +1234,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     departments: {
         /**
-         * @description Returns all departments. Available to ADMIN and SYSADMIN users.
+         * @description Returns all departments. For ADMIN/SYSADMIN users returns full department data. For lower roles (USER, ACCOUNTANT, NONE) returns only departmentID and name.
          *
          * @tags Departments
          * @name ListDepartments
@@ -1264,7 +1264,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/settings/rates
          * @secure
          */
-        updateRates: (data: InputJ71Z8Sh3A4, params?: RequestParams) => Promise<any>;
+        updateRates: (data: InputEh0Dqq1G7Q, params?: RequestParams) => Promise<any>;
         /**
          * @description Updates all system-wide expense maximums (accommodation, meals, transportation). Only Super Administrators can modify system settings.
          *
@@ -1274,7 +1274,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/settings/maximums
          * @secure
          */
-        updateMaximums: (data: InputR2Nacgh1Y4, params?: RequestParams) => Promise<any>;
+        updateMaximums: (data: InputTiewwv56Cc, params?: RequestParams) => Promise<any>;
         /**
          * @description Updates the reminder interval (in days) for pending submission notifications. Only Super Administrators can modify system settings.
          *
@@ -1284,7 +1284,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/settings/reminders
          * @secure
          */
-        updateReminders: (data: Input3Q3Xamu93G, params?: RequestParams) => Promise<any>;
+        updateReminders: (data: InputBt0Uuj40Knj, params?: RequestParams) => Promise<any>;
     };
     submission: {
         /**
@@ -1296,9 +1296,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/submission
          * @secure
          */
-        createSubmission: (data: InputVdrvfe8Erz, params?: RequestParams) => Promise<any>;
+        createSubmission: (data: InputIjeu6D8I3B, params?: RequestParams) => Promise<any>;
         /**
-         * @description Returns a single submission with all invoices, expenses, and assigned codes. Access is scoped by role: contractors see only their own, admins see their department, accountants/superadmins see any.
+         * @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
@@ -1316,7 +1316,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/submission/{submissionID}
          * @secure
          */
-        updateSubmission: (submissionId: string, data: InputY4A9Ylrb3A, params?: RequestParams) => Promise<any>;
+        updateSubmission: (submissionId: string, data: InputKvk7Y9Qob6, params?: RequestParams) => Promise<any>;
         /**
          * @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.
          *
@@ -1346,9 +1346,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/submission/{submissionID}/codes
          * @secure
          */
-        updateCodes: (submissionId: string, data: Input723Ap5Bsp6G, params?: RequestParams) => Promise<any>;
+        updateCodes: (submissionId: string, data: InputZuufi5Flop, params?: RequestParams) => Promise<any>;
         /**
-         * @description Validates file constraints (size, type, count) and returns a presigned S3 URL for uploading a file attachment to a submission line item.
+         * @description Validates file constraints (size, type, count) and returns a presigned S3 URL for uploading a file attachment to a submission line item. Supports both authenticated users (max 10 MB, any type, max 5 files per line item) and guest submissions (PDF only, max 1 MB, max 1 file per line item).
          *
          * @tags Submissions
          * @name CreateFile
@@ -1356,7 +1356,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/submission/{submissionID}/file
          * @secure
          */
-        createFile: (submissionId: string, data: InputSfhiwjjmi4, params?: RequestParams) => Promise<any>;
+        createFile: (submissionId: string, data: InputKn0Y6Bn1Yz, params?: RequestParams) => Promise<any>;
         /**
          * @description Returns a presigned S3 URL for downloading a file attachment associated with a submission line item.
          *
@@ -1396,7 +1396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/submission/{submissionID}/po
          * @secure
          */
-        putSubmission: (submissionId: string, data: InputH1Tu4Knr5H, params?: RequestParams) => Promise<any>;
+        putSubmission: (submissionId: string, data: Input4Tvfg8Mse4, params?: RequestParams) => Promise<any>;
         /**
          * @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.
          *
@@ -1406,7 +1406,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/submission/{submissionID}/reassign
          * @secure
          */
-        createReassign: (submissionId: string, data: InputPqfe8Di61L, params?: RequestParams) => Promise<any>;
+        createReassign: (submissionId: string, data: InputWmkkwhx1Bo, params?: RequestParams) => Promise<any>;
         /**
          * @description Admin rejects a Submitted submission; Accountant rejects an Administrator_Approved submission. RSA-sourced submissions cannot be rejected. Notifies the contractor.
          *
@@ -1428,7 +1428,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createSubmit: (submissionId: string, params?: RequestParams) => Promise<any>;
         /**
-         * @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).
+         * @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). The attachment field is optional — if omitted, the frontend should upload the file separately via POST /submission/{submissionID}/file after creation.
          *
          * @tags Submissions
          * @name CreateGuest
@@ -1436,7 +1436,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/submission/guest
          * @secure
          */
-        createGuest: (data: InputX2Sjifbplw, params?: RequestParams) => Promise<any>;
+        createGuest: (data: InputJiuwxuwhbyj, params?: RequestParams) => Promise<any>;
     };
     submissions: {
         /**