@ikonintegration/module-contractor-api 1.0.18 → 1.0.20

package/Api.ts

@@ -17,6 +17,66 @@ export interface ErrorResponse {
   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 */
@@ -300,6 +360,24 @@ export interface UserSearchResult {
   localStatus?: string
 }
 
+export interface IDMUserSearchInput {
+  /**
+   * Full-text IDM search term
+   * @example "vitor"
+   */
+  searchTerm?: string
+  /** Optional IDM filter object, forwarded verbatim to IDM */
+  filter?: Record<string, any>
+}
+
+/** IDM directory user search results (proxied) */
+export interface IDMUserSearchResponse {
+  /** IDM user records (Elasticsearch-hit shape) as returned by IDM */
+  users: any[]
+  /** Total matching records reported by IDM */
+  total: number
+}
+
 export interface CreateDepartmentSchema {
   /**
    * Name of the department (1-150 characters)
@@ -1100,58 +1178,51 @@ export interface PostApproveResponseSchema {
   status: string
 }
 
-export interface CreateSubmissionCodeSchema {
+export interface AttachSubmissionCodeSchema {
   /**
-   * Description of the code (1-255 characters)
-   * @minLength 1
-   * @maxLength 255
-   * @example "Consulting services for safety audits"
+   * The submission section the code is associated with
+   * @example "Service"
    */
-  description: string
+  section: AttachSubmissionCodeSchemaSectionEnum
+  /**
+   * Optional note for the code association (max 500 characters)
+   * @maxLength 500
+   * @example "Charge 20% to this code"
+   */
+  note?: string
 }
 
-export interface SubmissionCodeMutationResponseSchema {
-  /** Code identifier */
+export interface SubmissionCodeAssociationResponseSchema {
+  /** Parent submission ID */
+  submissionID: string
+  /**
+   * The submission section the code is associated with
+   * @example "Service"
+   */
+  section: SubmissionCodeAssociationResponseSchemaSectionEnum
+  /** Associated catalog code ID */
   codeID: string
-  /** Derived department ID */
-  departmentID: string
-  /** Code description */
-  description: string
+  /** Note for the association, or null when unset */
+  note: string | null
 }
 
-export interface UpdateSubmissionCodeSchema {
+export interface UpdateSubmissionCodeNoteSchema {
   /**
-   * Description of the code (1-255 characters)
-   * @minLength 1
-   * @maxLength 255
-   * @example "Consulting services for safety audits"
+   * The submission section the code is associated with
+   * @example "Service"
    */
-  description: string
+  section: UpdateSubmissionCodeNoteSchemaSectionEnum
+  /**
+   * Optional note for the code association (max 500 characters)
+   * @maxLength 500
+   * @example "Charge 20% to this code"
+   */
+  note?: string
 }
 
-/** Deletion result (empty body) */
+/** Detach result (empty body) */
 export type DeleteSubmissionCodeResponseSchema = object
 
-export interface PutSubmissionCodesSchema {
-  /** Array of codes to assign to the submission sections */
-  codes: SubmissionCodeItemSchema[]
-}
-
-/** Code assignment result */
-export interface PutSubmissionCodesResponseSchema {
-  /** Submission ID */
-  submissionID: string
-  /** Assigned codes */
-  codes: {
-    /** Section (Service or Reimbursement) */
-    section: string
-    /** Billing code ID */
-    codeID: string
-    /** Optional note */
-    note: string | null
-  }[]
-}
-
 /** Request a presigned upload URL for a file attachment */
 export interface FileUploadRequestSchema {
   /**
@@ -1630,6 +1701,33 @@ export enum UpdateExpenseInputSchemaTransportationTypeEnum {
   Other = 'Other',
 }
 
+/**
+ * The submission section the code is associated with
+ * @example "Service"
+ */
+export enum AttachSubmissionCodeSchemaSectionEnum {
+  Service = 'Service',
+  Reimbursement = 'Reimbursement',
+}
+
+/**
+ * The submission section the code is associated with
+ * @example "Service"
+ */
+export enum SubmissionCodeAssociationResponseSchemaSectionEnum {
+  Service = 'Service',
+  Reimbursement = 'Reimbursement',
+}
+
+/**
+ * The submission section the code is associated with
+ * @example "Service"
+ */
+export enum UpdateSubmissionCodeNoteSchemaSectionEnum {
+  Service = 'Service',
+  Reimbursement = 'Reimbursement',
+}
+
 /** Content type */
 export enum GetPdfResponseSchemaContentTypeEnum {
   ApplicationPdf = 'application/pdf',
@@ -1643,6 +1741,18 @@ export 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.
@@ -1719,6 +1829,10 @@ export type CreateSearchResult = UserSearchResponse
 
 export type CreateSearchFail = ErrorResponse
 
+export type CreateSearchIdmData = IDMUserSearchResponse
+
+export type CreateSearchIdmError = ErrorResponse
+
 export type CreateDepartmentData = PostDepartmentResponseSchema
 
 export type CreateDepartmentError = ErrorResponse
@@ -1805,21 +1919,61 @@ export type CreateApproveData = PostApproveResponseSchema
 
 export type CreateApproveError = ErrorResponse
 
-export type CreateCodeData = SubmissionCodeMutationResponseSchema
+export type CreateCodeResult = SubmissionCodeAssociationResponseSchema
 
-export type CreateCodeError = ErrorResponse
+export type CreateCodeFail = ErrorResponse
 
-export type UpdateCodeData = SubmissionCodeMutationResponseSchema
+export type UpdateCodeResult = SubmissionCodeAssociationResponseSchema
 
-export type UpdateCodeError = ErrorResponse
+export type UpdateCodeFail = ErrorResponse
 
-export type DeleteCodeData = DeleteSubmissionCodeResponseSchema
+export interface DeleteCodeParams1 {
+  /**
+   * The submission section the code is associated with
+   * @example "Service"
+   */
+  section: SectionEnum
+  /**
+   * Owner user identifier (submission partition key)
+   * @minLength 1
+   * @example "USR-2RvYIFNJR3CrJHKO0NqgGa1EwcS"
+   */
+  userId: string
+  /**
+   * Submission identifier
+   * @minLength 1
+   * @example "SUB-2RvYIFNJR3CrJHKO0NqgGa1EwcS"
+   */
+  submissionId: string
+  /**
+   * Code identifier
+   * @minLength 1
+   * @example "CODE-2RvYIFNJR3CrJHKO0NqgGa1EwcS"
+   */
+  codeId: string
+}
 
-export type DeleteCodeError = ErrorResponse
+/**
+ * The submission section the code is associated with
+ * @example "Service"
+ */
+export enum SectionEnum {
+  Service = 'Service',
+  Reimbursement = 'Reimbursement',
+}
 
-export type UpdateCodesData = PutSubmissionCodesResponseSchema
+export type DeleteCodeResult = DeleteSubmissionCodeResponseSchema
 
-export type UpdateCodesError = ErrorResponse
+export type DeleteCodeFail = ErrorResponse
+
+/**
+ * The submission section the code is associated with
+ * @example "Service"
+ */
+export enum DeleteCodeParams2SectionEnum {
+  Service = 'Service',
+  Reimbursement = 'Reimbursement',
+}
 
 export type CreateFileData = PostFileResponseSchema
 
@@ -1952,7 +2106,7 @@ export type ListExportData = GetSubmissionsExportResponseSchema
 
 export type ListExportError = ErrorResponse
 
-export type CreateSearchData1 = SubmissionSearchResponse
+export type CreateSearchResult1 = SubmissionSearchResponse
 
 export type CreateSearchErrorData = ErrorResponse
 
@@ -2094,11 +2248,70 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Contractor Module API
- * @version 1.0.18
+ * @version 1.0.20
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
 export 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 = {}) =>
+      this.request<CreateCodeData, CreateCodeError>({
+        path: `/code`,
+        method: 'POST',
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: 'json',
+        ...params,
+      }),
+
+    /**
+     * @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 = {}) =>
+      this.request<UpdateCodeData, UpdateCodeError>({
+        path: `/code/${codeId}`,
+        method: 'PUT',
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: 'json',
+        ...params,
+      }),
+
+    /**
+     * @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 = {}) =>
+      this.request<DeleteCodeData, DeleteCodeError>({
+        path: `/code/${codeId}`,
+        method: 'DELETE',
+        secure: true,
+        format: 'json',
+        ...params,
+      }),
+  }
   codes = {
     /**
      * @description Returns all codes or codes filtered by department. Administrators and above can list codes.
@@ -2255,20 +2468,39 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         format: 'json',
         ...params,
       }),
-  }
-  users = {
+
     /**
      * @description Search users by name, email, phone, role, or status.
      *
      * @tags Users
      * @name CreateSearch
      * @summary Search users
-     * @request POST:/users/search
+     * @request POST:/contractors/search
      * @secure
      */
     createSearch: (data: UserSearchInput, params: RequestParams = {}) =>
       this.request<CreateSearchResult, CreateSearchFail>({
-        path: `/users/search`,
+        path: `/contractors/search`,
+        method: 'POST',
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: 'json',
+        ...params,
+      }),
+
+    /**
+     * @description Search the full customer IDM user directory. Authenticated server-side with the customer IDM credentials so results are consistent for all administrators. Admin/Sysadmin only.
+     *
+     * @tags Users
+     * @name CreateSearchIdm
+     * @summary Search IDM users (directory proxy)
+     * @request POST:/contractors/search/idm
+     * @secure
+     */
+    createSearchIdm: (data: IDMUserSearchInput, params: RequestParams = {}) =>
+      this.request<CreateSearchIdmData, CreateSearchIdmError>({
+        path: `/contractors/search/idm`,
         method: 'POST',
         body: data,
         secure: true,
@@ -2516,17 +2748,23 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }),
 
     /**
-     * @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.
+     * @description Attaches an existing catalog code (addressed by codeID within the submission's department) to a submission's Service or Reimbursement section, with an optional note. Operates on the SubmissionCode association. Admin only.
      *
      * @tags Submissions
      * @name CreateCode
-     * @summary Create code on submission
-     * @request POST:/submission/{userID}/{submissionID}/code
+     * @summary Attach a catalog code to a submission section
+     * @request POST:/submission/{userID}/{submissionID}/code/{codeID}
      * @secure
      */
-    createCode: (userId: string, submissionId: string, data: CreateSubmissionCodeSchema, params: RequestParams = {}) =>
-      this.request<CreateCodeData, CreateCodeError>({
-        path: `/submission/${userId}/${submissionId}/code`,
+    createCode: (
+      userId: string,
+      submissionId: string,
+      codeId: string,
+      data: AttachSubmissionCodeSchema,
+      params: RequestParams = {}
+    ) =>
+      this.request<CreateCodeResult, CreateCodeFail>({
+        path: `/submission/${userId}/${submissionId}/code/${codeId}`,
         method: 'POST',
         body: data,
         secure: true,
@@ -2536,11 +2774,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }),
 
     /**
-     * @description Updates the description of a billing code addressed by codeID and derived from the parent submission's department. Admin only.
+     * @description Updates the note of a catalog code attached to a submission's Service or Reimbursement section. Operates on the SubmissionCode association. Admin only.
      *
      * @tags Submissions
      * @name UpdateCode
-     * @summary Update a submission code
+     * @summary Update an attached submission code note
      * @request PUT:/submission/{userID}/{submissionID}/code/{codeID}
      * @secure
      */
@@ -2548,10 +2786,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       userId: string,
       submissionId: string,
       codeId: string,
-      data: UpdateSubmissionCodeSchema,
+      data: UpdateSubmissionCodeNoteSchema,
       params: RequestParams = {}
     ) =>
-      this.request<UpdateCodeData, UpdateCodeError>({
+      this.request<UpdateCodeResult, UpdateCodeFail>({
         path: `/submission/${userId}/${submissionId}/code/${codeId}`,
         method: 'PUT',
         body: data,
@@ -2562,43 +2800,24 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }),
 
     /**
-     * @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.
+     * @description Detaches an attached catalog code (addressed by codeID) from a submission's Service or Reimbursement section, identified by the required 'section' query parameter. Operates on the SubmissionCode association. Admin only.
      *
      * @tags Submissions
      * @name DeleteCode
-     * @summary Delete a code from a submission
+     * @summary Detach a catalog code from a submission section
      * @request DELETE:/submission/{userID}/{submissionID}/code/{codeID}
      * @secure
      */
-    deleteCode: (userId: string, submissionId: string, codeId: string, params: RequestParams = {}) =>
-      this.request<DeleteCodeData, DeleteCodeError>({
+    deleteCode: ({ userId, submissionId, codeId, ...query }: DeleteCodeParams1, params: RequestParams = {}) =>
+      this.request<DeleteCodeResult, DeleteCodeFail>({
         path: `/submission/${userId}/${submissionId}/code/${codeId}`,
         method: 'DELETE',
+        query: query,
         secure: true,
         format: 'json',
         ...params,
       }),
 
-    /**
-     * @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/{userID}/{submissionID}/codes
-     * @secure
-     */
-    updateCodes: (userId: string, submissionId: string, data: PutSubmissionCodesSchema, params: RequestParams = {}) =>
-      this.request<UpdateCodesData, UpdateCodesError>({
-        path: `/submission/${userId}/${submissionId}/codes`,
-        method: 'PUT',
-        body: data,
-        secure: true,
-        type: ContentType.Json,
-        format: 'json',
-        ...params,
-      }),
-
     /**
      * @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.
      *
@@ -2797,7 +3016,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }),
 
     /**
-     * @description Generate an Excel export of submissions scoped by role. Contractors see only their own submissions. Administrators see their department. Accountants and Super Administrators see all. Maximum 10,000 rows.
+     * @description Generate an Excel export of submissions scoped by role. Contractors see only their own submissions. Administrators see their departments. Accountants and Super Administrators see all. Maximum 10,000 rows.
      *
      * @tags Submissions
      * @name ListExport
@@ -2824,7 +3043,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     createSearch: (data: SubmissionSearchInput, params: RequestParams = {}) =>
-      this.request<CreateSearchData1, CreateSearchErrorData>({
+      this.request<CreateSearchResult1, CreateSearchErrorData>({
         path: `/submissions/search`,
         method: 'POST',
         body: data,