servicem8 0.9.42 → 0.9.44

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;
 };

package/src/models/components/vendor.ts

@@ -38,10 +38,10 @@ export type Vendor = {
    * Company Name
    */
   name: string;
+  abnNumber?: string | undefined;
   /**
-   * Company ABN Number (Australian Accounts Only)
+   * Company Business Number
    */
-  abnNumber?: string | undefined;
   businessNumber?: string | undefined;
   /**
    * Company Website address

package/src/models/operations/createformresponses.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 CreateFormResponsesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Result;
+};
+
+/** @internal */
+export const CreateFormResponsesResponse$inboundSchema: z.ZodType<
+  CreateFormResponsesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.Result$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type CreateFormResponsesResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Result$Outbound;
+};
+
+/** @internal */
+export const CreateFormResponsesResponse$outboundSchema: z.ZodType<
+  CreateFormResponsesResponse$Outbound,
+  z.ZodTypeDef,
+  CreateFormResponsesResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Result$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateFormResponsesResponse$ {
+  /** @deprecated use `CreateFormResponsesResponse$inboundSchema` instead. */
+  export const inboundSchema = CreateFormResponsesResponse$inboundSchema;
+  /** @deprecated use `CreateFormResponsesResponse$outboundSchema` instead. */
+  export const outboundSchema = CreateFormResponsesResponse$outboundSchema;
+  /** @deprecated use `CreateFormResponsesResponse$Outbound` instead. */
+  export type Outbound = CreateFormResponsesResponse$Outbound;
+}
+
+export function createFormResponsesResponseToJSON(
+  createFormResponsesResponse: CreateFormResponsesResponse,
+): string {
+  return JSON.stringify(
+    CreateFormResponsesResponse$outboundSchema.parse(
+      createFormResponsesResponse,
+    ),
+  );
+}
+
+export function createFormResponsesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateFormResponsesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateFormResponsesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateFormResponsesResponse' from JSON`,
+  );
+}

package/src/models/operations/deleteformresponses.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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DeleteFormResponsesRequest = {
+  /**
+   * UUID of the Form Response
+   */
+  uuid: string;
+};
+
+/** @internal */
+export const DeleteFormResponsesRequest$inboundSchema: z.ZodType<
+  DeleteFormResponsesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+});
+
+/** @internal */
+export type DeleteFormResponsesRequest$Outbound = {
+  uuid: string;
+};
+
+/** @internal */
+export const DeleteFormResponsesRequest$outboundSchema: z.ZodType<
+  DeleteFormResponsesRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteFormResponsesRequest
+> = 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 DeleteFormResponsesRequest$ {
+  /** @deprecated use `DeleteFormResponsesRequest$inboundSchema` instead. */
+  export const inboundSchema = DeleteFormResponsesRequest$inboundSchema;
+  /** @deprecated use `DeleteFormResponsesRequest$outboundSchema` instead. */
+  export const outboundSchema = DeleteFormResponsesRequest$outboundSchema;
+  /** @deprecated use `DeleteFormResponsesRequest$Outbound` instead. */
+  export type Outbound = DeleteFormResponsesRequest$Outbound;
+}
+
+export function deleteFormResponsesRequestToJSON(
+  deleteFormResponsesRequest: DeleteFormResponsesRequest,
+): string {
+  return JSON.stringify(
+    DeleteFormResponsesRequest$outboundSchema.parse(deleteFormResponsesRequest),
+  );
+}
+
+export function deleteFormResponsesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteFormResponsesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteFormResponsesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteFormResponsesRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -18,6 +18,7 @@ export * from "./createdocumenttemplates.js";
 export * from "./createemailtemplates.js";
 export * from "./createfeedback.js";
 export * from "./createformfields.js";
+export * from "./createformresponses.js";
 export * from "./createforms.js";
 export * from "./createjobactivities.js";
 export * from "./createjoballocations.js";
@@ -50,6 +51,7 @@ export * from "./deletedocumenttemplates.js";
 export * from "./deleteemailtemplates.js";
 export * from "./deletefeedback.js";
 export * from "./deleteformfields.js";
+export * from "./deleteformresponses.js";
 export * from "./deleteforms.js";
 export * from "./deletejobactivities.js";
 export * from "./deletejoballocations.js";
@@ -123,6 +125,7 @@ export * from "./updatedocumenttemplates.js";
 export * from "./updateemailtemplates.js";
 export * from "./updatefeedback.js";
 export * from "./updateformfields.js";
+export * from "./updateformresponses.js";
 export * from "./updateforms.js";
 export * from "./updatejobactivities.js";
 export * from "./updatejoballocations.js";

package/src/models/operations/updateformresponses.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 UpdateFormResponsesRequest = {
+  /**
+   * UUID of the Form Response
+   */
+  uuid: string;
+  /**
+   * Form Response fields to update
+   */
+  formResponse: components.FormResponseInput;
+};
+
+/** @internal */
+export const UpdateFormResponsesRequest$inboundSchema: z.ZodType<
+  UpdateFormResponsesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+  FormResponse: components.FormResponseInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "FormResponse": "formResponse",
+  });
+});
+
+/** @internal */
+export type UpdateFormResponsesRequest$Outbound = {
+  uuid: string;
+  FormResponse: components.FormResponseInput$Outbound;
+};
+
+/** @internal */
+export const UpdateFormResponsesRequest$outboundSchema: z.ZodType<
+  UpdateFormResponsesRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateFormResponsesRequest
+> = z.object({
+  uuid: z.string(),
+  formResponse: components.FormResponseInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    formResponse: "FormResponse",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateFormResponsesRequest$ {
+  /** @deprecated use `UpdateFormResponsesRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateFormResponsesRequest$inboundSchema;
+  /** @deprecated use `UpdateFormResponsesRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateFormResponsesRequest$outboundSchema;
+  /** @deprecated use `UpdateFormResponsesRequest$Outbound` instead. */
+  export type Outbound = UpdateFormResponsesRequest$Outbound;
+}
+
+export function updateFormResponsesRequestToJSON(
+  updateFormResponsesRequest: UpdateFormResponsesRequest,
+): string {
+  return JSON.stringify(
+    UpdateFormResponsesRequest$outboundSchema.parse(updateFormResponsesRequest),
+  );
+}
+
+export function updateFormResponsesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateFormResponsesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateFormResponsesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateFormResponsesRequest' from JSON`,
+  );
+}

package/src/sdk/formresponses.ts

@@ -2,8 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { formResponsesCreateFormResponses } from "../funcs/formResponsesCreateFormResponses.js";
+import { formResponsesDeleteFormResponses } from "../funcs/formResponsesDeleteFormResponses.js";
 import { formResponsesGetFormResponses } from "../funcs/formResponsesGetFormResponses.js";
 import { formResponsesListFormResponses } from "../funcs/formResponsesListFormResponses.js";
+import { formResponsesUpdateFormResponses } from "../funcs/formResponsesUpdateFormResponses.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -30,6 +33,28 @@ export class FormResponses extends ClientSDK {
     ));
   }
 
+  /**
+   * Create a new Form Response
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_forms**.
+   *
+   * #### 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 createFormResponses(
+    request: components.FormResponseInput,
+    options?: RequestOptions,
+  ): Promise<operations.CreateFormResponsesResponse> {
+    return unwrapAsync(formResponsesCreateFormResponses(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a Form Response
    *
@@ -48,4 +73,44 @@ export class FormResponses extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Update a Form Response
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_forms**.
+   */
+  async updateFormResponses(
+    request: operations.UpdateFormResponsesRequest,
+    options?: RequestOptions,
+  ): Promise<components.Result> {
+    return unwrapAsync(formResponsesUpdateFormResponses(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a Form Response
+   *
+   * @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_forms**.
+   */
+  async deleteFormResponses(
+    request: operations.DeleteFormResponsesRequest,
+    options?: RequestOptions,
+  ): Promise<components.Result> {
+    return unwrapAsync(formResponsesDeleteFormResponses(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/inbox.ts

@@ -6,6 +6,7 @@ import { inboxAddNoteToInboxMessage } from "../funcs/inboxAddNoteToInboxMessage.
 import { inboxArchiveInboxMessage } from "../funcs/inboxArchiveInboxMessage.js";
 import { inboxAttachInboxMessageToJob } from "../funcs/inboxAttachInboxMessageToJob.js";
 import { inboxConvertInboxMessageToJob } from "../funcs/inboxConvertInboxMessageToJob.js";
+import { inboxCreateInboxMessage } from "../funcs/inboxCreateInboxMessage.js";
 import { inboxGetInboxMessage } from "../funcs/inboxGetInboxMessage.js";
 import { inboxListInboxMessages } from "../funcs/inboxListInboxMessages.js";
 import { inboxMarkInboxMessageAsRead } from "../funcs/inboxMarkInboxMessageAsRead.js";
@@ -33,6 +34,23 @@ export class Inbox extends ClientSDK {
     ));
   }
 
+  /**
+   * Create a new inbox message
+   *
+   * @remarks
+   * Creates a new inbox message that will appear in the inbox
+   */
+  async createInboxMessage(
+    request: components.CreateInboxMessageRequest,
+    options?: RequestOptions,
+  ): Promise<components.InboxMessageDetail> {
+    return unwrapAsync(inboxCreateInboxMessage(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get inbox message details
    *