@ikonintegration/module-contractor-api 1.0.0 → 1.0.2

package/Api.ts

@@ -17,7 +17,7 @@ export interface ErrorResponse {
   errCode: string
 }
 
-export interface InputN1Jw8Pelom {
+export interface InputEbucity1Z4 {
   /**
    * Unique code identifier (1-50 alphanumeric characters)
    * @minLength 1
@@ -41,7 +41,7 @@ export interface InputN1Jw8Pelom {
   description: string
 }
 
-export interface InputBpxvmw183C {
+export interface InputLrvyo8663G {
   /**
    * Updated description of the code (1-255 characters)
    * @minLength 1
@@ -51,7 +51,7 @@ export interface InputBpxvmw183C {
   description: string
 }
 
-export interface InputU6Bgra15Uy {
+export interface InputX0At7Jc9N {
   /**
    * Full name of the contractor
    * @minLength 1
@@ -90,7 +90,7 @@ export interface InputU6Bgra15Uy {
   }[]
 }
 
-export interface InputGr9Lchaxob {
+export interface InputO4N90Uymjl {
   /**
    * Maximum nightly accommodation amount (positive, up to two decimal places)
    * @min 0
@@ -128,15 +128,15 @@ export interface InputGr9Lchaxob {
   transportationMax?: number
 }
 
-export interface InputHifqzcj5Po {
+export interface Input4M0Lv5Ahsw {
   /**
    * The contractor's local status. Set to 'active' to enable or 'disabled' to disable the account.
    * @example "active"
    */
-  status: InputHifqzcj5PoStatusEnum
+  status: Input4M0Lv5AhswStatusEnum
 }
 
-export interface Input8I2W1Iyb6R {
+export interface InputD79Au0K6W5 {
   /**
    * Name of the department (1-150 characters)
    * @minLength 1
@@ -153,7 +153,7 @@ export interface Input8I2W1Iyb6R {
   contactEmails: string[]
 }
 
-export interface InputF5Mrt7Alvxl {
+export interface InputTktzkj8J4D {
   /**
    * Updated name of the department (1-150 characters)
    * @minLength 1
@@ -170,7 +170,7 @@ export interface InputF5Mrt7Alvxl {
   contactEmails?: string[]
 }
 
-export interface Input3Y606Jegxm {
+export interface InputGxh0Yjattn {
   /**
    * The user ID of the administrator to associate with the department
    * @minLength 1
@@ -179,7 +179,7 @@ export interface Input3Y606Jegxm {
   userID: string
 }
 
-export interface InputUivsl0J1Jwg {
+export interface InputEh0Dqq1G7Q {
   /**
    * Mileage rate in dollars per kilometre (positive, up to two decimal places)
    * @min 0
@@ -189,7 +189,7 @@ export interface InputUivsl0J1Jwg {
   mileageRate: number
 }
 
-export interface Input0L32Mfaw1Ji {
+export interface InputTiewwv56Cc {
   /**
    * Maximum nightly accommodation amount (positive, up to two decimal places)
    * @min 0
@@ -227,7 +227,7 @@ export interface Input0L32Mfaw1Ji {
   transportationMax: number
 }
 
-export interface Input4Ylvvi4Qiv {
+export interface InputBt0Uuj40Knj {
   /**
    * Number of days between reminder emails (positive integer)
    * @min 0
@@ -238,7 +238,7 @@ export interface Input4Ylvvi4Qiv {
 }
 
 /** Create a new draft submission */
-export interface Input1E4Ziwqngl {
+export interface InputIjeu6D8I3B {
   /**
    * Department ID
    * @minLength 1
@@ -260,7 +260,7 @@ export interface Input1E4Ziwqngl {
    * Submission type
    * @example "Submission"
    */
-  type: Input1E4ZiwqnglTypeEnum
+  type: InputIjeu6D8I3BTypeEnum
   /**
    * Invoice number or "N/A"
    * @minLength 1
@@ -367,7 +367,7 @@ export interface Input1E4Ziwqngl {
      * Expense type
      * @example "Accommodation"
      */
-    type: Input1E4ZiwqnglTypeEnum1
+    type: InputIjeu6D8I3BTypeEnum1
     /**
      * Pre-tax amount
      * @min 0
@@ -392,7 +392,7 @@ export interface Input1E4Ziwqngl {
      * Meal type (Meal expenses)
      * @example "Lunch"
      */
-    mealType?: Input1E4ZiwqnglMealTypeEnum
+    mealType?: InputIjeu6D8I3BMealTypeEnum
     /**
      * Number of kilometres (Mileage)
      * @min 0
@@ -404,7 +404,7 @@ export interface Input1E4Ziwqngl {
      * Transportation type (Transportation expenses)
      * @example "Taxi"
      */
-    transportationType?: Input1E4ZiwqnglTransportationTypeEnum
+    transportationType?: InputIjeu6D8I3BTransportationTypeEnum
     /**
      * File attachments for this expense
      * @default []
@@ -440,7 +440,7 @@ export interface Input1E4Ziwqngl {
 }
 
 /** Update an existing submission */
-export interface InputD6Uic9Wivl {
+export interface InputKvk7Y9Qob6 {
   /**
    * Submission description
    * @minLength 1
@@ -449,7 +449,7 @@ export interface InputD6Uic9Wivl {
   /** Submission date (epoch ms) */
   date?: number
   /** Submission type */
-  type?: InputD6Uic9WivlTypeEnum
+  type?: InputKvk7Y9Qob6TypeEnum
   /**
    * Invoice number or "N/A"
    * @minLength 1
@@ -550,7 +550,7 @@ export interface InputD6Uic9Wivl {
      * Expense type
      * @example "Accommodation"
      */
-    type: InputD6Uic9WivlTypeEnum1
+    type: InputKvk7Y9Qob6TypeEnum1
     /**
      * Pre-tax amount
      * @min 0
@@ -575,7 +575,7 @@ export interface InputD6Uic9Wivl {
      * Meal type (Meal expenses)
      * @example "Lunch"
      */
-    mealType?: InputD6Uic9WivlMealTypeEnum
+    mealType?: InputKvk7Y9Qob6MealTypeEnum
     /**
      * Number of kilometres (Mileage)
      * @min 0
@@ -587,7 +587,7 @@ export interface InputD6Uic9Wivl {
      * Transportation type (Transportation expenses)
      * @example "Taxi"
      */
-    transportationType?: InputD6Uic9WivlTransportationTypeEnum
+    transportationType?: InputKvk7Y9Qob6TransportationTypeEnum
     /**
      * File attachments for this expense
      * @default []
@@ -622,11 +622,11 @@ export interface InputD6Uic9Wivl {
   }[]
 }
 
-export interface InputQqc4Xl7Nr3 {
+export interface InputZuufi5Flop {
   /** Array of codes to assign to the submission sections */
   codes: {
     /** The section to assign the code to */
-    section: InputQqc4Xl7Nr3SectionEnum
+    section: InputZuufi5FlopSectionEnum
     /**
      * The code ID to assign
      * @minLength 1
@@ -643,7 +643,7 @@ export interface InputQqc4Xl7Nr3 {
 }
 
 /** Request a presigned upload URL for a file attachment */
-export interface InputNiqys3Oiwd {
+export interface InputKn0Y6Bn1Yz {
   /**
    * ID of the invoice or expense line item
    * @minLength 1
@@ -671,7 +671,7 @@ export interface InputNiqys3Oiwd {
   fileName: string
 }
 
-export interface Input9Zqht4Idck {
+export interface Input4Tvfg8Mse4 {
   /**
    * PO number to set on the submission
    * @example "PO-5678"
@@ -679,7 +679,7 @@ export interface Input9Zqht4Idck {
   poNumber: string
 }
 
-export interface InputRx3Tqfjstsk {
+export interface InputWmkkwhx1Bo {
   /**
    * The ID of the new department to reassign to
    * @minLength 1
@@ -688,7 +688,7 @@ export interface InputRx3Tqfjstsk {
   departmentID: string
 }
 
-export interface InputVl61Mvkana {
+export interface InputJiuwxuwhbyj {
   /**
    * Google reCAPTCHA verification token
    * @example "03AGdBq26..."
@@ -743,8 +743,8 @@ export interface InputVl61Mvkana {
    * @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"
@@ -759,7 +759,7 @@ export interface InputVl61Mvkana {
      * Content type (must be application/pdf for guest)
      * @example "application/pdf"
      */
-    contentType: InputVl61MvkanaContentTypeEnum
+    contentType: InputJiuwxuwhbyjContentTypeEnum
     /**
      * File size in bytes (max 1 MB)
      * @max 1048576
@@ -778,7 +778,7 @@ export interface InputVl61Mvkana {
  * The contractor's local status. Set to 'active' to enable or 'disabled' to disable the account.
  * @example "active"
  */
-export enum InputHifqzcj5PoStatusEnum {
+export enum Input4M0Lv5AhswStatusEnum {
   Active = 'active',
   Disabled = 'disabled',
 }
@@ -787,7 +787,7 @@ export enum InputHifqzcj5PoStatusEnum {
  * Submission type
  * @example "Submission"
  */
-export enum Input1E4ZiwqnglTypeEnum {
+export enum InputIjeu6D8I3BTypeEnum {
   Submission = 'Submission',
   Reimbursement = 'Reimbursement',
 }
@@ -796,7 +796,7 @@ export enum Input1E4ZiwqnglTypeEnum {
  * Expense type
  * @example "Accommodation"
  */
-export enum Input1E4ZiwqnglTypeEnum1 {
+export enum InputIjeu6D8I3BTypeEnum1 {
   Accommodation = 'Accommodation',
   Meal = 'Meal',
   Mileage = 'Mileage',
@@ -808,7 +808,7 @@ export enum Input1E4ZiwqnglTypeEnum1 {
  * Meal type (Meal expenses)
  * @example "Lunch"
  */
-export enum Input1E4ZiwqnglMealTypeEnum {
+export enum InputIjeu6D8I3BMealTypeEnum {
   Breakfast = 'Breakfast',
   Lunch = 'Lunch',
   Dinner = 'Dinner',
@@ -818,7 +818,7 @@ export enum Input1E4ZiwqnglMealTypeEnum {
  * Transportation type (Transportation expenses)
  * @example "Taxi"
  */
-export enum Input1E4ZiwqnglTransportationTypeEnum {
+export enum InputIjeu6D8I3BTransportationTypeEnum {
   AirTravel = 'Air travel',
   Taxi = 'Taxi',
   Ferry = 'Ferry',
@@ -827,7 +827,7 @@ export enum Input1E4ZiwqnglTransportationTypeEnum {
 }
 
 /** Submission type */
-export enum InputD6Uic9WivlTypeEnum {
+export enum InputKvk7Y9Qob6TypeEnum {
   Submission = 'Submission',
   Reimbursement = 'Reimbursement',
 }
@@ -836,7 +836,7 @@ export enum InputD6Uic9WivlTypeEnum {
  * Expense type
  * @example "Accommodation"
  */
-export enum InputD6Uic9WivlTypeEnum1 {
+export enum InputKvk7Y9Qob6TypeEnum1 {
   Accommodation = 'Accommodation',
   Meal = 'Meal',
   Mileage = 'Mileage',
@@ -848,7 +848,7 @@ export enum InputD6Uic9WivlTypeEnum1 {
  * Meal type (Meal expenses)
  * @example "Lunch"
  */
-export enum InputD6Uic9WivlMealTypeEnum {
+export enum InputKvk7Y9Qob6MealTypeEnum {
   Breakfast = 'Breakfast',
   Lunch = 'Lunch',
   Dinner = 'Dinner',
@@ -858,7 +858,7 @@ export enum InputD6Uic9WivlMealTypeEnum {
  * Transportation type (Transportation expenses)
  * @example "Taxi"
  */
-export enum InputD6Uic9WivlTransportationTypeEnum {
+export enum InputKvk7Y9Qob6TransportationTypeEnum {
   AirTravel = 'Air travel',
   Taxi = 'Taxi',
   Ferry = 'Ferry',
@@ -867,7 +867,7 @@ export enum InputD6Uic9WivlTransportationTypeEnum {
 }
 
 /** The section to assign the code to */
-export enum InputQqc4Xl7Nr3SectionEnum {
+export enum InputZuufi5FlopSectionEnum {
   Service = 'Service',
   Reimbursement = 'Reimbursement',
 }
@@ -876,7 +876,7 @@ export enum InputQqc4Xl7Nr3SectionEnum {
  * Content type (must be application/pdf for guest)
  * @example "application/pdf"
  */
-export enum InputVl61MvkanaContentTypeEnum {
+export enum InputJiuwxuwhbyjContentTypeEnum {
   ApplicationPdf = 'application/pdf',
 }
 
@@ -1285,7 +1285,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Contractor Module API
- * @version 1.0.0
+ * @version 1.0.2
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -1300,7 +1300,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/code
      * @secure
      */
-    createCode: (data: InputN1Jw8Pelom, params: RequestParams = {}) =>
+    createCode: (data: InputEbucity1Z4, params: RequestParams = {}) =>
       this.request<CreateCodeData, CreateCodeError>({
         path: `/code`,
         method: 'POST',
@@ -1319,7 +1319,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/code/{codeID}
      * @secure
      */
-    updateCode: (codeId: string, data: InputBpxvmw183C, params: RequestParams = {}) =>
+    updateCode: (codeId: string, data: InputLrvyo8663G, params: RequestParams = {}) =>
       this.request<UpdateCodeData, UpdateCodeError>({
         path: `/code/${codeId}`,
         method: 'PUT',
@@ -1374,7 +1374,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/contractor
      * @secure
      */
-    createContractor: (data: InputU6Bgra15Uy, params: RequestParams = {}) =>
+    createContractor: (data: InputX0At7Jc9N, params: RequestParams = {}) =>
       this.request<CreateContractorData, CreateContractorError>({
         path: `/contractor`,
         method: 'POST',
@@ -1410,7 +1410,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/contractor/{userID}/rates
      * @secure
      */
-    updateRates: (userId: string, data: InputGr9Lchaxob, params: RequestParams = {}) =>
+    updateRates: (userId: string, data: InputO4N90Uymjl, params: RequestParams = {}) =>
       this.request<UpdateRatesData, UpdateRatesError>({
         path: `/contractor/${userId}/rates`,
         method: 'PUT',
@@ -1446,7 +1446,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/contractor/{userID}/status
      * @secure
      */
-    updateStatus: (userId: string, data: InputHifqzcj5Po, params: RequestParams = {}) =>
+    updateStatus: (userId: string, data: Input4M0Lv5Ahsw, params: RequestParams = {}) =>
       this.request<UpdateStatusData, UpdateStatusError>({
         path: `/contractor/${userId}/status`,
         method: 'PUT',
@@ -1485,7 +1485,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/department
      * @secure
      */
-    createDepartment: (data: Input8I2W1Iyb6R, params: RequestParams = {}) =>
+    createDepartment: (data: InputD79Au0K6W5, params: RequestParams = {}) =>
       this.request<CreateDepartmentData, CreateDepartmentError>({
         path: `/department`,
         method: 'POST',
@@ -1504,7 +1504,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/department/{departmentID}
      * @secure
      */
-    updateDepartment: (departmentId: string, data: InputF5Mrt7Alvxl, params: RequestParams = {}) =>
+    updateDepartment: (departmentId: string, data: InputTktzkj8J4D, params: RequestParams = {}) =>
       this.request<UpdateDepartmentData, UpdateDepartmentError>({
         path: `/department/${departmentId}`,
         method: 'PUT',
@@ -1540,7 +1540,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/department/{departmentID}/admin
      * @secure
      */
-    createAdmin: (departmentId: string, data: Input3Y606Jegxm, params: RequestParams = {}) =>
+    createAdmin: (departmentId: string, data: InputGxh0Yjattn, params: RequestParams = {}) =>
       this.request<CreateAdminData, CreateAdminError>({
         path: `/department/${departmentId}/admin`,
         method: 'POST',
@@ -1569,7 +1569,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
   }
   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
@@ -1612,7 +1612,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/settings/rates
      * @secure
      */
-    updateRates: (data: InputUivsl0J1Jwg, params: RequestParams = {}) =>
+    updateRates: (data: InputEh0Dqq1G7Q, params: RequestParams = {}) =>
       this.request<UpdateRatesResult, UpdateRatesFail>({
         path: `/settings/rates`,
         method: 'PUT',
@@ -1631,7 +1631,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/settings/maximums
      * @secure
      */
-    updateMaximums: (data: Input0L32Mfaw1Ji, params: RequestParams = {}) =>
+    updateMaximums: (data: InputTiewwv56Cc, params: RequestParams = {}) =>
       this.request<UpdateMaximumsData, UpdateMaximumsError>({
         path: `/settings/maximums`,
         method: 'PUT',
@@ -1650,7 +1650,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/settings/reminders
      * @secure
      */
-    updateReminders: (data: Input4Ylvvi4Qiv, params: RequestParams = {}) =>
+    updateReminders: (data: InputBt0Uuj40Knj, params: RequestParams = {}) =>
       this.request<UpdateRemindersData, UpdateRemindersError>({
         path: `/settings/reminders`,
         method: 'PUT',
@@ -1670,7 +1670,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/submission
      * @secure
      */
-    createSubmission: (data: Input1E4Ziwqngl, params: RequestParams = {}) =>
+    createSubmission: (data: InputIjeu6D8I3B, params: RequestParams = {}) =>
       this.request<CreateSubmissionData, CreateSubmissionError>({
         path: `/submission`,
         method: 'POST',
@@ -1681,7 +1681,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }),
 
     /**
-     * @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
@@ -1706,7 +1706,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/submission/{submissionID}
      * @secure
      */
-    updateSubmission: (submissionId: string, data: InputD6Uic9Wivl, params: RequestParams = {}) =>
+    updateSubmission: (submissionId: string, data: InputKvk7Y9Qob6, params: RequestParams = {}) =>
       this.request<UpdateSubmissionData, UpdateSubmissionError>({
         path: `/submission/${submissionId}`,
         method: 'PUT',
@@ -1759,7 +1759,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/submission/{submissionID}/codes
      * @secure
      */
-    updateCodes: (submissionId: string, data: InputQqc4Xl7Nr3, params: RequestParams = {}) =>
+    updateCodes: (submissionId: string, data: InputZuufi5Flop, params: RequestParams = {}) =>
       this.request<UpdateCodesData, UpdateCodesError>({
         path: `/submission/${submissionId}/codes`,
         method: 'PUT',
@@ -1770,7 +1770,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }),
 
     /**
-     * @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
@@ -1778,7 +1778,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/submission/{submissionID}/file
      * @secure
      */
-    createFile: (submissionId: string, data: InputNiqys3Oiwd, params: RequestParams = {}) =>
+    createFile: (submissionId: string, data: InputKn0Y6Bn1Yz, params: RequestParams = {}) =>
       this.request<CreateFileData, CreateFileError>({
         path: `/submission/${submissionId}/file`,
         method: 'POST',
@@ -1848,7 +1848,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/submission/{submissionID}/po
      * @secure
      */
-    putSubmission: (submissionId: string, data: Input9Zqht4Idck, params: RequestParams = {}) =>
+    putSubmission: (submissionId: string, data: Input4Tvfg8Mse4, params: RequestParams = {}) =>
       this.request<PutSubmissionData, PutSubmissionError>({
         path: `/submission/${submissionId}/po`,
         method: 'PUT',
@@ -1867,7 +1867,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/submission/{submissionID}/reassign
      * @secure
      */
-    createReassign: (submissionId: string, data: InputRx3Tqfjstsk, params: RequestParams = {}) =>
+    createReassign: (submissionId: string, data: InputWmkkwhx1Bo, params: RequestParams = {}) =>
       this.request<CreateReassignData, CreateReassignError>({
         path: `/submission/${submissionId}/reassign`,
         method: 'POST',
@@ -1912,7 +1912,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }),
 
     /**
-     * @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
@@ -1920,7 +1920,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/submission/guest
      * @secure
      */
-    createGuest: (data: InputVl61Mvkana, params: RequestParams = {}) =>
+    createGuest: (data: InputJiuwxuwhbyj, params: RequestParams = {}) =>
       this.request<CreateGuestData, CreateGuestError>({
         path: `/submission/guest`,
         method: 'POST',