servicem8 0.8.0 → 0.9.0

package/src/models/operations/jobembeddingsearch.ts

@@ -0,0 +1,92 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type JobEmbeddingSearchRequest = {
+  /**
+   * Search query string
+   */
+  q: string;
+  /**
+   * Maximum number of results to return (max 50)
+   */
+  limit?: number | undefined;
+  /**
+   * Minimum similarity score (0.0 to 1.0)
+   */
+  similarityThreshold?: number | undefined;
+};
+
+/** @internal */
+export const JobEmbeddingSearchRequest$inboundSchema: z.ZodType<
+  JobEmbeddingSearchRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  q: z.string(),
+  limit: z.number().int().default(10),
+  similarity_threshold: z.number().default(0.7),
+}).transform((v) => {
+  return remap$(v, {
+    "similarity_threshold": "similarityThreshold",
+  });
+});
+
+/** @internal */
+export type JobEmbeddingSearchRequest$Outbound = {
+  q: string;
+  limit: number;
+  similarity_threshold: number;
+};
+
+/** @internal */
+export const JobEmbeddingSearchRequest$outboundSchema: z.ZodType<
+  JobEmbeddingSearchRequest$Outbound,
+  z.ZodTypeDef,
+  JobEmbeddingSearchRequest
+> = z.object({
+  q: z.string(),
+  limit: z.number().int().default(10),
+  similarityThreshold: z.number().default(0.7),
+}).transform((v) => {
+  return remap$(v, {
+    similarityThreshold: "similarity_threshold",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace JobEmbeddingSearchRequest$ {
+  /** @deprecated use `JobEmbeddingSearchRequest$inboundSchema` instead. */
+  export const inboundSchema = JobEmbeddingSearchRequest$inboundSchema;
+  /** @deprecated use `JobEmbeddingSearchRequest$outboundSchema` instead. */
+  export const outboundSchema = JobEmbeddingSearchRequest$outboundSchema;
+  /** @deprecated use `JobEmbeddingSearchRequest$Outbound` instead. */
+  export type Outbound = JobEmbeddingSearchRequest$Outbound;
+}
+
+export function jobEmbeddingSearchRequestToJSON(
+  jobEmbeddingSearchRequest: JobEmbeddingSearchRequest,
+): string {
+  return JSON.stringify(
+    JobEmbeddingSearchRequest$outboundSchema.parse(jobEmbeddingSearchRequest),
+  );
+}
+
+export function jobEmbeddingSearchRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<JobEmbeddingSearchRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => JobEmbeddingSearchRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'JobEmbeddingSearchRequest' from JSON`,
+  );
+}

package/src/models/operations/listinboxmessages.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter messages by status
+ */
+export const Filter = {
+  All: "all",
+  Unread: "unread",
+  Archived: "archived",
+  Snoozed: "snoozed",
+} as const;
+/**
+ * Filter messages by status
+ */
+export type Filter = ClosedEnum<typeof Filter>;
+
+export type ListInboxMessagesRequest = {
+  /**
+   * Maximum number of messages to return (1-500)
+   */
+  limit?: number | undefined;
+  /**
+   * Number of messages to skip for pagination
+   */
+  offset?: number | undefined;
+  /**
+   * Filter messages by status
+   */
+  filter?: Filter | undefined;
+  /**
+   * Search messages by subject, from name, or from email
+   */
+  search?: string | undefined;
+};
+
+/** @internal */
+export const Filter$inboundSchema: z.ZodNativeEnum<typeof Filter> = z
+  .nativeEnum(Filter);
+
+/** @internal */
+export const Filter$outboundSchema: z.ZodNativeEnum<typeof Filter> =
+  Filter$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Filter$ {
+  /** @deprecated use `Filter$inboundSchema` instead. */
+  export const inboundSchema = Filter$inboundSchema;
+  /** @deprecated use `Filter$outboundSchema` instead. */
+  export const outboundSchema = Filter$outboundSchema;
+}
+
+/** @internal */
+export const ListInboxMessagesRequest$inboundSchema: z.ZodType<
+  ListInboxMessagesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  limit: z.number().int().default(50),
+  offset: z.number().int().default(0),
+  filter: Filter$inboundSchema.default("all"),
+  search: z.string().optional(),
+});
+
+/** @internal */
+export type ListInboxMessagesRequest$Outbound = {
+  limit: number;
+  offset: number;
+  filter: string;
+  search?: string | undefined;
+};
+
+/** @internal */
+export const ListInboxMessagesRequest$outboundSchema: z.ZodType<
+  ListInboxMessagesRequest$Outbound,
+  z.ZodTypeDef,
+  ListInboxMessagesRequest
+> = z.object({
+  limit: z.number().int().default(50),
+  offset: z.number().int().default(0),
+  filter: Filter$outboundSchema.default("all"),
+  search: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListInboxMessagesRequest$ {
+  /** @deprecated use `ListInboxMessagesRequest$inboundSchema` instead. */
+  export const inboundSchema = ListInboxMessagesRequest$inboundSchema;
+  /** @deprecated use `ListInboxMessagesRequest$outboundSchema` instead. */
+  export const outboundSchema = ListInboxMessagesRequest$outboundSchema;
+  /** @deprecated use `ListInboxMessagesRequest$Outbound` instead. */
+  export type Outbound = ListInboxMessagesRequest$Outbound;
+}
+
+export function listInboxMessagesRequestToJSON(
+  listInboxMessagesRequest: ListInboxMessagesRequest,
+): string {
+  return JSON.stringify(
+    ListInboxMessagesRequest$outboundSchema.parse(listInboxMessagesRequest),
+  );
+}
+
+export function listInboxMessagesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxMessagesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxMessagesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxMessagesRequest' from JSON`,
+  );
+}

package/src/models/operations/markinboxmessageasread.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type MarkInboxMessageAsReadRequest = {
+  /**
+   * UUID of the inbox message
+   */
+  uuid: string;
+};
+
+/** @internal */
+export const MarkInboxMessageAsReadRequest$inboundSchema: z.ZodType<
+  MarkInboxMessageAsReadRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+});
+
+/** @internal */
+export type MarkInboxMessageAsReadRequest$Outbound = {
+  uuid: string;
+};
+
+/** @internal */
+export const MarkInboxMessageAsReadRequest$outboundSchema: z.ZodType<
+  MarkInboxMessageAsReadRequest$Outbound,
+  z.ZodTypeDef,
+  MarkInboxMessageAsReadRequest
+> = z.object({
+  uuid: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarkInboxMessageAsReadRequest$ {
+  /** @deprecated use `MarkInboxMessageAsReadRequest$inboundSchema` instead. */
+  export const inboundSchema = MarkInboxMessageAsReadRequest$inboundSchema;
+  /** @deprecated use `MarkInboxMessageAsReadRequest$outboundSchema` instead. */
+  export const outboundSchema = MarkInboxMessageAsReadRequest$outboundSchema;
+  /** @deprecated use `MarkInboxMessageAsReadRequest$Outbound` instead. */
+  export type Outbound = MarkInboxMessageAsReadRequest$Outbound;
+}
+
+export function markInboxMessageAsReadRequestToJSON(
+  markInboxMessageAsReadRequest: MarkInboxMessageAsReadRequest,
+): string {
+  return JSON.stringify(
+    MarkInboxMessageAsReadRequest$outboundSchema.parse(
+      markInboxMessageAsReadRequest,
+    ),
+  );
+}
+
+export function markInboxMessageAsReadRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<MarkInboxMessageAsReadRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MarkInboxMessageAsReadRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MarkInboxMessageAsReadRequest' from JSON`,
+  );
+}

package/src/models/operations/objectsearch.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Type of object to search
+ */
+export const ObjectType = {
+  Job: "job",
+  Company: "company",
+  Material: "material",
+  Knowledgearticle: "knowledgearticle",
+  Attachment: "attachment",
+  Formresponse: "formresponse",
+  Asset: "asset",
+  Materialbundle: "materialbundle",
+} as const;
+/**
+ * Type of object to search
+ */
+export type ObjectType = ClosedEnum<typeof ObjectType>;
+
+export type ObjectSearchRequest = {
+  /**
+   * Type of object to search
+   */
+  objectType: ObjectType;
+  /**
+   * Search query string
+   */
+  q: string;
+  /**
+   * Maximum number of results to return (max 100)
+   */
+  limit?: number | undefined;
+};
+
+/** @internal */
+export const ObjectType$inboundSchema: z.ZodNativeEnum<typeof ObjectType> = z
+  .nativeEnum(ObjectType);
+
+/** @internal */
+export const ObjectType$outboundSchema: z.ZodNativeEnum<typeof ObjectType> =
+  ObjectType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ObjectType$ {
+  /** @deprecated use `ObjectType$inboundSchema` instead. */
+  export const inboundSchema = ObjectType$inboundSchema;
+  /** @deprecated use `ObjectType$outboundSchema` instead. */
+  export const outboundSchema = ObjectType$outboundSchema;
+}
+
+/** @internal */
+export const ObjectSearchRequest$inboundSchema: z.ZodType<
+  ObjectSearchRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  objectType: ObjectType$inboundSchema,
+  q: z.string(),
+  limit: z.number().int().default(50),
+});
+
+/** @internal */
+export type ObjectSearchRequest$Outbound = {
+  objectType: string;
+  q: string;
+  limit: number;
+};
+
+/** @internal */
+export const ObjectSearchRequest$outboundSchema: z.ZodType<
+  ObjectSearchRequest$Outbound,
+  z.ZodTypeDef,
+  ObjectSearchRequest
+> = z.object({
+  objectType: ObjectType$outboundSchema,
+  q: z.string(),
+  limit: z.number().int().default(50),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ObjectSearchRequest$ {
+  /** @deprecated use `ObjectSearchRequest$inboundSchema` instead. */
+  export const inboundSchema = ObjectSearchRequest$inboundSchema;
+  /** @deprecated use `ObjectSearchRequest$outboundSchema` instead. */
+  export const outboundSchema = ObjectSearchRequest$outboundSchema;
+  /** @deprecated use `ObjectSearchRequest$Outbound` instead. */
+  export type Outbound = ObjectSearchRequest$Outbound;
+}
+
+export function objectSearchRequestToJSON(
+  objectSearchRequest: ObjectSearchRequest,
+): string {
+  return JSON.stringify(
+    ObjectSearchRequest$outboundSchema.parse(objectSearchRequest),
+  );
+}
+
+export function objectSearchRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ObjectSearchRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ObjectSearchRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ObjectSearchRequest' from JSON`,
+  );
+}

package/src/models/operations/snoozeinboxmessage.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 SnoozeInboxMessageRequest = {
+  /**
+   * UUID of the inbox message
+   */
+  uuid: string;
+  snoozeRequest: components.SnoozeRequest;
+};
+
+/** @internal */
+export const SnoozeInboxMessageRequest$inboundSchema: z.ZodType<
+  SnoozeInboxMessageRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+  SnoozeRequest: components.SnoozeRequest$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "SnoozeRequest": "snoozeRequest",
+  });
+});
+
+/** @internal */
+export type SnoozeInboxMessageRequest$Outbound = {
+  uuid: string;
+  SnoozeRequest: components.SnoozeRequest$Outbound;
+};
+
+/** @internal */
+export const SnoozeInboxMessageRequest$outboundSchema: z.ZodType<
+  SnoozeInboxMessageRequest$Outbound,
+  z.ZodTypeDef,
+  SnoozeInboxMessageRequest
+> = z.object({
+  uuid: z.string(),
+  snoozeRequest: components.SnoozeRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    snoozeRequest: "SnoozeRequest",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SnoozeInboxMessageRequest$ {
+  /** @deprecated use `SnoozeInboxMessageRequest$inboundSchema` instead. */
+  export const inboundSchema = SnoozeInboxMessageRequest$inboundSchema;
+  /** @deprecated use `SnoozeInboxMessageRequest$outboundSchema` instead. */
+  export const outboundSchema = SnoozeInboxMessageRequest$outboundSchema;
+  /** @deprecated use `SnoozeInboxMessageRequest$Outbound` instead. */
+  export type Outbound = SnoozeInboxMessageRequest$Outbound;
+}
+
+export function snoozeInboxMessageRequestToJSON(
+  snoozeInboxMessageRequest: SnoozeInboxMessageRequest,
+): string {
+  return JSON.stringify(
+    SnoozeInboxMessageRequest$outboundSchema.parse(snoozeInboxMessageRequest),
+  );
+}
+
+export function snoozeInboxMessageRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SnoozeInboxMessageRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SnoozeInboxMessageRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SnoozeInboxMessageRequest' from JSON`,
+  );
+}

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,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { jobTemplatesCreateJobFromTemplate } from "../funcs/jobTemplatesCreateJobFromTemplate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class JobTemplates extends ClientSDK {
+  /**
+   * 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,
+    ));
+  }
+}