@ikonintegration/module-contractor-api 1.0.0 → 1.0.1

package/dist/Api.d.ts

@@ -0,0 +1,1463 @@
+/** Default API Error response */
+export interface ErrorResponse {
+    /** Error message */
+    err: string;
+    /** Error code */
+    errCode: string;
+}
+export interface Input5Sa03P3Swr {
+    /**
+     * Unique code identifier (1-50 alphanumeric characters)
+     * @minLength 1
+     * @maxLength 50
+     * @pattern ^[a-zA-Z0-9]+$
+     * @example "ACC001"
+     */
+    codeID: string;
+    /**
+     * 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;
+}
+export interface Input6Szg153Vfz {
+    /**
+     * Updated description of the code (1-255 characters)
+     * @minLength 1
+     * @maxLength 255
+     * @example "Updated consulting services description"
+     */
+    description: string;
+}
+export interface InputWt47Z10Aoc {
+    /**
+     * Full name of the contractor
+     * @minLength 1
+     * @example "Jane Smith"
+     */
+    name: string;
+    /**
+     * Email address of the contractor (must be unique)
+     * @format email
+     * @example "jane.smith@example.com"
+     */
+    email: string;
+    /**
+     * Phone number of the contractor
+     * @example "+1-604-555-1234"
+     */
+    phone?: string;
+    /**
+     * List of hourly job rates (at least one required)
+     * @minItems 1
+     */
+    jobRates: {
+        /**
+         * Description of the job rate
+         * @minLength 1
+         * @example "Senior Instructor"
+         */
+        description: string;
+        /**
+         * Hourly rate value in dollars (must be greater than zero)
+         * @min 0
+         * @exclusiveMin true
+         * @example 75
+         */
+        hourlyValue: number;
+    }[];
+}
+export interface InputZ2Opzvmwkr {
+    /**
+     * Maximum nightly accommodation amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 150
+     */
+    accommodationNightly?: number;
+    /**
+     * Maximum breakfast meal amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 20
+     */
+    mealBreakfast?: number;
+    /**
+     * Maximum lunch meal amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 25
+     */
+    mealLunch?: number;
+    /**
+     * Maximum dinner meal amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 40
+     */
+    mealDinner?: number;
+    /**
+     * Maximum transportation amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 100
+     */
+    transportationMax?: number;
+}
+export interface InputKfp90Ivmgu {
+    /**
+     * The contractor's local status. Set to 'active' to enable or 'disabled' to disable the account.
+     * @example "active"
+     */
+    status: InputKfp90IvmguStatusEnum;
+}
+export interface InputNzq8Jtcdc2 {
+    /**
+     * Name of the department (1-150 characters)
+     * @minLength 1
+     * @maxLength 150
+     * @example "Engineering"
+     */
+    name: string;
+    /**
+     * Contact email addresses for the department (1-10 valid emails)
+     * @maxItems 10
+     * @minItems 1
+     * @example ["eng-lead@bccsa.ca","eng-admin@bccsa.ca"]
+     */
+    contactEmails: string[];
+}
+export interface InputLxhfu0Cggl {
+    /**
+     * Updated name of the department (1-150 characters)
+     * @minLength 1
+     * @maxLength 150
+     * @example "Engineering Services"
+     */
+    name?: string;
+    /**
+     * Updated contact email addresses for the department (1-10 valid emails)
+     * @maxItems 10
+     * @minItems 1
+     * @example ["eng-lead@bccsa.ca"]
+     */
+    contactEmails?: string[];
+}
+export interface InputSfun2X2Orx {
+    /**
+     * The user ID of the administrator to associate with the department
+     * @minLength 1
+     * @example "USR-2RvYIFNJR3CrJHKO0NqgGa1EwcS"
+     */
+    userID: string;
+}
+export interface InputJ71Z8Sh3A4 {
+    /**
+     * Mileage rate in dollars per kilometre (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 0.65
+     */
+    mileageRate: number;
+}
+export interface InputR2Nacgh1Y4 {
+    /**
+     * Maximum nightly accommodation amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 150
+     */
+    accommodationNightly: number;
+    /**
+     * Maximum breakfast meal amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 20
+     */
+    mealBreakfast: number;
+    /**
+     * Maximum lunch meal amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 25
+     */
+    mealLunch: number;
+    /**
+     * Maximum dinner meal amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 40
+     */
+    mealDinner: number;
+    /**
+     * Maximum transportation amount (positive, up to two decimal places)
+     * @min 0
+     * @exclusiveMin true
+     * @example 100
+     */
+    transportationMax: number;
+}
+export interface Input3Q3Xamu93G {
+    /**
+     * Number of days between reminder emails (positive integer)
+     * @min 0
+     * @exclusiveMin true
+     * @example 7
+     */
+    reminderIntervalDays: number;
+}
+/** Create a new draft submission */
+export interface InputVdrvfe8Erz {
+    /**
+     * Department ID
+     * @minLength 1
+     * @example "DEPT-abc123"
+     */
+    departmentID: string;
+    /**
+     * Submission description
+     * @minLength 1
+     * @example "Monthly consulting invoice"
+     */
+    description: string;
+    /**
+     * Submission date (epoch ms)
+     * @example 1700000000000
+     */
+    date: number;
+    /**
+     * Submission type
+     * @example "Submission"
+     */
+    type: InputVdrvfe8ErzTypeEnum;
+    /**
+     * Invoice number or "N/A"
+     * @minLength 1
+     * @example "INV-2024-001"
+     */
+    invoiceNumber: string;
+    /**
+     * Contract number or "N/A"
+     * @minLength 1
+     * @example "CNTR-001"
+     */
+    contractNumber: string;
+    /**
+     * PO number (optional)
+     * @example "PO-5678"
+     */
+    poNumber?: string;
+    /**
+     * Service invoice line items
+     * @default []
+     */
+    invoices?: {
+        /**
+         * Invoice description
+         * @minLength 1
+         * @example "Consulting services"
+         */
+        description: string;
+        /**
+         * Time worked in hours
+         * @min 0
+         * @exclusiveMin true
+         * @example 8
+         */
+        timeInHours: number;
+        /**
+         * Hourly rate from contractor profile
+         * @min 0
+         * @exclusiveMin true
+         * @example 75
+         */
+        hourlyRate: number;
+        /**
+         * Tax amount
+         * @min 0
+         * @default 0
+         * @example 30
+         */
+        taxAmount?: number;
+        /**
+         * PO number for this invoice
+         * @example "PO-1234"
+         */
+        poNumber?: string;
+        /**
+         * File attachments for this invoice
+         * @default []
+         */
+        attachments?: {
+            /**
+             * Unique file identifier
+             * @example "file-abc123"
+             */
+            fileID: string;
+            /**
+             * Original file name
+             * @example "invoice.pdf"
+             */
+            fileName: string;
+            /**
+             * MIME content type
+             * @example "application/pdf"
+             */
+            contentType: string;
+            /**
+             * File size in bytes
+             * @example 102400
+             */
+            size: number;
+            /**
+             * Upload timestamp (epoch ms)
+             * @example 1700000000000
+             */
+            uploadedOn: number;
+        }[];
+    }[];
+    /**
+     * Expense reimbursement line items
+     * @default []
+     */
+    expenses?: {
+        /**
+         * Expense description
+         * @minLength 1
+         * @example "Hotel stay"
+         */
+        description: string;
+        /**
+         * Expense date (epoch ms)
+         * @example 1700000000000
+         */
+        date: number;
+        /**
+         * Expense type
+         * @example "Accommodation"
+         */
+        type: InputVdrvfe8ErzTypeEnum1;
+        /**
+         * 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?: InputVdrvfe8ErzMealTypeEnum;
+        /**
+         * Number of kilometres (Mileage)
+         * @min 0
+         * @exclusiveMin true
+         * @example 100
+         */
+        numKilometres?: number;
+        /**
+         * Transportation type (Transportation expenses)
+         * @example "Taxi"
+         */
+        transportationType?: InputVdrvfe8ErzTransportationTypeEnum;
+        /**
+         * File attachments for this expense
+         * @default []
+         */
+        attachments?: {
+            /**
+             * Unique file identifier
+             * @example "file-abc123"
+             */
+            fileID: string;
+            /**
+             * Original file name
+             * @example "invoice.pdf"
+             */
+            fileName: string;
+            /**
+             * MIME content type
+             * @example "application/pdf"
+             */
+            contentType: string;
+            /**
+             * File size in bytes
+             * @example 102400
+             */
+            size: number;
+            /**
+             * Upload timestamp (epoch ms)
+             * @example 1700000000000
+             */
+            uploadedOn: number;
+        }[];
+    }[];
+}
+/** Update an existing submission */
+export interface InputY4A9Ylrb3A {
+    /**
+     * Submission description
+     * @minLength 1
+     */
+    description?: string;
+    /** Submission date (epoch ms) */
+    date?: number;
+    /** Submission type */
+    type?: InputY4A9Ylrb3ATypeEnum;
+    /**
+     * Invoice number or "N/A"
+     * @minLength 1
+     */
+    invoiceNumber?: string;
+    /**
+     * Contract number or "N/A"
+     * @minLength 1
+     */
+    contractNumber?: string;
+    /** PO number (optional) */
+    poNumber?: string;
+    /**
+     * Department ID
+     * @minLength 1
+     */
+    departmentID?: string;
+    /** Updated service invoice line items */
+    invoices?: {
+        /**
+         * Invoice description
+         * @minLength 1
+         * @example "Consulting services"
+         */
+        description: string;
+        /**
+         * Time worked in hours
+         * @min 0
+         * @exclusiveMin true
+         * @example 8
+         */
+        timeInHours: number;
+        /**
+         * Hourly rate from contractor profile
+         * @min 0
+         * @exclusiveMin true
+         * @example 75
+         */
+        hourlyRate: number;
+        /**
+         * Tax amount
+         * @min 0
+         * @default 0
+         * @example 30
+         */
+        taxAmount?: number;
+        /**
+         * PO number for this invoice
+         * @example "PO-1234"
+         */
+        poNumber?: string;
+        /**
+         * File attachments for this invoice
+         * @default []
+         */
+        attachments?: {
+            /**
+             * Unique file identifier
+             * @example "file-abc123"
+             */
+            fileID: string;
+            /**
+             * Original file name
+             * @example "invoice.pdf"
+             */
+            fileName: string;
+            /**
+             * MIME content type
+             * @example "application/pdf"
+             */
+            contentType: string;
+            /**
+             * File size in bytes
+             * @example 102400
+             */
+            size: number;
+            /**
+             * Upload timestamp (epoch ms)
+             * @example 1700000000000
+             */
+            uploadedOn: number;
+        }[];
+    }[];
+    /** Updated expense reimbursement line items */
+    expenses?: {
+        /**
+         * Expense description
+         * @minLength 1
+         * @example "Hotel stay"
+         */
+        description: string;
+        /**
+         * Expense date (epoch ms)
+         * @example 1700000000000
+         */
+        date: number;
+        /**
+         * Expense type
+         * @example "Accommodation"
+         */
+        type: InputY4A9Ylrb3ATypeEnum1;
+        /**
+         * 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?: InputY4A9Ylrb3AMealTypeEnum;
+        /**
+         * Number of kilometres (Mileage)
+         * @min 0
+         * @exclusiveMin true
+         * @example 100
+         */
+        numKilometres?: number;
+        /**
+         * Transportation type (Transportation expenses)
+         * @example "Taxi"
+         */
+        transportationType?: InputY4A9Ylrb3ATransportationTypeEnum;
+        /**
+         * File attachments for this expense
+         * @default []
+         */
+        attachments?: {
+            /**
+             * Unique file identifier
+             * @example "file-abc123"
+             */
+            fileID: string;
+            /**
+             * Original file name
+             * @example "invoice.pdf"
+             */
+            fileName: string;
+            /**
+             * MIME content type
+             * @example "application/pdf"
+             */
+            contentType: string;
+            /**
+             * File size in bytes
+             * @example 102400
+             */
+            size: number;
+            /**
+             * Upload timestamp (epoch ms)
+             * @example 1700000000000
+             */
+            uploadedOn: number;
+        }[];
+    }[];
+}
+export interface Input723Ap5Bsp6G {
+    /** Array of codes to assign to the submission sections */
+    codes: {
+        /** The section to assign the code to */
+        section: Input723Ap5Bsp6GSectionEnum;
+        /**
+         * The code ID to assign
+         * @minLength 1
+         * @example "CODE-abc123"
+         */
+        codeID: string;
+        /**
+         * Optional note for this code assignment (max 500 chars)
+         * @maxLength 500
+         * @example "Consulting fees"
+         */
+        note?: string;
+    }[];
+}
+/** Request a presigned upload URL for a file attachment */
+export interface InputSfhiwjjmi4 {
+    /**
+     * ID of the invoice or expense line item
+     * @minLength 1
+     * @example "INV-abc123"
+     */
+    lineItemID: string;
+    /**
+     * MIME content type of the file
+     * @minLength 1
+     * @example "application/pdf"
+     */
+    contentType: string;
+    /**
+     * File size in bytes
+     * @min 0
+     * @exclusiveMin true
+     * @example 102400
+     */
+    contentLength: number;
+    /**
+     * Original file name
+     * @minLength 1
+     * @example "invoice.pdf"
+     */
+    fileName: string;
+}
+export interface InputH1Tu4Knr5H {
+    /**
+     * PO number to set on the submission
+     * @example "PO-5678"
+     */
+    poNumber: string;
+}
+export interface InputPqfe8Di61L {
+    /**
+     * The ID of the new department to reassign to
+     * @minLength 1
+     * @example "DEPT-abc123"
+     */
+    departmentID: string;
+}
+export interface InputX2Sjifbplw {
+    /**
+     * Google reCAPTCHA verification token
+     * @example "03AGdBq26..."
+     */
+    recaptchaToken: string;
+    /**
+     * Guest contractor name
+     * @minLength 1
+     * @example "Jane Smith"
+     */
+    name: string;
+    /**
+     * Guest contractor email address
+     * @format email
+     * @example "jane@example.com"
+     */
+    email: string;
+    /**
+     * Guest contractor phone number
+     * @minLength 1
+     * @example "604-555-0100"
+     */
+    phone: string;
+    /**
+     * Invoice date (timestamp)
+     * @example 1700000000000
+     */
+    date: number;
+    /**
+     * Invoice description
+     * @minLength 1
+     * @example "Safety consulting services"
+     */
+    description: string;
+    /**
+     * Department to assign the submission to
+     * @minLength 1
+     * @example "DEPT-abc123"
+     */
+    departmentID: string;
+    /**
+     * Invoice amount in dollars (pre-tax)
+     * @min 0
+     * @exclusiveMin true
+     * @example 500
+     */
+    amount: number;
+    /**
+     * Tax amount in dollars
+     * @min 0
+     * @default 0
+     * @example 25
+     */
+    taxAmount?: number;
+    /** Single PDF attachment (max 1 MB) */
+    attachment: {
+        /**
+         * Unique file identifier
+         * @example "file-abc123"
+         */
+        fileID: string;
+        /**
+         * Original file name
+         * @example "invoice.pdf"
+         */
+        fileName: string;
+        /**
+         * Content type (must be application/pdf for guest)
+         * @example "application/pdf"
+         */
+        contentType: InputX2SjifbplwContentTypeEnum;
+        /**
+         * File size in bytes (max 1 MB)
+         * @max 1048576
+         * @example 51200
+         */
+        size: number;
+        /**
+         * Upload timestamp
+         * @example 1700000000000
+         */
+        uploadedOn: number;
+    };
+}
+/**
+ * The contractor's local status. Set to 'active' to enable or 'disabled' to disable the account.
+ * @example "active"
+ */
+export declare enum InputKfp90IvmguStatusEnum {
+    Active = "active",
+    Disabled = "disabled"
+}
+/**
+ * Submission type
+ * @example "Submission"
+ */
+export declare enum InputVdrvfe8ErzTypeEnum {
+    Submission = "Submission",
+    Reimbursement = "Reimbursement"
+}
+/**
+ * Expense type
+ * @example "Accommodation"
+ */
+export declare enum InputVdrvfe8ErzTypeEnum1 {
+    Accommodation = "Accommodation",
+    Meal = "Meal",
+    Mileage = "Mileage",
+    Transportation = "Transportation",
+    Other = "Other"
+}
+/**
+ * Meal type (Meal expenses)
+ * @example "Lunch"
+ */
+export declare enum InputVdrvfe8ErzMealTypeEnum {
+    Breakfast = "Breakfast",
+    Lunch = "Lunch",
+    Dinner = "Dinner"
+}
+/**
+ * Transportation type (Transportation expenses)
+ * @example "Taxi"
+ */
+export declare enum InputVdrvfe8ErzTransportationTypeEnum {
+    AirTravel = "Air travel",
+    Taxi = "Taxi",
+    Ferry = "Ferry",
+    Rental = "Rental",
+    Other = "Other"
+}
+/** Submission type */
+export declare enum InputY4A9Ylrb3ATypeEnum {
+    Submission = "Submission",
+    Reimbursement = "Reimbursement"
+}
+/**
+ * Expense type
+ * @example "Accommodation"
+ */
+export declare enum InputY4A9Ylrb3ATypeEnum1 {
+    Accommodation = "Accommodation",
+    Meal = "Meal",
+    Mileage = "Mileage",
+    Transportation = "Transportation",
+    Other = "Other"
+}
+/**
+ * Meal type (Meal expenses)
+ * @example "Lunch"
+ */
+export declare enum InputY4A9Ylrb3AMealTypeEnum {
+    Breakfast = "Breakfast",
+    Lunch = "Lunch",
+    Dinner = "Dinner"
+}
+/**
+ * Transportation type (Transportation expenses)
+ * @example "Taxi"
+ */
+export declare enum InputY4A9Ylrb3ATransportationTypeEnum {
+    AirTravel = "Air travel",
+    Taxi = "Taxi",
+    Ferry = "Ferry",
+    Rental = "Rental",
+    Other = "Other"
+}
+/** The section to assign the code to */
+export declare enum Input723Ap5Bsp6GSectionEnum {
+    Service = "Service",
+    Reimbursement = "Reimbursement"
+}
+/**
+ * Content type (must be application/pdf for guest)
+ * @example "application/pdf"
+ */
+export declare enum InputX2SjifbplwContentTypeEnum {
+    ApplicationPdf = "application/pdf"
+}
+export type CreateCodeData = any;
+export type CreateCodeError = ErrorResponse;
+export type UpdateCodeData = any;
+export type UpdateCodeError = ErrorResponse;
+export type DeleteCodeData = any;
+export type DeleteCodeError = ErrorResponse;
+export type ListCodesData = any;
+export type ListCodesError = ErrorResponse;
+export type CreateContractorData = any;
+export type CreateContractorError = ErrorResponse;
+export type GetContractorData = any;
+export type GetContractorError = ErrorResponse;
+export type UpdateRatesData = any;
+export type UpdateRatesError = ErrorResponse;
+export type CreateResetPasswordData = any;
+export type CreateResetPasswordError = ErrorResponse;
+export type UpdateStatusData = any;
+export type UpdateStatusError = ErrorResponse;
+export interface ListContractorsParams {
+    /**
+     * Search term (minimum 2 characters)
+     * @minLength 2
+     * @example "john"
+     */
+    q: string;
+    /**
+     * Search field type: name for begins_with match, email for exact match
+     * @example "name"
+     */
+    type: TypeEnum;
+}
+/**
+ * Search field type: name for begins_with match, email for exact match
+ * @example "name"
+ */
+export declare enum TypeEnum {
+    Name = "name",
+    Email = "email"
+}
+export type ListContractorsData = any;
+export type ListContractorsError = ErrorResponse;
+/**
+ * Search field type: name for begins_with match, email for exact match
+ * @example "name"
+ */
+export declare enum ListContractorsParams1TypeEnum {
+    Name = "name",
+    Email = "email"
+}
+export type CreateDepartmentData = any;
+export type CreateDepartmentError = ErrorResponse;
+export type UpdateDepartmentData = any;
+export type UpdateDepartmentError = ErrorResponse;
+export type DeleteDepartmentData = any;
+export type DeleteDepartmentError = ErrorResponse;
+export type CreateAdminData = any;
+export type CreateAdminError = ErrorResponse;
+export type DeleteAdminData = any;
+export type DeleteAdminError = ErrorResponse;
+export type ListDepartmentsData = any;
+export type ListDepartmentsError = ErrorResponse;
+export type ListSettingsData = any;
+export type ListSettingsError = ErrorResponse;
+export type UpdateRatesResult = any;
+export type UpdateRatesFail = ErrorResponse;
+export type UpdateMaximumsData = any;
+export type UpdateMaximumsError = ErrorResponse;
+export type UpdateRemindersData = any;
+export type UpdateRemindersError = ErrorResponse;
+export type CreateSubmissionData = any;
+export type CreateSubmissionError = ErrorResponse;
+export type GetSubmissionData = any;
+export type GetSubmissionError = ErrorResponse;
+export type UpdateSubmissionData = any;
+export type UpdateSubmissionError = ErrorResponse;
+export type DeleteSubmissionData = any;
+export type DeleteSubmissionError = ErrorResponse;
+export type CreateApproveData = any;
+export type CreateApproveError = ErrorResponse;
+export type UpdateCodesData = any;
+export type UpdateCodesError = ErrorResponse;
+export type CreateFileData = any;
+export type CreateFileError = ErrorResponse;
+export type GetFileData = any;
+export type GetFileError = ErrorResponse;
+export type CreatePaidData = any;
+export type CreatePaidError = ErrorResponse;
+export type GetPdfData = any;
+export type GetPdfError = ErrorResponse;
+export type PutSubmissionData = any;
+export type PutSubmissionError = ErrorResponse;
+export type CreateReassignData = any;
+export type CreateReassignError = ErrorResponse;
+export type CreateRejectData = any;
+export type CreateRejectError = ErrorResponse;
+export type CreateSubmitData = any;
+export type CreateSubmitError = ErrorResponse;
+export type CreateGuestData = any;
+export type CreateGuestError = ErrorResponse;
+export interface ListSubmissionsParams {
+    /**
+     * Filter by submission status
+     * @example "Submitted"
+     */
+    status?: StatusEnum;
+    /**
+     * Filter by department ID
+     * @example "DEPT-abc123"
+     */
+    departmentID?: string;
+    /**
+     * Filter by contractor user ID
+     * @example "USR-xyz789"
+     */
+    contractorID?: string;
+    /**
+     * Filter by submission type
+     * @example "Submission"
+     */
+    type?: TypeEnum1;
+    /**
+     * Filter from date (epoch ms)
+     * @example 1700000000000
+     */
+    fromDate?: number | null;
+    /**
+     * Filter to date (epoch ms)
+     * @example 1710000000000
+     */
+    toDate?: number | null;
+    /** Pagination cursor from previous response */
+    cursor?: string;
+    /**
+     * Number of results per page (max 50)
+     * @min 1
+     * @max 50
+     * @default 50
+     * @example 50
+     */
+    limit?: number;
+}
+/**
+ * Filter by submission status
+ * @example "Submitted"
+ */
+export declare enum StatusEnum {
+    Draft = "Draft",
+    Submitted = "Submitted",
+    AdministratorApproved = "Administrator_Approved",
+    Rejected = "Rejected",
+    PaymentPending = "Payment_Pending",
+    Paid = "Paid"
+}
+/**
+ * Filter by submission type
+ * @example "Submission"
+ */
+export declare enum TypeEnum1 {
+    Submission = "Submission",
+    Reimbursement = "Reimbursement"
+}
+export type ListSubmissionsData = any;
+export type ListSubmissionsError = ErrorResponse;
+/**
+ * Filter by submission status
+ * @example "Submitted"
+ */
+export declare enum ListSubmissionsParams1StatusEnum {
+    Draft = "Draft",
+    Submitted = "Submitted",
+    AdministratorApproved = "Administrator_Approved",
+    Rejected = "Rejected",
+    PaymentPending = "Payment_Pending",
+    Paid = "Paid"
+}
+/**
+ * Filter by submission type
+ * @example "Submission"
+ */
+export declare enum ListSubmissionsParams1TypeEnum {
+    Submission = "Submission",
+    Reimbursement = "Reimbursement"
+}
+export type ListExportData = any;
+export type ListExportError = ErrorResponse;
+import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
+export type QueryParamsType = Record<string | number, any>;
+export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
+    /** set parameter to `true` for call `securityWorker` for this request */
+    secure?: boolean;
+    /** request path */
+    path: string;
+    /** content type of request body */
+    type?: ContentType;
+    /** query params */
+    query?: QueryParamsType;
+    /** format of response (i.e. response.json() -> format: "json") */
+    format?: ResponseType;
+    /** request body */
+    body?: unknown;
+}
+export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
+    secure?: boolean;
+    format?: ResponseType;
+}
+export declare enum ContentType {
+    Json = "application/json",
+    FormData = "multipart/form-data",
+    UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain"
+}
+export declare class HttpClient<SecurityDataType = unknown> {
+    instance: AxiosInstance;
+    private securityData;
+    private securityWorker?;
+    private secure?;
+    private format?;
+    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
+    setSecurityData: (data: SecurityDataType | null) => void;
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
+    protected stringifyFormItem(formItem: unknown): string;
+    protected createFormData(input: Record<string, unknown>): FormData;
+    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
+}
+/**
+ * @title Contractor Module API
+ * @version 1.0.1
+ * @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: Input5Sa03P3Swr, params?: RequestParams) => Promise<any>;
+        /**
+         * @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: Input6Szg153Vfz, 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.
+         *
+         * @tags Codes
+         * @name DeleteCode
+         * @summary Delete Code
+         * @request DELETE:/code/{codeID}
+         * @secure
+         */
+        deleteCode: (codeId: string, params?: RequestParams) => Promise<any>;
+    };
+    codes: {
+        /**
+         * @description Returns all codes or codes filtered by department. Administrators and above can list codes.
+         *
+         * @tags Codes
+         * @name ListCodes
+         * @summary List Codes
+         * @request GET:/codes
+         * @secure
+         */
+        listCodes: (params?: RequestParams) => Promise<any>;
+    };
+    contractor: {
+        /**
+         * @description Creates a new contractor account. Requires a unique email address and at least one job rate. Only Administrators and Super Administrators can create contractor accounts.
+         *
+         * @tags Contractors
+         * @name CreateContractor
+         * @summary Create Contractor
+         * @request POST:/contractor
+         * @secure
+         */
+        createContractor: (data: InputWt47Z10Aoc, params?: RequestParams) => Promise<any>;
+        /**
+         * @description View a contractor profile. Contractors can view their own profile (includes effective rates). Administrators can view any contractor profile.
+         *
+         * @tags Contractors
+         * @name GetContractor
+         * @summary View Contractor Profile
+         * @request GET:/contractor/{userID}
+         * @secure
+         */
+        getContractor: (userId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Sets user-specific rate maximums for a contractor. Only Administrators and Super Administrators can set rates. Values must be positive numbers with up to two decimal places.
+         *
+         * @tags Contractors
+         * @name UpdateRates
+         * @summary Set Contractor Rates
+         * @request PUT:/contractor/{userID}/rates
+         * @secure
+         */
+        updateRates: (userId: string, data: InputZ2Opzvmwkr, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Triggers a password reset for the specified contractor. Only Administrators and Super Administrators can trigger password resets.
+         *
+         * @tags Contractors
+         * @name CreateResetPassword
+         * @summary Reset Contractor Password
+         * @request POST:/contractor/{userID}/reset-password
+         * @secure
+         */
+        createResetPassword: (userId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Sets a contractor's local status to active or disabled. Disabling prevents all API access while preserving the IDM account. Only Administrators and Super Administrators can toggle status.
+         *
+         * @tags Contractors
+         * @name UpdateStatus
+         * @summary Enable/Disable Contractor
+         * @request PUT:/contractor/{userID}/status
+         * @secure
+         */
+        updateStatus: (userId: string, data: InputKfp90Ivmgu, params?: RequestParams) => Promise<any>;
+    };
+    contractors: {
+        /**
+         * @description Search contractors by name (partial match) or email (exact match). Minimum 2 characters required.
+         *
+         * @tags Contractors
+         * @name ListContractors
+         * @summary Search Contractors
+         * @request GET:/contractors
+         * @secure
+         */
+        listContractors: (query: ListContractorsParams, params?: RequestParams) => Promise<any>;
+    };
+    department: {
+        /**
+         * @description Creates a new department. Requires a name (1-150 chars) and contact emails (max 10). SYSADMIN only.
+         *
+         * @tags Departments
+         * @name CreateDepartment
+         * @summary Create Department
+         * @request POST:/department
+         * @secure
+         */
+        createDepartment: (data: InputNzq8Jtcdc2, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Updates an existing department name and/or contact emails. SYSADMIN only.
+         *
+         * @tags Departments
+         * @name UpdateDepartment
+         * @summary Update Department
+         * @request PUT:/department/{departmentID}
+         * @secure
+         */
+        updateDepartment: (departmentId: string, data: InputLxhfu0Cggl, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Deletes a department. Prevents deletion if department has active codes or associated administrators. SYSADMIN only.
+         *
+         * @tags Departments
+         * @name DeleteDepartment
+         * @summary Delete Department
+         * @request DELETE:/department/{departmentID}
+         * @secure
+         */
+        deleteDepartment: (departmentId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Associates an administrator with a department. Each administrator can only belong to one department. SYSADMIN only.
+         *
+         * @tags Departments
+         * @name CreateAdmin
+         * @summary Associate Admin with Department
+         * @request POST:/department/{departmentID}/admin
+         * @secure
+         */
+        createAdmin: (departmentId: string, data: InputSfun2X2Orx, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Removes an administrator association from a department. SYSADMIN only.
+         *
+         * @tags Departments
+         * @name DeleteAdmin
+         * @summary Remove Admin from Department
+         * @request DELETE:/department/{departmentID}/admin/{userID}
+         * @secure
+         */
+        deleteAdmin: (departmentId: string, userId: string, params?: RequestParams) => Promise<any>;
+    };
+    departments: {
+        /**
+         * @description Returns all departments. Available to ADMIN and SYSADMIN users.
+         *
+         * @tags Departments
+         * @name ListDepartments
+         * @summary List All Departments
+         * @request GET:/departments
+         * @secure
+         */
+        listDepartments: (params?: RequestParams) => Promise<any>;
+    };
+    settings: {
+        /**
+         * @description Retrieves system settings. Administrators have read-only access. Super Administrators have full access.
+         *
+         * @tags Settings
+         * @name ListSettings
+         * @summary Get System Settings
+         * @request GET:/settings
+         * @secure
+         */
+        listSettings: (params?: RequestParams) => Promise<any>;
+        /**
+         * @description Updates the system-wide mileage rate. Only Super Administrators can modify system settings.
+         *
+         * @tags Settings
+         * @name UpdateRates
+         * @summary Update Mileage Rate
+         * @request PUT:/settings/rates
+         * @secure
+         */
+        updateRates: (data: InputJ71Z8Sh3A4, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Updates all system-wide expense maximums (accommodation, meals, transportation). Only Super Administrators can modify system settings.
+         *
+         * @tags Settings
+         * @name UpdateMaximums
+         * @summary Update Expense Maximums
+         * @request PUT:/settings/maximums
+         * @secure
+         */
+        updateMaximums: (data: InputR2Nacgh1Y4, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Updates the reminder interval (in days) for pending submission notifications. Only Super Administrators can modify system settings.
+         *
+         * @tags Settings
+         * @name UpdateReminders
+         * @summary Update Reminder Interval
+         * @request PUT:/settings/reminders
+         * @secure
+         */
+        updateReminders: (data: Input3Q3Xamu93G, params?: RequestParams) => Promise<any>;
+    };
+    submission: {
+        /**
+         * @description Creates a new draft submission for the authenticated contractor. Validates invoice number uniqueness, calculates totals, and validates expenses against configured maximums.
+         *
+         * @tags Submissions
+         * @name CreateSubmission
+         * @summary Create draft submission
+         * @request POST:/submission
+         * @secure
+         */
+        createSubmission: (data: InputVdrvfe8Erz, 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.
+         *
+         * @tags Submissions
+         * @name GetSubmission
+         * @summary View submission detail
+         * @request GET:/submission/{submissionID}
+         * @secure
+         */
+        getSubmission: (submissionId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @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}
+         * @secure
+         */
+        updateSubmission: (submissionId: string, data: InputY4A9Ylrb3A, 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.
+         *
+         * @tags Submissions
+         * @name DeleteSubmission
+         * @summary Delete submission
+         * @request DELETE:/submission/{submissionID}
+         * @secure
+         */
+        deleteSubmission: (submissionId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @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
+         * @secure
+         */
+        createApprove: (submissionId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @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
+         * @secure
+         */
+        updateCodes: (submissionId: string, data: Input723Ap5Bsp6G, 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.
+         *
+         * @tags Submissions
+         * @name CreateFile
+         * @summary Get presigned upload URL for a file attachment
+         * @request POST:/submission/{submissionID}/file
+         * @secure
+         */
+        createFile: (submissionId: string, data: InputSfhiwjjmi4, params?: RequestParams) => Promise<any>;
+        /**
+         * @description Returns a presigned S3 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}
+         * @secure
+         */
+        getFile: (submissionId: string, fileId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @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
+         * @secure
+         */
+        createPaid: (submissionId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @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
+         * @secure
+         */
+        getPdf: (submissionId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @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
+         * @secure
+         */
+        putSubmission: (submissionId: string, data: InputH1Tu4Knr5H, 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.
+         *
+         * @tags Submissions
+         * @name CreateReassign
+         * @summary Reassign submission to a different department
+         * @request POST:/submission/{submissionID}/reassign
+         * @secure
+         */
+        createReassign: (submissionId: string, data: InputPqfe8Di61L, 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.
+         *
+         * @tags Submissions
+         * @name CreateReject
+         * @summary Reject a submission
+         * @request POST:/submission/{submissionID}/reject
+         * @secure
+         */
+        createReject: (submissionId: string, params?: RequestParams) => Promise<any>;
+        /**
+         * @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
+         * @secure
+         */
+        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).
+         *
+         * @tags Submissions
+         * @name CreateGuest
+         * @summary Submit guest invoice
+         * @request POST:/submission/guest
+         * @secure
+         */
+        createGuest: (data: InputX2Sjifbplw, params?: RequestParams) => Promise<any>;
+    };
+    submissions: {
+        /**
+         * @description Search submissions with role-based scoping. Contractors see only their own submissions. Administrators see submissions for their department. Accountants and Super Administrators see all submissions.
+         *
+         * @tags Submissions
+         * @name ListSubmissions
+         * @summary Search Submissions
+         * @request GET:/submissions
+         * @secure
+         */
+        listSubmissions: (query: ListSubmissionsParams, params?: RequestParams) => Promise<any>;
+        /**
+         * @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.
+         *
+         * @tags Submissions
+         * @name ListExport
+         * @summary Export Submissions to Excel
+         * @request GET:/submissions/export
+         * @secure
+         */
+        listExport: (params?: RequestParams) => Promise<any>;
+    };
+}