servicem8 0.9.43 → 0.9.44

package/src/models/components/createinboxmessagerequest.ts

@@ -0,0 +1,324 @@
+/*
+ * 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";
+
+/**
+ * Structured job data that will be merged into json_data when converting the message to a job
+ */
+export type JobData = {
+  /**
+   * Job contact first name
+   */
+  contactFirst?: string | undefined;
+  /**
+   * Job contact last name
+   */
+  contactLast?: string | undefined;
+  /**
+   * Company/customer name
+   */
+  companyName?: string | undefined;
+  /**
+   * Primary email address
+   */
+  email?: string | undefined;
+  /**
+   * Mobile phone number
+   */
+  mobile?: string | undefined;
+  /**
+   * Primary phone number
+   */
+  phone1?: string | undefined;
+  /**
+   * Secondary phone number
+   */
+  phone2?: string | undefined;
+  /**
+   * Billing contact first name
+   */
+  billingContactFirst?: string | undefined;
+  /**
+   * Billing contact last name
+   */
+  billingContactLast?: string | undefined;
+  /**
+   * Billing email address
+   */
+  billingEmail?: string | undefined;
+  /**
+   * Billing mobile number
+   */
+  billingMobile?: string | undefined;
+  /**
+   * Billing attention line
+   */
+  billingAttention?: string | undefined;
+  /**
+   * Description of the job/work to be done
+   */
+  jobDescription?: string | undefined;
+  /**
+   * Service location address
+   */
+  jobAddress?: string | undefined;
+  /**
+   * Billing address
+   */
+  billingAddress?: string | undefined;
+  /**
+   * Description of completed work
+   */
+  workDoneDescription?: string | undefined;
+};
+
+export type CreateInboxMessageRequest = {
+  /**
+   * Subject of the message
+   */
+  subject: string;
+  /**
+   * Plain text content of the message
+   */
+  messageText: string;
+  /**
+   * Name of the sender
+   */
+  fromName?: string | undefined;
+  /**
+   * Email address of the sender
+   */
+  fromEmail?: string | undefined;
+  /**
+   * Additional data to be used when converting the message to a job
+   */
+  jsonData?: { [k: string]: any } | undefined;
+  /**
+   * Structured job data that will be merged into json_data when converting the message to a job
+   */
+  jobData?: JobData | undefined;
+  /**
+   * UUID of the company this message is regarding
+   */
+  regardingCompanyUuid?: string | undefined;
+};
+
+/** @internal */
+export const JobData$inboundSchema: z.ZodType<JobData, z.ZodTypeDef, unknown> =
+  z.object({
+    contact_first: z.string().optional(),
+    contact_last: z.string().optional(),
+    company_name: z.string().optional(),
+    email: z.string().optional(),
+    mobile: z.string().optional(),
+    phone_1: z.string().optional(),
+    phone_2: z.string().optional(),
+    billing_contact_first: z.string().optional(),
+    billing_contact_last: z.string().optional(),
+    billing_email: z.string().optional(),
+    billing_mobile: z.string().optional(),
+    billing_attention: z.string().optional(),
+    job_description: z.string().optional(),
+    job_address: z.string().optional(),
+    billing_address: z.string().optional(),
+    work_done_description: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "contact_first": "contactFirst",
+      "contact_last": "contactLast",
+      "company_name": "companyName",
+      "phone_1": "phone1",
+      "phone_2": "phone2",
+      "billing_contact_first": "billingContactFirst",
+      "billing_contact_last": "billingContactLast",
+      "billing_email": "billingEmail",
+      "billing_mobile": "billingMobile",
+      "billing_attention": "billingAttention",
+      "job_description": "jobDescription",
+      "job_address": "jobAddress",
+      "billing_address": "billingAddress",
+      "work_done_description": "workDoneDescription",
+    });
+  });
+
+/** @internal */
+export type JobData$Outbound = {
+  contact_first?: string | undefined;
+  contact_last?: string | undefined;
+  company_name?: string | undefined;
+  email?: string | undefined;
+  mobile?: string | undefined;
+  phone_1?: string | undefined;
+  phone_2?: string | undefined;
+  billing_contact_first?: string | undefined;
+  billing_contact_last?: string | undefined;
+  billing_email?: string | undefined;
+  billing_mobile?: string | undefined;
+  billing_attention?: string | undefined;
+  job_description?: string | undefined;
+  job_address?: string | undefined;
+  billing_address?: string | undefined;
+  work_done_description?: string | undefined;
+};
+
+/** @internal */
+export const JobData$outboundSchema: z.ZodType<
+  JobData$Outbound,
+  z.ZodTypeDef,
+  JobData
+> = z.object({
+  contactFirst: z.string().optional(),
+  contactLast: z.string().optional(),
+  companyName: z.string().optional(),
+  email: z.string().optional(),
+  mobile: z.string().optional(),
+  phone1: z.string().optional(),
+  phone2: z.string().optional(),
+  billingContactFirst: z.string().optional(),
+  billingContactLast: z.string().optional(),
+  billingEmail: z.string().optional(),
+  billingMobile: z.string().optional(),
+  billingAttention: z.string().optional(),
+  jobDescription: z.string().optional(),
+  jobAddress: z.string().optional(),
+  billingAddress: z.string().optional(),
+  workDoneDescription: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    contactFirst: "contact_first",
+    contactLast: "contact_last",
+    companyName: "company_name",
+    phone1: "phone_1",
+    phone2: "phone_2",
+    billingContactFirst: "billing_contact_first",
+    billingContactLast: "billing_contact_last",
+    billingEmail: "billing_email",
+    billingMobile: "billing_mobile",
+    billingAttention: "billing_attention",
+    jobDescription: "job_description",
+    jobAddress: "job_address",
+    billingAddress: "billing_address",
+    workDoneDescription: "work_done_description",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace JobData$ {
+  /** @deprecated use `JobData$inboundSchema` instead. */
+  export const inboundSchema = JobData$inboundSchema;
+  /** @deprecated use `JobData$outboundSchema` instead. */
+  export const outboundSchema = JobData$outboundSchema;
+  /** @deprecated use `JobData$Outbound` instead. */
+  export type Outbound = JobData$Outbound;
+}
+
+export function jobDataToJSON(jobData: JobData): string {
+  return JSON.stringify(JobData$outboundSchema.parse(jobData));
+}
+
+export function jobDataFromJSON(
+  jsonString: string,
+): SafeParseResult<JobData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => JobData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'JobData' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateInboxMessageRequest$inboundSchema: z.ZodType<
+  CreateInboxMessageRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subject: z.string(),
+  message_text: z.string(),
+  from_name: z.string().optional(),
+  from_email: z.string().optional(),
+  json_data: z.record(z.any()).optional(),
+  jobData: z.lazy(() => JobData$inboundSchema).optional(),
+  regarding_company_uuid: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "message_text": "messageText",
+    "from_name": "fromName",
+    "from_email": "fromEmail",
+    "json_data": "jsonData",
+    "regarding_company_uuid": "regardingCompanyUuid",
+  });
+});
+
+/** @internal */
+export type CreateInboxMessageRequest$Outbound = {
+  subject: string;
+  message_text: string;
+  from_name?: string | undefined;
+  from_email?: string | undefined;
+  json_data?: { [k: string]: any } | undefined;
+  jobData?: JobData$Outbound | undefined;
+  regarding_company_uuid?: string | undefined;
+};
+
+/** @internal */
+export const CreateInboxMessageRequest$outboundSchema: z.ZodType<
+  CreateInboxMessageRequest$Outbound,
+  z.ZodTypeDef,
+  CreateInboxMessageRequest
+> = z.object({
+  subject: z.string(),
+  messageText: z.string(),
+  fromName: z.string().optional(),
+  fromEmail: z.string().optional(),
+  jsonData: z.record(z.any()).optional(),
+  jobData: z.lazy(() => JobData$outboundSchema).optional(),
+  regardingCompanyUuid: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    messageText: "message_text",
+    fromName: "from_name",
+    fromEmail: "from_email",
+    jsonData: "json_data",
+    regardingCompanyUuid: "regarding_company_uuid",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateInboxMessageRequest$ {
+  /** @deprecated use `CreateInboxMessageRequest$inboundSchema` instead. */
+  export const inboundSchema = CreateInboxMessageRequest$inboundSchema;
+  /** @deprecated use `CreateInboxMessageRequest$outboundSchema` instead. */
+  export const outboundSchema = CreateInboxMessageRequest$outboundSchema;
+  /** @deprecated use `CreateInboxMessageRequest$Outbound` instead. */
+  export type Outbound = CreateInboxMessageRequest$Outbound;
+}
+
+export function createInboxMessageRequestToJSON(
+  createInboxMessageRequest: CreateInboxMessageRequest,
+): string {
+  return JSON.stringify(
+    CreateInboxMessageRequest$outboundSchema.parse(createInboxMessageRequest),
+  );
+}
+
+export function createInboxMessageRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInboxMessageRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateInboxMessageRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInboxMessageRequest' from JSON`,
+  );
+}

package/src/models/components/formresponse.ts

@@ -38,6 +38,32 @@ export type FormResponse = {
   staffUuid?: string | undefined;
   regardingObject?: string | undefined;
   regardingObjectUuid?: string | undefined;
+  /**
+   * JSON array of form answers captured at submission time.
+   */
+  fieldData?: string | undefined;
+  timestamp?: string | undefined;
+  formByStaffUuid?: string | undefined;
+  documentAttachmentUuid?: string | undefined;
+  assetUuid?: string | undefined;
+};
+
+export type FormResponseInput = {
+  /**
+   * Unique identifier for this record
+   */
+  uuid?: string | undefined;
+  /**
+   * Record active/deleted flag.  Valid values are [0,1]
+   */
+  active?: FormResponseActive | undefined;
+  formUuid?: string | undefined;
+  staffUuid?: string | undefined;
+  regardingObject?: string | undefined;
+  regardingObjectUuid?: string | undefined;
+  /**
+   * JSON array of form answers captured at submission time.
+   */
   fieldData?: string | undefined;
   timestamp?: string | undefined;
   formByStaffUuid?: string | undefined;
@@ -172,3 +198,109 @@ export function formResponseFromJSON(
     `Failed to parse 'FormResponse' from JSON`,
   );
 }
+
+/** @internal */
+export const FormResponseInput$inboundSchema: z.ZodType<
+  FormResponseInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string().optional(),
+  active: FormResponseActive$inboundSchema.default(1),
+  form_uuid: z.string().optional(),
+  staff_uuid: z.string().optional(),
+  regarding_object: z.string().optional(),
+  regarding_object_uuid: z.string().optional(),
+  field_data: z.string().optional(),
+  timestamp: z.string().optional(),
+  form_by_staff_uuid: z.string().optional(),
+  document_attachment_uuid: z.string().optional(),
+  asset_uuid: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "form_uuid": "formUuid",
+    "staff_uuid": "staffUuid",
+    "regarding_object": "regardingObject",
+    "regarding_object_uuid": "regardingObjectUuid",
+    "field_data": "fieldData",
+    "form_by_staff_uuid": "formByStaffUuid",
+    "document_attachment_uuid": "documentAttachmentUuid",
+    "asset_uuid": "assetUuid",
+  });
+});
+
+/** @internal */
+export type FormResponseInput$Outbound = {
+  uuid?: string | undefined;
+  active: number;
+  form_uuid?: string | undefined;
+  staff_uuid?: string | undefined;
+  regarding_object?: string | undefined;
+  regarding_object_uuid?: string | undefined;
+  field_data?: string | undefined;
+  timestamp?: string | undefined;
+  form_by_staff_uuid?: string | undefined;
+  document_attachment_uuid?: string | undefined;
+  asset_uuid?: string | undefined;
+};
+
+/** @internal */
+export const FormResponseInput$outboundSchema: z.ZodType<
+  FormResponseInput$Outbound,
+  z.ZodTypeDef,
+  FormResponseInput
+> = z.object({
+  uuid: z.string().optional(),
+  active: FormResponseActive$outboundSchema.default(1),
+  formUuid: z.string().optional(),
+  staffUuid: z.string().optional(),
+  regardingObject: z.string().optional(),
+  regardingObjectUuid: z.string().optional(),
+  fieldData: z.string().optional(),
+  timestamp: z.string().optional(),
+  formByStaffUuid: z.string().optional(),
+  documentAttachmentUuid: z.string().optional(),
+  assetUuid: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    formUuid: "form_uuid",
+    staffUuid: "staff_uuid",
+    regardingObject: "regarding_object",
+    regardingObjectUuid: "regarding_object_uuid",
+    fieldData: "field_data",
+    formByStaffUuid: "form_by_staff_uuid",
+    documentAttachmentUuid: "document_attachment_uuid",
+    assetUuid: "asset_uuid",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace FormResponseInput$ {
+  /** @deprecated use `FormResponseInput$inboundSchema` instead. */
+  export const inboundSchema = FormResponseInput$inboundSchema;
+  /** @deprecated use `FormResponseInput$outboundSchema` instead. */
+  export const outboundSchema = FormResponseInput$outboundSchema;
+  /** @deprecated use `FormResponseInput$Outbound` instead. */
+  export type Outbound = FormResponseInput$Outbound;
+}
+
+export function formResponseInputToJSON(
+  formResponseInput: FormResponseInput,
+): string {
+  return JSON.stringify(
+    FormResponseInput$outboundSchema.parse(formResponseInput),
+  );
+}
+
+export function formResponseInputFromJSON(
+  jsonString: string,
+): SafeParseResult<FormResponseInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FormResponseInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FormResponseInput' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -16,6 +16,7 @@ export * from "./company.js";
 export * from "./companycontact.js";
 export * from "./converttojobrequest.js";
 export * from "./converttojobresponse.js";
+export * from "./createinboxmessagerequest.js";
 export * from "./documenttemplate.js";
 export * from "./emailtemplate.js";
 export * from "./embeddingsearchresponse.js";

package/src/models/components/job.ts

@@ -36,26 +36,26 @@ export const GeoIsValid = {
 export type GeoIsValid = ClosedEnum<typeof GeoIsValid>;
 
 /**
- * Indicates whether an invoice has been sent for this job. (Read only).  Valid values are [0,1]
+ * Indicates whether an invoice has been sent for this job..  Valid values are [0,1]
  */
 export const InvoiceSent = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Indicates whether an invoice has been sent for this job. (Read only).  Valid values are [0,1]
+ * Indicates whether an invoice has been sent for this job..  Valid values are [0,1]
  */
 export type InvoiceSent = ClosedEnum<typeof InvoiceSent>;
 
 /**
- * Boolean flag indicating whether a quote has been sent to the client for this job. (Read only).  Valid values are [0,1]
+ * Boolean flag indicating whether a quote has been sent to the client for this job..  Valid values are [0,1]
  */
 export const QuoteSent = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Boolean flag indicating whether a quote has been sent to the client for this job. (Read only).  Valid values are [0,1]
+ * Boolean flag indicating whether a quote has been sent to the client for this job..  Valid values are [0,1]
  */
 export type QuoteSent = ClosedEnum<typeof QuoteSent>;
 
@@ -117,11 +117,11 @@ export type Job = {
    */
   status: Status;
   /**
-   * The longitude coordinate of the job location.
+   * The longitude coordinate of the job location. (Read only)
    */
   lng?: number | undefined;
   /**
-   * The latitude coordinate of the job location.
+   * The latitude coordinate of the job location. (Read only)
    */
   lat?: number | undefined;
   /**
@@ -157,7 +157,7 @@ export type Job = {
    */
   purchaseOrderNumber?: string | undefined;
   /**
-   * Indicates whether an invoice has been sent for this job. (Read only).  Valid values are [0,1]
+   * Indicates whether an invoice has been sent for this job..  Valid values are [0,1]
    */
   invoiceSent?: InvoiceSent | undefined;
   /**
@@ -217,7 +217,7 @@ export type Job = {
    */
   quoteDate?: string | undefined;
   /**
-   * Boolean flag indicating whether a quote has been sent to the client for this job. (Read only).  Valid values are [0,1]
+   * Boolean flag indicating whether a quote has been sent to the client for this job..  Valid values are [0,1]
    */
   quoteSent?: QuoteSent | undefined;
   /**
@@ -262,7 +262,7 @@ export type Job = {
    */
   generatedJobId?: string | undefined;
   /**
-   * The total amount to be invoiced for this job.
+   * The total amount to be invoiced for this job. (Read only)
    */
   totalInvoiceAmount?: string | undefined;
   /**
@@ -270,7 +270,7 @@ export type Job = {
    */
   paymentProcessed?: PaymentProcessed | undefined;
   /**
-   * The date and time the job has been exported to the connected Accounting Package.
+   * The date and time the job has been exported to the connected Accounting Package. (Read only)
    */
   paymentProcessedStamp?: string | undefined;
   /**
@@ -278,7 +278,7 @@ export type Job = {
    */
   paymentReceived?: PaymentReceived | undefined;
   /**
-   * The date and time when full payment was received.
+   * The date and time when full payment was received. (Read only)
    */
   paymentReceivedStamp?: string | undefined;
   /**
@@ -286,7 +286,7 @@ export type Job = {
    */
   completionDate?: string | undefined;
   /**
-   * UUID of the staff member who marked this job as completed. References a staff record in the system.
+   * UUID of the staff member who marked this job as completed. References a staff record in the system. (Read only)
    */
   completionActionedByUuid?: string | undefined;
   /**
@@ -294,7 +294,7 @@ export type Job = {
    */
   unsuccessfulDate?: string | undefined;
   /**
-   * The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled.
+   * The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled. (Read only)
    */
   jobIsScheduledUntilStamp?: string | undefined;
 };
@@ -321,11 +321,11 @@ export type JobInput = {
    */
   status: Status;
   /**
-   * The longitude coordinate of the job location.
+   * The longitude coordinate of the job location. (Read only)
    */
   lng?: number | undefined;
   /**
-   * The latitude coordinate of the job location.
+   * The latitude coordinate of the job location. (Read only)
    */
   lat?: number | undefined;
   /**
@@ -361,7 +361,7 @@ export type JobInput = {
    */
   purchaseOrderNumber?: string | undefined;
   /**
-   * Indicates whether an invoice has been sent for this job. (Read only).  Valid values are [0,1]
+   * Indicates whether an invoice has been sent for this job..  Valid values are [0,1]
    */
   invoiceSent?: InvoiceSent | undefined;
   /**
@@ -421,7 +421,7 @@ export type JobInput = {
    */
   quoteDate?: string | undefined;
   /**
-   * Boolean flag indicating whether a quote has been sent to the client for this job. (Read only).  Valid values are [0,1]
+   * Boolean flag indicating whether a quote has been sent to the client for this job..  Valid values are [0,1]
    */
   quoteSent?: QuoteSent | undefined;
   /**
@@ -462,7 +462,7 @@ export type JobInput = {
    */
   generatedJobId?: string | undefined;
   /**
-   * The total amount to be invoiced for this job.
+   * The total amount to be invoiced for this job. (Read only)
    */
   totalInvoiceAmount?: string | undefined;
   /**
@@ -470,7 +470,7 @@ export type JobInput = {
    */
   paymentProcessed?: PaymentProcessed | undefined;
   /**
-   * The date and time the job has been exported to the connected Accounting Package.
+   * The date and time the job has been exported to the connected Accounting Package. (Read only)
    */
   paymentProcessedStamp?: string | undefined;
   /**
@@ -478,7 +478,7 @@ export type JobInput = {
    */
   paymentReceived?: PaymentReceived | undefined;
   /**
-   * The date and time when full payment was received.
+   * The date and time when full payment was received. (Read only)
    */
   paymentReceivedStamp?: string | undefined;
   /**
@@ -486,7 +486,7 @@ export type JobInput = {
    */
   completionDate?: string | undefined;
   /**
-   * UUID of the staff member who marked this job as completed. References a staff record in the system.
+   * UUID of the staff member who marked this job as completed. References a staff record in the system. (Read only)
    */
   completionActionedByUuid?: string | undefined;
   /**
@@ -494,7 +494,7 @@ export type JobInput = {
    */
   unsuccessfulDate?: string | undefined;
   /**
-   * The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled.
+   * The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled. (Read only)
    */
   jobIsScheduledUntilStamp?: string | undefined;
 };