servicem8 1.0.0 → 1.1.0

package/dist/cjs/api/types/JobAllocationCreate.d.ts

@@ -1,36 +1,36 @@
 export interface JobAllocationCreate {
     /** The UUID of the job that this allocation relates to. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** DEPRECATED */
-    queueUuid?: unknown;
+    queue_uuid?: unknown | undefined;
     /** The UUID of the staff member this job is allocated to. */
-    staffUuid?: string;
+    staff_uuid?: string | undefined;
     /** The minimum start date for a job allocation to be completed by a staff member. Setting this date will ensure the job allocation appears in the future on staff schedules. */
-    allocationDate?: string;
+    allocation_date?: string | undefined;
     /** The UUID of the allocation window that defines when the job should be completed (e.g. Urgent, Early Morning, During Business Hours). */
-    allocationWindowUuid?: string;
+    allocation_window_uuid?: string | undefined;
     /** The UUID of the staff member who allocated the job. */
-    allocatedByStaffUuid?: string;
+    allocated_by_staff_uuid?: string | undefined;
     /** The timestamp when the job was allocated. */
-    allocatedTimestamp?: string;
+    allocated_timestamp?: string | undefined;
     /** The timestamp when the job allocation expires. */
-    expiryTimestamp?: string;
+    expiry_timestamp?: string | undefined;
     /** The timestamp when the job allocation was read by the staff member. */
-    readTimestamp?: string;
+    read_timestamp?: string | undefined;
     /** The timestamp when the job allocation was marked as completed. */
-    completionTimestamp?: string;
+    completion_timestamp?: string | undefined;
     /** DEPRECATED */
-    estimatedDuration?: unknown;
+    estimated_duration?: unknown | undefined;
     /** DEPRECATED */
-    revisedDuration?: unknown;
+    revised_duration?: unknown | undefined;
     /** The sort priority for displaying this job allocation. */
-    sortPriority?: string;
+    sort_priority?: string | undefined;
     /** DEPRECATED */
-    requiresAcceptance?: unknown;
+    requires_acceptance?: unknown | undefined;
     /** DEPRECATED */
-    acceptanceStatus?: unknown;
+    acceptance_status?: unknown | undefined;
     /** DEPRECATED */
-    acceptanceTimestamp?: unknown;
+    acceptance_timestamp?: unknown | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
 }

package/dist/cjs/api/types/JobChecklist.d.ts

@@ -1,44 +1,44 @@
 export interface JobChecklist {
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** Record active/deleted flag.  Valid values are [0,1] */
-    active?: number;
+    active?: number | undefined;
     /** Timestamp at which record was last modified */
-    editDate?: unknown;
+    edit_date?: unknown | undefined;
     /** UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** The name or description of the checklist item. This is displayed to users in the mobile app and web interface. */
-    name?: string;
+    name?: string | undefined;
     /** The section or category name under which this checklist item is grouped. This helps organize related checklist items together. */
-    sectionName?: string;
+    section_name?: string | undefined;
     /** The type of checklist item. Valid values are: 'Todo', 'Asset', 'Photo', 'Form', and 'Document'. Defaults to 'Todo' if not specified. This determines the functionality and appearance of the checklist item. */
-    itemType?: string;
+    item_type?: string | undefined;
     /** A numeric value determining the order in which checklist items appear in the user interface. Lower values appear first. Used to customize the display sequence of items. */
-    sortOrder?: number;
+    sort_order?: number | undefined;
     /** The date and time when the checklist item was marked as completed. Empty or '0000-00-00 00:00:00' indicates the item is not completed. */
-    completedTimestamp?: string;
+    completed_timestamp?: string | undefined;
     /** UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed. */
-    completedByStaffUuid?: string;
+    completed_by_staff_uuid?: string | undefined;
     /** UUID of the job check-in during which this checklist item was completed. This links the checklist completion to a specific check-in event in the job history. */
-    completedDuringCheckinUuid?: string;
+    completed_during_checkin_uuid?: string | undefined;
     /** The type of reminder associated with this checklist item. Valid values are: '' (no reminder), 'CHECK_IN', 'NAVIGATE', 'CHECK_OUT', 'ABSOLUTE_DATETIME', or 'RELATIVE_DATETIME'. Determines when the system will remind users about this checklist item. */
-    reminderType?: string;
+    reminder_type?: string | undefined;
     /** JSON data containing additional information for the reminder. Format depends on the reminder_type. For ABSOLUTE_DATETIME, includes 'absoluteDateTime'. For RELATIVE_DATETIME, includes 'relativeDateTime' with 'baseDate', 'unit', and 'quantity'. Exposed via API as 'reminder_data'. */
-    reminderData?: string;
+    reminder_data?: string | undefined;
     /** The type of object which this checklist item is related to. For example, for Form checklists, this will be 'Form'. */
-    regardingObject?: string;
+    regarding_object?: string | undefined;
     /** The UUID of the object which this checklists item is related to. For example, for Form checklists, this is the UUID of the Form that must be completed to complete the checklist item. */
-    regardingObjectUuid?: string;
+    regarding_object_uuid?: string | undefined;
     /** The type of object which completes this checklist item. For example, for Form checklists, this will be 'FormResponse'. */
-    fulfilledByObjectName?: string;
+    fulfilled_by_object_name?: string | undefined;
     /** The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record. */
-    fulfilledByObjectUuid?: string;
+    fulfilled_by_object_uuid?: string | undefined;
     /** JSON array of staff UUIDs to whom this checklist item is assigned. Determines which staff members are responsible for completing this checklist item. Currently limited to a maximum of 1 staff member. */
-    assignedToStaffUuids?: string[];
+    assigned_to_staff_uuids?: string[] | undefined;
     /** If this checklist item is locked (read-only) and cannot be modified. This is set by the system when the checklist item is created from a Task or Network Request. (Read only).  Valid values are [0,1] */
-    isLocked?: number;
+    is_locked?: number | undefined;
     /** The timestamp when the checklist item was assigned to the staff member. (Read only) */
-    assignedTimestamp?: string;
+    assigned_timestamp?: string | undefined;
     /** The UUID of the staff member who assigned the checklist item to the staff member. (Read only) */
-    assignedByStaffUuid?: string;
+    assigned_by_staff_uuid?: string | undefined;
 }

package/dist/cjs/api/types/JobChecklistCreate.d.ts

@@ -1,34 +1,34 @@
 export interface JobChecklistCreate {
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** The name or description of the checklist item. This is displayed to users in the mobile app and web interface. */
-    name?: string;
+    name?: string | undefined;
     /** The section or category name under which this checklist item is grouped. This helps organize related checklist items together. */
-    sectionName?: string;
+    section_name?: string | undefined;
     /** The type of checklist item. Valid values are: 'Todo', 'Asset', 'Photo', 'Form', and 'Document'. Defaults to 'Todo' if not specified. This determines the functionality and appearance of the checklist item. */
-    itemType?: string;
+    item_type?: string | undefined;
     /** A numeric value determining the order in which checklist items appear in the user interface. Lower values appear first. Used to customize the display sequence of items. */
-    sortOrder?: number;
+    sort_order?: number | undefined;
     /** The date and time when the checklist item was marked as completed. Empty or '0000-00-00 00:00:00' indicates the item is not completed. */
-    completedTimestamp?: string;
+    completed_timestamp?: string | undefined;
     /** UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed. */
-    completedByStaffUuid?: string;
+    completed_by_staff_uuid?: string | undefined;
     /** UUID of the job check-in during which this checklist item was completed. This links the checklist completion to a specific check-in event in the job history. */
-    completedDuringCheckinUuid?: string;
+    completed_during_checkin_uuid?: string | undefined;
     /** The type of reminder associated with this checklist item. Valid values are: '' (no reminder), 'CHECK_IN', 'NAVIGATE', 'CHECK_OUT', 'ABSOLUTE_DATETIME', or 'RELATIVE_DATETIME'. Determines when the system will remind users about this checklist item. */
-    reminderType?: string;
+    reminder_type?: string | undefined;
     /** JSON data containing additional information for the reminder. Format depends on the reminder_type. For ABSOLUTE_DATETIME, includes 'absoluteDateTime'. For RELATIVE_DATETIME, includes 'relativeDateTime' with 'baseDate', 'unit', and 'quantity'. Exposed via API as 'reminder_data'. */
-    reminderData?: string;
+    reminder_data?: string | undefined;
     /** The type of object which this checklist item is related to. For example, for Form checklists, this will be 'Form'. */
-    regardingObject?: string;
+    regarding_object?: string | undefined;
     /** The UUID of the object which this checklists item is related to. For example, for Form checklists, this is the UUID of the Form that must be completed to complete the checklist item. */
-    regardingObjectUuid?: string;
+    regarding_object_uuid?: string | undefined;
     /** The type of object which completes this checklist item. For example, for Form checklists, this will be 'FormResponse'. */
-    fulfilledByObjectName?: string;
+    fulfilled_by_object_name?: string | undefined;
     /** The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record. */
-    fulfilledByObjectUuid?: string;
+    fulfilled_by_object_uuid?: string | undefined;
     /** JSON array of staff UUIDs to whom this checklist item is assigned. Determines which staff members are responsible for completing this checklist item. Currently limited to a maximum of 1 staff member. */
-    assignedToStaffUuids?: string[];
+    assigned_to_staff_uuids?: string[] | undefined;
 }

package/dist/cjs/api/types/JobContact.d.ts

@@ -1,24 +1,24 @@
 export interface JobContact {
     /** UUID of the job this contact is associated with. Each job contact must be linked to a valid job in the system. This field cannot be changed once set. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** First name of the job contact. This information is synced with the job's contact information fields depending on the contact type. */
-    first?: string;
+    first?: string | undefined;
     /** Last name of the job contact. This information is synced with the job's contact information fields depending on the contact type. */
-    last?: string;
+    last?: string | undefined;
     /** Landline or office phone number of the job contact. Format is flexible but should represent a valid phone number. This field syncs with the job's phone_1 field for job contacts or phone_2 field for billing contacts. */
-    phone?: string;
+    phone?: string | undefined;
     /** Mobile phone number of the job contact. Format is flexible but should represent a valid mobile number. This field syncs with the job's mobile field for job contacts or billing_mobile field for billing contacts. */
-    mobile?: string;
+    mobile?: string | undefined;
     /** Email address of the job contact. Should be a valid email format. Used for sending job-related communications. This field syncs with the job's email field for job contacts or billing_email field for billing contacts. */
-    email?: string;
+    email?: string | undefined;
     /** Type of contact relationship to the job. Valid values are: 'JOB' (or 'Job Contact'), 'BILLING' (or 'Billing Contact'), or 'Property Manager'. Controls which job fields are updated when this contact record changes. */
-    type?: string;
+    type?: string | undefined;
     /** DEPRECATED */
-    isPrimaryContact?: unknown;
+    is_primary_contact?: unknown | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** Record active/deleted flag.  Valid values are [0,1] */
-    active?: number;
+    active?: number | undefined;
     /** Timestamp at which record was last modified */
-    editDate?: unknown;
+    edit_date?: unknown | undefined;
 }

package/dist/cjs/api/types/JobContactCreate.d.ts

@@ -1,20 +1,20 @@
 export interface JobContactCreate {
     /** UUID of the job this contact is associated with. Each job contact must be linked to a valid job in the system. This field cannot be changed once set. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** First name of the job contact. This information is synced with the job's contact information fields depending on the contact type. */
-    first?: string;
+    first?: string | undefined;
     /** Last name of the job contact. This information is synced with the job's contact information fields depending on the contact type. */
-    last?: string;
+    last?: string | undefined;
     /** Landline or office phone number of the job contact. Format is flexible but should represent a valid phone number. This field syncs with the job's phone_1 field for job contacts or phone_2 field for billing contacts. */
-    phone?: string;
+    phone?: string | undefined;
     /** Mobile phone number of the job contact. Format is flexible but should represent a valid mobile number. This field syncs with the job's mobile field for job contacts or billing_mobile field for billing contacts. */
-    mobile?: string;
+    mobile?: string | undefined;
     /** Email address of the job contact. Should be a valid email format. Used for sending job-related communications. This field syncs with the job's email field for job contacts or billing_email field for billing contacts. */
-    email?: string;
+    email?: string | undefined;
     /** Type of contact relationship to the job. Valid values are: 'JOB' (or 'Job Contact'), 'BILLING' (or 'Billing Contact'), or 'Property Manager'. Controls which job fields are updated when this contact record changes. */
-    type?: string;
+    type?: string | undefined;
     /** DEPRECATED */
-    isPrimaryContact?: unknown;
+    is_primary_contact?: unknown | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
 }

package/dist/cjs/api/types/JobCreate.d.ts

@@ -1,89 +1,98 @@
-import type * as ServiceM8 from "../index.js";
 export interface JobCreate {
     /** UUID of the staff member who created this job. Records which staff member initially added the job to the system. */
-    createdByStaffUuid?: string;
+    created_by_staff_uuid?: string | undefined;
     /** The date the job was created or scheduled. Used for organizing jobs chronologically and for reference in reports. */
-    date?: string;
+    date?: string | undefined;
     /** UUID reference to the client/company record associated with this job. Links the job to a client in the system, establishing the client-job relationship for billing and contact purposes. */
-    companyUuid?: string;
+    company_uuid?: string | undefined;
     /** The address where invoices and billing information should be sent. If not specified, defaults to the job address. */
-    billingAddress?: string;
+    billing_address?: string | undefined;
     /** Current status of the job. Controls where the Job appears in the Dispatch Board..  Valid values are [Quote,Work Order,Unsuccessful,Completed] */
-    status: ServiceM8.JobCreateStatus;
+    status: JobCreate.Status;
     /** Longitude coordinate of the job location. Used for mapping and geolocation features. This is automatically populated based on the job address through geocoding. */
-    lng?: unknown;
+    lng?: unknown | undefined;
     /** Latitude coordinate of the job location. Used for mapping and geolocation features. This is automatically populated based on the job address through geocoding. */
-    lat?: unknown;
+    lat?: unknown | undefined;
     /** Not used. Refer to JobPayment endpoint. */
-    paymentDate?: string;
+    payment_date?: string | undefined;
     /** Not used. Refer to JobPayment endpoint. */
-    paymentActionedByUuid?: string;
+    payment_actioned_by_uuid?: string | undefined;
     /** Not used. Refer to JobPayment endpoint. */
-    paymentMethod?: string;
+    payment_method?: string | undefined;
     /** Not used. Refer to JobPayment endpoint. */
-    paymentAmount?: string;
+    payment_amount?: string | undefined;
     /** UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department. */
-    categoryUuid?: string;
+    category_uuid?: string | undefined;
     /** Not used. Refer to JobPayment endpoint. */
-    paymentNote?: string;
+    payment_note?: string | undefined;
     /** Indicates whether the geocoding for the job address was successful. When true, the latitude and longitude coordinates are considered accurate for mapping and location-based features. */
-    geoIsValid?: unknown;
+    geo_is_valid?: unknown | undefined;
     /** Client purchase order reference number for this job. Used for cross-referencing with external accounting or order management systems. */
-    purchaseOrderNumber?: string;
+    purchase_order_number?: string | undefined;
     /** Indicates whether an invoice has been sent for this job..  Valid values are [0,1] */
-    invoiceSent?: number;
+    invoice_sent?: number | undefined;
     /** Timestamp when the invoice was sent to the client. Format is YYYY-MM-DD HH:MM:SS. */
-    invoiceSentStamp?: unknown;
+    invoice_sent_stamp?: unknown | undefined;
     /** The date the invoice was issued. This determines when payment is due based on the client's payment terms. Automatically set when a job is completed or manually when invoice is created. */
-    invoiceDate?: string;
+    invoice_date?: string | undefined;
     /** DEPRECATED */
-    readyToInvoice?: unknown;
+    ready_to_invoice?: unknown | undefined;
     /** DEPRECATED */
-    readyToInvoiceStamp?: unknown;
+    ready_to_invoice_stamp?: unknown | undefined;
     /** The country component extracted from the geocoded job address. Automatically populated when an address is geocoded. */
-    geoCountry?: unknown;
+    geo_country?: unknown | undefined;
     /** The postal/zip code component extracted from the geocoded job address. Automatically populated when an address is geocoded. */
-    geoPostcode?: unknown;
+    geo_postcode?: unknown | undefined;
     /** The state/province component extracted from the geocoded job address. Automatically populated when an address is geocoded. */
-    geoState?: unknown;
+    geo_state?: unknown | undefined;
     /** The city/locality component extracted from the geocoded job address. Automatically populated when an address is geocoded. */
-    geoCity?: unknown;
+    geo_city?: unknown | undefined;
     /** The street name component extracted from the geocoded job address. Automatically populated when an address is geocoded. */
-    geoStreet?: unknown;
+    geo_street?: unknown | undefined;
     /** The street number component extracted from the geocoded job address. Automatically populated when an address is geocoded. */
-    geoNumber?: unknown;
+    geo_number?: unknown | undefined;
     /** The UUID of the queue this job belongs to. */
-    queueUuid?: string;
+    queue_uuid?: string | undefined;
     /** The date and time when the job expires from the queue. */
-    queueExpiryDate?: string;
+    queue_expiry_date?: string | undefined;
     /** The UUID of the staff member assigned to this job in the queue. */
-    queueAssignedStaffUuid?: string;
+    queue_assigned_staff_uuid?: string | undefined;
     /** JSON Array of Badge UUIDs */
-    badges?: string;
+    badges?: string | undefined;
     /** The date and time that the job status was changed to Quote. */
-    quoteDate?: string;
+    quote_date?: string | undefined;
     /** Boolean flag indicating whether a quote has been sent to the client for this job..  Valid values are [0,1] */
-    quoteSent?: number;
+    quote_sent?: number | undefined;
     /** Timestamp when the quote was sent to the client. Format is YYYY-MM-DD HH:MM:SS. */
-    quoteSentStamp?: unknown;
+    quote_sent_stamp?: unknown | undefined;
     /** The date and time that the job status was changed to Work Order. */
-    workOrderDate?: string;
+    work_order_date?: string | undefined;
     /** DEPRECATED */
-    activeNetworkRequestUuid?: unknown;
+    active_network_request_uuid?: unknown | undefined;
     /** DEPRECATED */
-    relatedKnowledgeArticles?: unknown;
+    related_knowledge_articles?: unknown | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** Physical address where the job is to be performed. This address is used for geocoding to place the job on the map. */
-    jobAddress?: string;
-    jobDescription?: string;
-    workDoneDescription?: string;
+    job_address?: string | undefined;
+    job_description?: string | undefined;
+    work_done_description?: string | undefined;
     /** Indicates whether the job has been exported to the connected Accounting Package..  Valid values are [0,1] */
-    paymentProcessed?: number;
+    payment_processed?: number | undefined;
     /** Indicates whether full payment has been received for this job..  Valid values are [0,1] */
-    paymentReceived?: number;
+    payment_received?: number | undefined;
     /** The date and time that the job status was changed to Completed. */
-    completionDate?: string;
+    completion_date?: string | undefined;
     /** The date and time that the job status was changed to Unsuccessful. */
-    unsuccessfulDate?: string;
+    unsuccessful_date?: string | undefined;
+}
+export declare namespace JobCreate {
+    /** Current status of the job. Controls where the Job appears in the Dispatch Board..  Valid values are [Quote,Work Order,Unsuccessful,Completed] */
+    const Status: {
+        readonly Quote: "Quote";
+        readonly WorkOrder: "Work Order";
+        readonly Unsuccessful: "Unsuccessful";
+        readonly Completed: "Completed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
 }

package/dist/cjs/api/types/JobCreate.js

@@ -1,3 +1,14 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobCreate = void 0;
+var JobCreate;
+(function (JobCreate) {
+    /** Current status of the job. Controls where the Job appears in the Dispatch Board..  Valid values are [Quote,Work Order,Unsuccessful,Completed] */
+    JobCreate.Status = {
+        Quote: "Quote",
+        WorkOrder: "Work Order",
+        Unsuccessful: "Unsuccessful",
+        Completed: "Completed",
+    };
+})(JobCreate || (exports.JobCreate = JobCreate = {}));

package/dist/cjs/api/types/JobMaterial.d.ts

@@ -1,32 +1,32 @@
 export interface JobMaterial {
     /** The UUID of the job this material is associated with. This is a required field that establishes the relationship between the job material and its parent job. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** The UUID of the material catalog item this job material is based on. Links the job material to the corresponding material in the materials catalog. */
-    materialUuid?: string;
+    material_uuid?: string | undefined;
     /** The name of the material item used on the job. This is displayed on invoices and is used to identify the material to the customer. The name typically comes from the associated material object but can be customized per job. */
-    name?: string;
+    name?: string | undefined;
     /** The quantity of this material used on the job. This field is mandatory and cannot be empty. */
     quantity: string;
     /** The unit price of the material excluding tax. Used in calculations to determine the total price for this line item on the job. The system may automatically adjust this value to maintain consistency with tax-inclusive pricing. */
-    price?: string;
+    price?: string | undefined;
     /** The unit price amount as displayed on invoices and quotes. This can be either tax-inclusive or tax-exclusive depending on the displayed_amount_is_tax_inclusive field value. Used for presentation to customers. */
-    displayedAmount?: string;
+    displayed_amount?: string | undefined;
     /** Boolean flag indicating whether the displayed_amount includes tax (true) or excludes tax (false). This controls how prices are presented to customers and determines which price value (inclusive or exclusive) is used in calculations. */
-    displayedAmountIsTaxInclusive?: string;
+    displayed_amount_is_tax_inclusive?: string | undefined;
     /** The UUID of the tax rate applied to this job material. Determines how tax is calculated for this specific line item. */
-    taxRateUuid?: string;
+    tax_rate_uuid?: string | undefined;
     /** Integer value controlling the display order of materials on a job. Lower values appear first in lists. Used to customize the presentation order of materials on quotes, invoices and job forms. */
-    sortOrder?: string;
+    sort_order?: string | undefined;
     /** The cost of the material for this job. This is the ex-tax amount. */
-    cost?: string;
+    cost?: string | undefined;
     /** The cost of the material for this job, displayed as inc-tax or ex-tax depending on jobMaterial.displayed_amount_is_tax_inclusive. */
-    displayedCost?: string;
+    displayed_cost?: string | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** Record active/deleted flag.  Valid values are [0,1] */
-    active?: number;
+    active?: number | undefined;
     /** Timestamp at which record was last modified */
-    editDate?: unknown;
+    edit_date?: unknown | undefined;
     /** UUID of a JobMaterialBundle which this JobMaterial belongs to. The default value is blank, which means that the JobMaterial is not part of a JobMaterialBundle. */
-    jobMaterialBundleUuid?: string;
+    job_material_bundle_uuid?: string | undefined;
 }

package/dist/cjs/api/types/JobMaterialBundle.d.ts

@@ -1,20 +1,20 @@
 export interface JobMaterialBundle {
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** Record active/deleted flag.  Valid values are [0,1] */
-    active?: number;
+    active?: number | undefined;
     /** Timestamp at which record was last modified */
-    editDate?: unknown;
+    edit_date?: unknown | undefined;
     /** Unique identifier for the material bundle within the job. Displayed on the Quote/Invoice in the same way as for JobMaterials. */
-    itemNumber?: string;
+    item_number?: string | undefined;
     /** Descriptive name of the job material bundle. Displayed on the Quote/Invoice in the same way as for JobMaterials. */
-    name?: string;
+    name?: string | undefined;
     /** The quantity shown for the bundle line item on the invoice. Must be greater than zero. The quantity of each JobMaterial within the bundle is determined by dividing by this value. */
-    quantity?: string;
+    quantity?: string | undefined;
     /** Defines the display order of the JobMaterialBundle relative to other JobMaterials and JobMaterialBundles on the Job. Lower values are displayed first. */
-    sortOrder?: number;
+    sort_order?: number | undefined;
     /** UUID of the MaterialBundle which this JobMaterialBundle was originally created from. */
-    materialBundleUuid?: string;
+    material_bundle_uuid?: string | undefined;
     /** UUID of the job that this material bundle is associated with. Links the bundle to a specific job record. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
 }

package/dist/cjs/api/types/JobMaterialBundleCreate.d.ts

@@ -1,16 +1,16 @@
 export interface JobMaterialBundleCreate {
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** Unique identifier for the material bundle within the job. Displayed on the Quote/Invoice in the same way as for JobMaterials. */
-    itemNumber?: string;
+    item_number?: string | undefined;
     /** Descriptive name of the job material bundle. Displayed on the Quote/Invoice in the same way as for JobMaterials. */
-    name?: string;
+    name?: string | undefined;
     /** The quantity shown for the bundle line item on the invoice. Must be greater than zero. The quantity of each JobMaterial within the bundle is determined by dividing by this value. */
-    quantity?: string;
+    quantity?: string | undefined;
     /** Defines the display order of the JobMaterialBundle relative to other JobMaterials and JobMaterialBundles on the Job. Lower values are displayed first. */
-    sortOrder?: number;
+    sort_order?: number | undefined;
     /** UUID of the MaterialBundle which this JobMaterialBundle was originally created from. */
-    materialBundleUuid?: string;
+    material_bundle_uuid?: string | undefined;
     /** UUID of the job that this material bundle is associated with. Links the bundle to a specific job record. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
 }

package/dist/cjs/api/types/JobMaterialCreate.d.ts

@@ -1,28 +1,28 @@
 export interface JobMaterialCreate {
     /** The UUID of the job this material is associated with. This is a required field that establishes the relationship between the job material and its parent job. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** The UUID of the material catalog item this job material is based on. Links the job material to the corresponding material in the materials catalog. */
-    materialUuid?: string;
+    material_uuid?: string | undefined;
     /** The name of the material item used on the job. This is displayed on invoices and is used to identify the material to the customer. The name typically comes from the associated material object but can be customized per job. */
-    name?: string;
+    name?: string | undefined;
     /** The quantity of this material used on the job. This field is mandatory and cannot be empty. */
     quantity: string;
     /** The unit price of the material excluding tax. Used in calculations to determine the total price for this line item on the job. The system may automatically adjust this value to maintain consistency with tax-inclusive pricing. */
-    price?: string;
+    price?: string | undefined;
     /** The unit price amount as displayed on invoices and quotes. This can be either tax-inclusive or tax-exclusive depending on the displayed_amount_is_tax_inclusive field value. Used for presentation to customers. */
-    displayedAmount?: string;
+    displayed_amount?: string | undefined;
     /** Boolean flag indicating whether the displayed_amount includes tax (true) or excludes tax (false). This controls how prices are presented to customers and determines which price value (inclusive or exclusive) is used in calculations. */
-    displayedAmountIsTaxInclusive?: string;
+    displayed_amount_is_tax_inclusive?: string | undefined;
     /** The UUID of the tax rate applied to this job material. Determines how tax is calculated for this specific line item. */
-    taxRateUuid?: string;
+    tax_rate_uuid?: string | undefined;
     /** Integer value controlling the display order of materials on a job. Lower values appear first in lists. Used to customize the presentation order of materials on quotes, invoices and job forms. */
-    sortOrder?: string;
+    sort_order?: string | undefined;
     /** The cost of the material for this job. This is the ex-tax amount. */
-    cost?: string;
+    cost?: string | undefined;
     /** The cost of the material for this job, displayed as inc-tax or ex-tax depending on jobMaterial.displayed_amount_is_tax_inclusive. */
-    displayedCost?: string;
+    displayed_cost?: string | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** UUID of a JobMaterialBundle which this JobMaterial belongs to. The default value is blank, which means that the JobMaterial is not part of a JobMaterialBundle. */
-    jobMaterialBundleUuid?: string;
+    job_material_bundle_uuid?: string | undefined;
 }

package/dist/cjs/api/types/JobPayment.d.ts

@@ -1,24 +1,24 @@
 export interface JobPayment {
     /** UUID of the job this payment is associated with. Each payment must be linked to a valid job in the system. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** UUID of the staff member who recorded or processed this payment. Used for tracking which staff member handled the transaction. */
-    actionedByUuid?: string;
+    actioned_by_uuid?: string | undefined;
     /** The date and time when this payment was recorded or processed. Format is YYYY-MM-DD HH:MM:SS. Used for payment reconciliation and reporting. */
-    timestamp?: string;
+    timestamp?: string | undefined;
     /** The payment amount in the account's currency. */
-    amount?: string;
+    amount?: string | undefined;
     /** The payment method used for this transaction. Examples include 'Cash', 'Credit Card', 'Bank Transfer', 'Stripe', etc. */
-    method?: string;
+    method?: string | undefined;
     /** Optional text field for storing additional information about the payment. Can be used to record reference numbers, transaction IDs, or other payment-specific details. */
-    note?: string;
+    note?: string | undefined;
     /** UUID linking to a stored attachment related to this payment, such as a receipt image. This is an optional reference to an Attachment record. */
-    attachmentUuid?: string;
+    attachment_uuid?: string | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
     /** Record active/deleted flag.  Valid values are [0,1] */
-    active?: number;
+    active?: number | undefined;
     /** Timestamp at which record was last modified */
-    editDate?: unknown;
+    edit_date?: unknown | undefined;
     /** Boolean flag indicating whether this payment represents a deposit against future work (true) rather than a payment for completed work (false). Read-only in the API. (Read only).  Valid values are [0,1] */
-    isDeposit?: number;
+    is_deposit?: number | undefined;
 }

package/dist/cjs/api/types/JobPaymentCreate.d.ts

@@ -1,18 +1,18 @@
 export interface JobPaymentCreate {
     /** UUID of the job this payment is associated with. Each payment must be linked to a valid job in the system. */
-    jobUuid?: string;
+    job_uuid?: string | undefined;
     /** UUID of the staff member who recorded or processed this payment. Used for tracking which staff member handled the transaction. */
-    actionedByUuid?: string;
+    actioned_by_uuid?: string | undefined;
     /** The date and time when this payment was recorded or processed. Format is YYYY-MM-DD HH:MM:SS. Used for payment reconciliation and reporting. */
-    timestamp?: string;
+    timestamp?: string | undefined;
     /** The payment amount in the account's currency. */
-    amount?: string;
+    amount?: string | undefined;
     /** The payment method used for this transaction. Examples include 'Cash', 'Credit Card', 'Bank Transfer', 'Stripe', etc. */
-    method?: string;
+    method?: string | undefined;
     /** Optional text field for storing additional information about the payment. Can be used to record reference numbers, transaction IDs, or other payment-specific details. */
-    note?: string;
+    note?: string | undefined;
     /** UUID linking to a stored attachment related to this payment, such as a receipt image. This is an optional reference to an Attachment record. */
-    attachmentUuid?: string;
+    attachment_uuid?: string | undefined;
     /** Unique identifier for this record */
-    uuid?: string;
+    uuid?: string | undefined;
 }