servicem8 0.9.26 → 0.9.28

package/src/models/operations/listdocumenttemplates.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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListDocumentTemplatesResponse =
+  | components.ErrorT
+  | Array<components.DocumentTemplate>;
+
+/** @internal */
+export const ListDocumentTemplatesResponse$inboundSchema: z.ZodType<
+  ListDocumentTemplatesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.ErrorT$inboundSchema,
+  z.array(components.DocumentTemplate$inboundSchema),
+]);
+
+/** @internal */
+export type ListDocumentTemplatesResponse$Outbound =
+  | components.ErrorT$Outbound
+  | Array<components.DocumentTemplate$Outbound>;
+
+/** @internal */
+export const ListDocumentTemplatesResponse$outboundSchema: z.ZodType<
+  ListDocumentTemplatesResponse$Outbound,
+  z.ZodTypeDef,
+  ListDocumentTemplatesResponse
+> = z.union([
+  components.ErrorT$outboundSchema,
+  z.array(components.DocumentTemplate$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListDocumentTemplatesResponse$ {
+  /** @deprecated use `ListDocumentTemplatesResponse$inboundSchema` instead. */
+  export const inboundSchema = ListDocumentTemplatesResponse$inboundSchema;
+  /** @deprecated use `ListDocumentTemplatesResponse$outboundSchema` instead. */
+  export const outboundSchema = ListDocumentTemplatesResponse$outboundSchema;
+  /** @deprecated use `ListDocumentTemplatesResponse$Outbound` instead. */
+  export type Outbound = ListDocumentTemplatesResponse$Outbound;
+}
+
+export function listDocumentTemplatesResponseToJSON(
+  listDocumentTemplatesResponse: ListDocumentTemplatesResponse,
+): string {
+  return JSON.stringify(
+    ListDocumentTemplatesResponse$outboundSchema.parse(
+      listDocumentTemplatesResponse,
+    ),
+  );
+}
+
+export function listDocumentTemplatesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDocumentTemplatesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDocumentTemplatesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDocumentTemplatesResponse' from JSON`,
+  );
+}

package/src/models/operations/updatedocumenttemplates.ts

@@ -0,0 +1,147 @@
+/*
+ * 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 UpdateDocumentTemplatesRequest = {
+  /**
+   * UUID of the Document Template
+   */
+  uuid: string;
+  /**
+   * Document Template fields to update
+   */
+  documentTemplate: components.DocumentTemplateInput;
+};
+
+export type UpdateDocumentTemplatesResponse =
+  | components.Result
+  | components.ErrorT;
+
+/** @internal */
+export const UpdateDocumentTemplatesRequest$inboundSchema: z.ZodType<
+  UpdateDocumentTemplatesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+  DocumentTemplate: components.DocumentTemplateInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "DocumentTemplate": "documentTemplate",
+  });
+});
+
+/** @internal */
+export type UpdateDocumentTemplatesRequest$Outbound = {
+  uuid: string;
+  DocumentTemplate: components.DocumentTemplateInput$Outbound;
+};
+
+/** @internal */
+export const UpdateDocumentTemplatesRequest$outboundSchema: z.ZodType<
+  UpdateDocumentTemplatesRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateDocumentTemplatesRequest
+> = z.object({
+  uuid: z.string(),
+  documentTemplate: components.DocumentTemplateInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    documentTemplate: "DocumentTemplate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateDocumentTemplatesRequest$ {
+  /** @deprecated use `UpdateDocumentTemplatesRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateDocumentTemplatesRequest$inboundSchema;
+  /** @deprecated use `UpdateDocumentTemplatesRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateDocumentTemplatesRequest$outboundSchema;
+  /** @deprecated use `UpdateDocumentTemplatesRequest$Outbound` instead. */
+  export type Outbound = UpdateDocumentTemplatesRequest$Outbound;
+}
+
+export function updateDocumentTemplatesRequestToJSON(
+  updateDocumentTemplatesRequest: UpdateDocumentTemplatesRequest,
+): string {
+  return JSON.stringify(
+    UpdateDocumentTemplatesRequest$outboundSchema.parse(
+      updateDocumentTemplatesRequest,
+    ),
+  );
+}
+
+export function updateDocumentTemplatesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateDocumentTemplatesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateDocumentTemplatesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateDocumentTemplatesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateDocumentTemplatesResponse$inboundSchema: z.ZodType<
+  UpdateDocumentTemplatesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([components.Result$inboundSchema, components.ErrorT$inboundSchema]);
+
+/** @internal */
+export type UpdateDocumentTemplatesResponse$Outbound =
+  | components.Result$Outbound
+  | components.ErrorT$Outbound;
+
+/** @internal */
+export const UpdateDocumentTemplatesResponse$outboundSchema: z.ZodType<
+  UpdateDocumentTemplatesResponse$Outbound,
+  z.ZodTypeDef,
+  UpdateDocumentTemplatesResponse
+> = 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 UpdateDocumentTemplatesResponse$ {
+  /** @deprecated use `UpdateDocumentTemplatesResponse$inboundSchema` instead. */
+  export const inboundSchema = UpdateDocumentTemplatesResponse$inboundSchema;
+  /** @deprecated use `UpdateDocumentTemplatesResponse$outboundSchema` instead. */
+  export const outboundSchema = UpdateDocumentTemplatesResponse$outboundSchema;
+  /** @deprecated use `UpdateDocumentTemplatesResponse$Outbound` instead. */
+  export type Outbound = UpdateDocumentTemplatesResponse$Outbound;
+}
+
+export function updateDocumentTemplatesResponseToJSON(
+  updateDocumentTemplatesResponse: UpdateDocumentTemplatesResponse,
+): string {
+  return JSON.stringify(
+    UpdateDocumentTemplatesResponse$outboundSchema.parse(
+      updateDocumentTemplatesResponse,
+    ),
+  );
+}
+
+export function updateDocumentTemplatesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateDocumentTemplatesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateDocumentTemplatesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateDocumentTemplatesResponse' from JSON`,
+  );
+}

package/src/sdk/documenttemplates.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentTemplatesCreateDocumentTemplates } from "../funcs/documentTemplatesCreateDocumentTemplates.js";
+import { documentTemplatesDeleteDocumentTemplates } from "../funcs/documentTemplatesDeleteDocumentTemplates.js";
+import { documentTemplatesGetDocumentTemplates } from "../funcs/documentTemplatesGetDocumentTemplates.js";
+import { documentTemplatesListDocumentTemplates } from "../funcs/documentTemplatesListDocumentTemplates.js";
+import { documentTemplatesUpdateDocumentTemplates } from "../funcs/documentTemplatesUpdateDocumentTemplates.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 DocumentTemplates extends ClientSDK {
+  /**
+   * List all Document Templates
+   *
+   * @remarks
+   *
+   * #### Filtering
+   * This endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).
+   */
+  async listDocumentTemplates(
+    options?: RequestOptions,
+  ): Promise<operations.ListDocumentTemplatesResponse> {
+    return unwrapAsync(documentTemplatesListDocumentTemplates(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new Document Template
+   *
+   * @remarks
+   *
+   * #### 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 createDocumentTemplates(
+    request: components.DocumentTemplateInput,
+    options?: RequestOptions,
+  ): Promise<operations.CreateDocumentTemplatesResponse> {
+    return unwrapAsync(documentTemplatesCreateDocumentTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a Document Template
+   */
+  async getDocumentTemplates(
+    request: operations.GetDocumentTemplatesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetDocumentTemplatesResponse> {
+    return unwrapAsync(documentTemplatesGetDocumentTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a Document Template
+   */
+  async updateDocumentTemplates(
+    request: operations.UpdateDocumentTemplatesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateDocumentTemplatesResponse> {
+    return unwrapAsync(documentTemplatesUpdateDocumentTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a Document 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`.
+   */
+  async deleteDocumentTemplates(
+    request: operations.DeleteDocumentTemplatesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteDocumentTemplatesResponse> {
+    return unwrapAsync(documentTemplatesDeleteDocumentTemplates(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -13,6 +13,7 @@ import { Bundles } from "./bundles.js";
 import { Categories } from "./categories.js";
 import { Clients } from "./clients.js";
 import { CompanyContacts } from "./companycontacts.js";
+import { DocumentTemplates } from "./documenttemplates.js";
 import { EmailTemplates } from "./emailtemplates.js";
 import { Feedback } from "./feedback.js";
 import { FormFields } from "./formfields.js";
@@ -88,6 +89,11 @@ export class ServiceM8 extends ClientSDK {
     return (this._companyContacts ??= new CompanyContacts(this._options));
   }
 
+  private _documentTemplates?: DocumentTemplates;
+  get documentTemplates(): DocumentTemplates {
+    return (this._documentTemplates ??= new DocumentTemplates(this._options));
+  }
+
   private _emailTemplates?: EmailTemplates;
   get emailTemplates(): EmailTemplates {
     return (this._emailTemplates ??= new EmailTemplates(this._options));