servicem8 0.9.49 → 0.9.51

package/src/models/operations/deletesuppliers.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 DeleteSuppliersRequest = {
+  /**
+   * UUID of the Supplier
+   */
+  uuid: string;
+};
+
+/** @internal */
+export const DeleteSuppliersRequest$inboundSchema: z.ZodType<
+  DeleteSuppliersRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+});
+
+/** @internal */
+export type DeleteSuppliersRequest$Outbound = {
+  uuid: string;
+};
+
+/** @internal */
+export const DeleteSuppliersRequest$outboundSchema: z.ZodType<
+  DeleteSuppliersRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteSuppliersRequest
+> = 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 DeleteSuppliersRequest$ {
+  /** @deprecated use `DeleteSuppliersRequest$inboundSchema` instead. */
+  export const inboundSchema = DeleteSuppliersRequest$inboundSchema;
+  /** @deprecated use `DeleteSuppliersRequest$outboundSchema` instead. */
+  export const outboundSchema = DeleteSuppliersRequest$outboundSchema;
+  /** @deprecated use `DeleteSuppliersRequest$Outbound` instead. */
+  export type Outbound = DeleteSuppliersRequest$Outbound;
+}
+
+export function deleteSuppliersRequestToJSON(
+  deleteSuppliersRequest: DeleteSuppliersRequest,
+): string {
+  return JSON.stringify(
+    DeleteSuppliersRequest$outboundSchema.parse(deleteSuppliersRequest),
+  );
+}
+
+export function deleteSuppliersRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteSuppliersRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteSuppliersRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteSuppliersRequest' from JSON`,
+  );
+}

package/src/models/operations/getsuppliers.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 GetSuppliersRequest = {
+  /**
+   * UUID of the Supplier
+   */
+  uuid: string;
+};
+
+/** @internal */
+export const GetSuppliersRequest$inboundSchema: z.ZodType<
+  GetSuppliersRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+});
+
+/** @internal */
+export type GetSuppliersRequest$Outbound = {
+  uuid: string;
+};
+
+/** @internal */
+export const GetSuppliersRequest$outboundSchema: z.ZodType<
+  GetSuppliersRequest$Outbound,
+  z.ZodTypeDef,
+  GetSuppliersRequest
+> = 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 GetSuppliersRequest$ {
+  /** @deprecated use `GetSuppliersRequest$inboundSchema` instead. */
+  export const inboundSchema = GetSuppliersRequest$inboundSchema;
+  /** @deprecated use `GetSuppliersRequest$outboundSchema` instead. */
+  export const outboundSchema = GetSuppliersRequest$outboundSchema;
+  /** @deprecated use `GetSuppliersRequest$Outbound` instead. */
+  export type Outbound = GetSuppliersRequest$Outbound;
+}
+
+export function getSuppliersRequestToJSON(
+  getSuppliersRequest: GetSuppliersRequest,
+): string {
+  return JSON.stringify(
+    GetSuppliersRequest$outboundSchema.parse(getSuppliersRequest),
+  );
+}
+
+export function getSuppliersRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSuppliersRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSuppliersRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSuppliersRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -38,6 +38,7 @@ export * from "./createnotes.js";
 export * from "./createsmstemplates.js";
 export * from "./createstaffmembers.js";
 export * from "./createstaffmessages.js";
+export * from "./createsuppliers.js";
 export * from "./createtasks.js";
 export * from "./createtaxrates.js";
 export * from "./deleteallocationwindows.js";
@@ -72,6 +73,7 @@ export * from "./deletenotes.js";
 export * from "./deletesmstemplates.js";
 export * from "./deletestaffmembers.js";
 export * from "./deletestaffmessages.js";
+export * from "./deletesuppliers.js";
 export * from "./deletetasks.js";
 export * from "./deletetaxrates.js";
 export * from "./generalsearch.js";
@@ -110,6 +112,7 @@ export * from "./getsecurityroles.js";
 export * from "./getsmstemplates.js";
 export * from "./getstaffmembers.js";
 export * from "./getstaffmessages.js";
+export * from "./getsuppliers.js";
 export * from "./gettasks.js";
 export * from "./gettaxrates.js";
 export * from "./getvendors.js";
@@ -150,5 +153,6 @@ export * from "./updatenotes.js";
 export * from "./updatesmstemplates.js";
 export * from "./updatestaffmembers.js";
 export * from "./updatestaffmessages.js";
+export * from "./updatesuppliers.js";
 export * from "./updatetasks.js";
 export * from "./updatetaxrates.js";

package/src/models/operations/updatesuppliers.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 UpdateSuppliersRequest = {
+  /**
+   * UUID of the Supplier
+   */
+  uuid: string;
+  /**
+   * Supplier fields to update
+   */
+  supplierCreate: components.SupplierCreate;
+};
+
+/** @internal */
+export const UpdateSuppliersRequest$inboundSchema: z.ZodType<
+  UpdateSuppliersRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uuid: z.string(),
+  SupplierCreate: components.SupplierCreate$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "SupplierCreate": "supplierCreate",
+  });
+});
+
+/** @internal */
+export type UpdateSuppliersRequest$Outbound = {
+  uuid: string;
+  SupplierCreate: components.SupplierCreate$Outbound;
+};
+
+/** @internal */
+export const UpdateSuppliersRequest$outboundSchema: z.ZodType<
+  UpdateSuppliersRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateSuppliersRequest
+> = z.object({
+  uuid: z.string(),
+  supplierCreate: components.SupplierCreate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    supplierCreate: "SupplierCreate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateSuppliersRequest$ {
+  /** @deprecated use `UpdateSuppliersRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateSuppliersRequest$inboundSchema;
+  /** @deprecated use `UpdateSuppliersRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateSuppliersRequest$outboundSchema;
+  /** @deprecated use `UpdateSuppliersRequest$Outbound` instead. */
+  export type Outbound = UpdateSuppliersRequest$Outbound;
+}
+
+export function updateSuppliersRequestToJSON(
+  updateSuppliersRequest: UpdateSuppliersRequest,
+): string {
+  return JSON.stringify(
+    UpdateSuppliersRequest$outboundSchema.parse(updateSuppliersRequest),
+  );
+}
+
+export function updateSuppliersRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateSuppliersRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateSuppliersRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateSuppliersRequest' from JSON`,
+  );
+}

package/src/sdk/sdk.ts

@@ -39,6 +39,7 @@ import { SecurityRoles } from "./securityroles.js";
 import { SMSTemplates } from "./smstemplates.js";
 import { StaffMembers } from "./staffmembers.js";
 import { StaffMessages } from "./staffmessages.js";
+import { Suppliers } from "./suppliers.js";
 import { Tasks } from "./tasks.js";
 import { TaxRates } from "./taxrates.js";
 import { Vendors } from "./vendors.js";
@@ -214,6 +215,11 @@ export class ServiceM8 extends ClientSDK {
     return (this._staffMessages ??= new StaffMessages(this._options));
   }
 
+  private _suppliers?: Suppliers;
+  get suppliers(): Suppliers {
+    return (this._suppliers ??= new Suppliers(this._options));
+  }
+
   private _tasks?: Tasks;
   get tasks(): Tasks {
     return (this._tasks ??= new Tasks(this._options));

package/src/sdk/suppliers.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { suppliersCreateSuppliers } from "../funcs/suppliersCreateSuppliers.js";
+import { suppliersDeleteSuppliers } from "../funcs/suppliersDeleteSuppliers.js";
+import { suppliersGetSuppliers } from "../funcs/suppliersGetSuppliers.js";
+import { suppliersListSuppliers } from "../funcs/suppliersListSuppliers.js";
+import { suppliersUpdateSuppliers } from "../funcs/suppliersUpdateSuppliers.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 Suppliers extends ClientSDK {
+  /**
+   * List all Suppliers
+   *
+   * @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_suppliers**.
+   */
+  async listSuppliers(
+    options?: RequestOptions,
+  ): Promise<Array<components.Supplier>> {
+    return unwrapAsync(suppliersListSuppliers(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new Supplier
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_suppliers**.
+   *
+   * #### 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 createSuppliers(
+    request: components.SupplierCreate,
+    options?: RequestOptions,
+  ): Promise<operations.CreateSuppliersResponse> {
+    return unwrapAsync(suppliersCreateSuppliers(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a Supplier
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **read_suppliers**.
+   */
+  async getSuppliers(
+    request: operations.GetSuppliersRequest,
+    options?: RequestOptions,
+  ): Promise<components.Supplier> {
+    return unwrapAsync(suppliersGetSuppliers(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a Supplier
+   *
+   * @remarks
+   *
+   * #### OAuth Scope
+   * This endpoint requires the following OAuth scope **manage_suppliers**.
+   */
+  async updateSuppliers(
+    request: operations.UpdateSuppliersRequest,
+    options?: RequestOptions,
+  ): Promise<components.Result> {
+    return unwrapAsync(suppliersUpdateSuppliers(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a Supplier
+   *
+   * @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_suppliers**.
+   */
+  async deleteSuppliers(
+    request: operations.DeleteSuppliersRequest,
+    options?: RequestOptions,
+  ): Promise<components.Result> {
+    return unwrapAsync(suppliersDeleteSuppliers(
+      this,
+      request,
+      options,
+    ));
+  }
+}