servicem8 0.9.0 → 0.9.2

package/src/models/operations/listjobtemplates.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListJobTemplatesResponse =
+  | components.ErrorT
+  | Array<components.JobTemplate>;
+
+/** @internal */
+export const ListJobTemplatesResponse$inboundSchema: z.ZodType<
+  ListJobTemplatesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.ErrorT$inboundSchema,
+  z.array(components.JobTemplate$inboundSchema),
+]);
+
+/** @internal */
+export type ListJobTemplatesResponse$Outbound =
+  | components.ErrorT$Outbound
+  | Array<components.JobTemplate$Outbound>;
+
+/** @internal */
+export const ListJobTemplatesResponse$outboundSchema: z.ZodType<
+  ListJobTemplatesResponse$Outbound,
+  z.ZodTypeDef,
+  ListJobTemplatesResponse
+> = z.union([
+  components.ErrorT$outboundSchema,
+  z.array(components.JobTemplate$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListJobTemplatesResponse$ {
+  /** @deprecated use `ListJobTemplatesResponse$inboundSchema` instead. */
+  export const inboundSchema = ListJobTemplatesResponse$inboundSchema;
+  /** @deprecated use `ListJobTemplatesResponse$outboundSchema` instead. */
+  export const outboundSchema = ListJobTemplatesResponse$outboundSchema;
+  /** @deprecated use `ListJobTemplatesResponse$Outbound` instead. */
+  export type Outbound = ListJobTemplatesResponse$Outbound;
+}
+
+export function listJobTemplatesResponseToJSON(
+  listJobTemplatesResponse: ListJobTemplatesResponse,
+): string {
+  return JSON.stringify(
+    ListJobTemplatesResponse$outboundSchema.parse(listJobTemplatesResponse),
+  );
+}
+
+export function listJobTemplatesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListJobTemplatesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListJobTemplatesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListJobTemplatesResponse' from JSON`,
+  );
+}

package/src/models/operations/updatejobtemplates.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type UpdateJobTemplatesRequest = {
+  /**
+   * UUID of the Job Template
+   */
+  uuid: string;
+  /**
+   * Job Template fields to update
+   */
+  jobTemplate: components.JobTemplateInput;
+};
+
+export type UpdateJobTemplatesResponse = components.Result | components.ErrorT;
+
+/** @internal */
+export const UpdateJobTemplatesRequest$inboundSchema: z.ZodType<
+  UpdateJobTemplatesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+  JobTemplate: components.JobTemplateInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "JobTemplate": "jobTemplate",
+  });
+});
+
+/** @internal */
+export type UpdateJobTemplatesRequest$Outbound = {
+  uuid: string;
+  JobTemplate: components.JobTemplateInput$Outbound;
+};
+
+/** @internal */
+export const UpdateJobTemplatesRequest$outboundSchema: z.ZodType<
+  UpdateJobTemplatesRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateJobTemplatesRequest
+> = z.object({
+  uuid: z.string(),
+  jobTemplate: components.JobTemplateInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    jobTemplate: "JobTemplate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateJobTemplatesRequest$ {
+  /** @deprecated use `UpdateJobTemplatesRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateJobTemplatesRequest$inboundSchema;
+  /** @deprecated use `UpdateJobTemplatesRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateJobTemplatesRequest$outboundSchema;
+  /** @deprecated use `UpdateJobTemplatesRequest$Outbound` instead. */
+  export type Outbound = UpdateJobTemplatesRequest$Outbound;
+}
+
+export function updateJobTemplatesRequestToJSON(
+  updateJobTemplatesRequest: UpdateJobTemplatesRequest,
+): string {
+  return JSON.stringify(
+    UpdateJobTemplatesRequest$outboundSchema.parse(updateJobTemplatesRequest),
+  );
+}
+
+export function updateJobTemplatesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateJobTemplatesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateJobTemplatesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateJobTemplatesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateJobTemplatesResponse$inboundSchema: z.ZodType<
+  UpdateJobTemplatesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([components.Result$inboundSchema, components.ErrorT$inboundSchema]);
+
+/** @internal */
+export type UpdateJobTemplatesResponse$Outbound =
+  | components.Result$Outbound
+  | components.ErrorT$Outbound;
+
+/** @internal */
+export const UpdateJobTemplatesResponse$outboundSchema: z.ZodType<
+  UpdateJobTemplatesResponse$Outbound,
+  z.ZodTypeDef,
+  UpdateJobTemplatesResponse
+> = z.union([
+  components.Result$outboundSchema,
+  components.ErrorT$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateJobTemplatesResponse$ {
+  /** @deprecated use `UpdateJobTemplatesResponse$inboundSchema` instead. */
+  export const inboundSchema = UpdateJobTemplatesResponse$inboundSchema;
+  /** @deprecated use `UpdateJobTemplatesResponse$outboundSchema` instead. */
+  export const outboundSchema = UpdateJobTemplatesResponse$outboundSchema;
+  /** @deprecated use `UpdateJobTemplatesResponse$Outbound` instead. */
+  export type Outbound = UpdateJobTemplatesResponse$Outbound;
+}
+
+export function updateJobTemplatesResponseToJSON(
+  updateJobTemplatesResponse: UpdateJobTemplatesResponse,
+): string {
+  return JSON.stringify(
+    UpdateJobTemplatesResponse$outboundSchema.parse(updateJobTemplatesResponse),
+  );
+}
+
+export function updateJobTemplatesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateJobTemplatesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateJobTemplatesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateJobTemplatesResponse' from JSON`,
+  );
+}

package/src/sdk/jobtemplates.ts

@@ -3,11 +3,118 @@
  */
 
 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
    *
@@ -18,8 +125,11 @@ export class JobTemplates extends ClientSDK {
    * 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
+   * - `company_name` - Name of the company/client (will lookup existing or create new)
    * - `job_address` - Street address for the job
    *
+   * **Note:** You cannot specify both `company_uuid` and `company_name`. If `company_name` is provided, the system will first search for an existing company with that name. If found, it will use that company's UUID. If not found, a new company will be created.
+   *
    * Any other fields in the request body will be ignored.
    *
    * #### OAuth Scope

package/src/sdk/sdk.ts

@@ -113,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));
@@ -153,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));
@@ -218,16 +228,6 @@ export class ServiceM8 extends ClientSDK {
     return (this._vendors ??= new Vendors(this._options));
   }
 
-  private _inbox?: Inbox;
-  get inbox(): Inbox {
-    return (this._inbox ??= new Inbox(this._options));
-  }
-
-  private _jobTemplates?: JobTemplates;
-  get jobTemplates(): JobTemplates {
-    return (this._jobTemplates ??= new JobTemplates(this._options));
-  }
-
   private _search?: Search;
   get search(): Search {
     return (this._search ??= new Search(this._options));