servicem8 0.6.15 → 0.7.0

package/src/sdk/inbox.ts

@@ -0,0 +1,154 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { inboxAddNoteToInboxMessage } from "../funcs/inboxAddNoteToInboxMessage.js";
+import { inboxArchiveInboxMessage } from "../funcs/inboxArchiveInboxMessage.js";
+import { inboxAttachInboxMessageToJob } from "../funcs/inboxAttachInboxMessageToJob.js";
+import { inboxConvertInboxMessageToJob } from "../funcs/inboxConvertInboxMessageToJob.js";
+import { inboxGetInboxMessage } from "../funcs/inboxGetInboxMessage.js";
+import { inboxListInboxMessages } from "../funcs/inboxListInboxMessages.js";
+import { inboxMarkInboxMessageAsRead } from "../funcs/inboxMarkInboxMessageAsRead.js";
+import { inboxSnoozeInboxMessage } from "../funcs/inboxSnoozeInboxMessage.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Inbox extends ClientSDK {
+  /**
+   * List inbox messages
+   *
+   * @remarks
+   * Retrieves a paginated list of inbox messages with optional filtering
+   */
+  async listInboxMessages(
+    request: operations.ListInboxMessagesRequest,
+    options?: RequestOptions,
+  ): Promise<components.InboxMessagesResponse> {
+    return unwrapAsync(inboxListInboxMessages(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get inbox message details
+   *
+   * @remarks
+   * Retrieves detailed information about a specific inbox message including attachments and conversation history
+   */
+  async getInboxMessage(
+    request: operations.GetInboxMessageRequest,
+    options?: RequestOptions,
+  ): Promise<components.InboxMessageDetail> {
+    return unwrapAsync(inboxGetInboxMessage(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Mark message as read
+   *
+   * @remarks
+   * Marks an inbox message as read
+   */
+  async markInboxMessageAsRead(
+    request: operations.MarkInboxMessageAsReadRequest,
+    options?: RequestOptions,
+  ): Promise<components.SuccessResponse> {
+    return unwrapAsync(inboxMarkInboxMessageAsRead(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Archive or unarchive message
+   *
+   * @remarks
+   * Archives or unarchives an inbox message
+   */
+  async archiveInboxMessage(
+    request: operations.ArchiveInboxMessageRequest,
+    options?: RequestOptions,
+  ): Promise<components.SuccessResponse> {
+    return unwrapAsync(inboxArchiveInboxMessage(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Snooze or unsnooze message
+   *
+   * @remarks
+   * Snoozes a message until a specified date/time or unsnoozes it
+   */
+  async snoozeInboxMessage(
+    request: operations.SnoozeInboxMessageRequest,
+    options?: RequestOptions,
+  ): Promise<components.SuccessResponse> {
+    return unwrapAsync(inboxSnoozeInboxMessage(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Convert message to job
+   *
+   * @remarks
+   * Converts an inbox message into a new job, optionally using a job template
+   */
+  async convertInboxMessageToJob(
+    request: operations.ConvertInboxMessageToJobRequest,
+    options?: RequestOptions,
+  ): Promise<components.ConvertToJobResponse> {
+    return unwrapAsync(inboxConvertInboxMessageToJob(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Attach message to existing job
+   *
+   * @remarks
+   * Attaches an inbox message to an existing job
+   */
+  async attachInboxMessageToJob(
+    request: operations.AttachInboxMessageToJobRequest,
+    options?: RequestOptions,
+  ): Promise<components.AttachToJobResponse> {
+    return unwrapAsync(inboxAttachInboxMessageToJob(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Add note to message
+   *
+   * @remarks
+   * Adds a note to an inbox message
+   */
+  async addNoteToInboxMessage(
+    request: operations.AddNoteToInboxMessageRequest,
+    options?: RequestOptions,
+  ): Promise<components.SuccessResponse> {
+    return unwrapAsync(inboxAddNoteToInboxMessage(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/jobtemplates.ts

@@ -0,0 +1,145 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { jobTemplatesCreateJobFromTemplate } from "../funcs/jobTemplatesCreateJobFromTemplate.js";
+import { jobTemplatesCreateJobTemplates } from "../funcs/jobTemplatesCreateJobTemplates.js";
+import { jobTemplatesDeleteJobTemplates } from "../funcs/jobTemplatesDeleteJobTemplates.js";
+import { jobTemplatesGetJobTemplates } from "../funcs/jobTemplatesGetJobTemplates.js";
+import { jobTemplatesListJobTemplates } from "../funcs/jobTemplatesListJobTemplates.js";
+import { jobTemplatesUpdateJobTemplates } from "../funcs/jobTemplatesUpdateJobTemplates.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class JobTemplates extends ClientSDK {
+  /**
+   * List all Job Templates
+   *
+   * @remarks
+   *
+   * #### Filtering
+   * This endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **read_jobs**.
+   */
+  async listJobTemplates(
+    options?: RequestOptions,
+  ): Promise<operations.ListJobTemplatesResponse> {
+    return unwrapAsync(jobTemplatesListJobTemplates(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new Job Template
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_jobs**.
+   *
+   * #### Record UUID
+   * UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
+   */
+  async createJobTemplates(
+    request: components.JobTemplateInput,
+    options?: RequestOptions,
+  ): Promise<operations.CreateJobTemplatesResponse> {
+    return unwrapAsync(jobTemplatesCreateJobTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a Job Template
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **read_jobs**.
+   */
+  async getJobTemplates(
+    request: operations.GetJobTemplatesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetJobTemplatesResponse> {
+    return unwrapAsync(jobTemplatesGetJobTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a Job Template
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_jobs**.
+   */
+  async updateJobTemplates(
+    request: operations.UpdateJobTemplatesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateJobTemplatesResponse> {
+    return unwrapAsync(jobTemplatesUpdateJobTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a Job Template
+   *
+   * @remarks
+   *
+   * In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_jobs**.
+   */
+  async deleteJobTemplates(
+    request: operations.DeleteJobTemplatesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteJobTemplatesResponse> {
+    return unwrapAsync(jobTemplatesDeleteJobTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a job from a template
+   *
+   * @remarks
+   * Creates a new job by cloning an existing job template. All template entities (tasks, materials, checklists, quotes, custom fields) are cloned to the new job.
+   *
+   * #### Field Overrides
+   * Only the following fields can be overridden when creating a job from a template:
+   * - `job_description` - Job description
+   * - `company_uuid` - UUID of the company/client
+   * - `job_address` - Street address for the job
+   *
+   * Any other fields in the request body will be ignored.
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_jobs**.
+   */
+  async createJobFromTemplate(
+    request: operations.CreateJobFromTemplateRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateJobFromTemplateResponse> {
+    return unwrapAsync(jobTemplatesCreateJobFromTemplate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -18,6 +18,7 @@ import { Feedback } from "./feedback.js";
 import { FormFields } from "./formfields.js";
 import { FormResponses } from "./formresponses.js";
 import { Forms } from "./forms.js";
+import { Inbox } from "./inbox.js";
 import { JobActivities } from "./jobactivities.js";
 import { JobAllocations } from "./joballocations.js";
 import { JobChecklists } from "./jobchecklists.js";
@@ -27,10 +28,12 @@ import { JobMaterials } from "./jobmaterials.js";
 import { JobPayments } from "./jobpayments.js";
 import { JobQueues } from "./jobqueues.js";
 import { Jobs } from "./jobs.js";
+import { JobTemplates } from "./jobtemplates.js";
 import { KnowledgeArticles } from "./knowledgearticles.js";
 import { Locations } from "./locations.js";
 import { Materials } from "./materials.js";
 import { Notes } from "./notes.js";
+import { Search } from "./search.js";
 import { SecurityRoles } from "./securityroles.js";
 import { SMSTemplates } from "./smstemplates.js";
 import { StaffMembers } from "./staffmembers.js";
@@ -110,6 +113,11 @@ export class ServiceM8 extends ClientSDK {
     return (this._formResponses ??= new FormResponses(this._options));
   }
 
+  private _inbox?: Inbox;
+  get inbox(): Inbox {
+    return (this._inbox ??= new Inbox(this._options));
+  }
+
   private _jobs?: Jobs;
   get jobs(): Jobs {
     return (this._jobs ??= new Jobs(this._options));
@@ -150,6 +158,11 @@ export class ServiceM8 extends ClientSDK {
     return (this._jobPayments ??= new JobPayments(this._options));
   }
 
+  private _jobTemplates?: JobTemplates;
+  get jobTemplates(): JobTemplates {
+    return (this._jobTemplates ??= new JobTemplates(this._options));
+  }
+
   private _knowledgeArticles?: KnowledgeArticles;
   get knowledgeArticles(): KnowledgeArticles {
     return (this._knowledgeArticles ??= new KnowledgeArticles(this._options));
@@ -214,4 +227,9 @@ export class ServiceM8 extends ClientSDK {
   get vendors(): Vendors {
     return (this._vendors ??= new Vendors(this._options));
   }
+
+  private _search?: Search;
+  get search(): Search {
+    return (this._search ??= new Search(this._options));
+  }
 }

package/src/sdk/search.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { searchGeneralSearch } from "../funcs/searchGeneralSearch.js";
+import { searchJobEmbeddingSearch } from "../funcs/searchJobEmbeddingSearch.js";
+import { searchObjectSearch } from "../funcs/searchObjectSearch.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Search extends ClientSDK {
+  /**
+   * Search across multiple object types
+   *
+   * @remarks
+   * Performs a text search across jobs, companies, and materials. Returns combined results sorted by relevance.
+   */
+  async generalSearch(
+    request: operations.GeneralSearchRequest,
+    options?: RequestOptions,
+  ): Promise<components.SearchResponse> {
+    return unwrapAsync(searchGeneralSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Search within a specific object type
+   *
+   * @remarks
+   * Performs a text search within a specific object type. Supported types: job, company, material, knowledgearticle, attachment, formresponse, asset, materialbundle
+   */
+  async objectSearch(
+    request: operations.ObjectSearchRequest,
+    options?: RequestOptions,
+  ): Promise<components.ObjectSearchResponse> {
+    return unwrapAsync(searchObjectSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Semantic search for jobs
+   *
+   * @remarks
+   * Performs semantic/embedding-based search on job content. This uses AI to find jobs with similar meaning, not just exact text matches.
+   */
+  async jobEmbeddingSearch(
+    request: operations.JobEmbeddingSearchRequest,
+    options?: RequestOptions,
+  ): Promise<components.EmbeddingSearchResponse> {
+    return unwrapAsync(searchJobEmbeddingSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+}