@greensecurity/javascript-sdk 0.37.12 → 0.37.14

package/src/models/components/departmentmembership.ts

@@ -0,0 +1,201 @@
+/*
+ * 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";
+import {
+  Contact,
+  Contact$inboundSchema,
+  Contact$Outbound,
+  Contact$outboundSchema,
+} from "./contact.js";
+import {
+  DepartmentSummary,
+  DepartmentSummary$inboundSchema,
+  DepartmentSummary$Outbound,
+  DepartmentSummary$outboundSchema,
+} from "./departmentsummary.js";
+
+export type DepartmentMembershipDepartment = DepartmentSummary | number;
+
+export type DepartmentMembershipContact = Contact | number;
+
+/**
+ * A simplified representation of a DepartmentMembership, typically used in list views.
+ */
+export type DepartmentMembership = {
+  id: number;
+  department?: DepartmentSummary | number | null | undefined;
+  contact?: Contact | number | null | undefined;
+};
+
+/** @internal */
+export const DepartmentMembershipDepartment$inboundSchema: z.ZodType<
+  DepartmentMembershipDepartment,
+  z.ZodTypeDef,
+  unknown
+> = z.union([DepartmentSummary$inboundSchema, z.number().int()]);
+
+/** @internal */
+export type DepartmentMembershipDepartment$Outbound =
+  | DepartmentSummary$Outbound
+  | number;
+
+/** @internal */
+export const DepartmentMembershipDepartment$outboundSchema: z.ZodType<
+  DepartmentMembershipDepartment$Outbound,
+  z.ZodTypeDef,
+  DepartmentMembershipDepartment
+> = z.union([DepartmentSummary$outboundSchema, z.number().int()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DepartmentMembershipDepartment$ {
+  /** @deprecated use `DepartmentMembershipDepartment$inboundSchema` instead. */
+  export const inboundSchema = DepartmentMembershipDepartment$inboundSchema;
+  /** @deprecated use `DepartmentMembershipDepartment$outboundSchema` instead. */
+  export const outboundSchema = DepartmentMembershipDepartment$outboundSchema;
+  /** @deprecated use `DepartmentMembershipDepartment$Outbound` instead. */
+  export type Outbound = DepartmentMembershipDepartment$Outbound;
+}
+
+export function departmentMembershipDepartmentToJSON(
+  departmentMembershipDepartment: DepartmentMembershipDepartment,
+): string {
+  return JSON.stringify(
+    DepartmentMembershipDepartment$outboundSchema.parse(
+      departmentMembershipDepartment,
+    ),
+  );
+}
+
+export function departmentMembershipDepartmentFromJSON(
+  jsonString: string,
+): SafeParseResult<DepartmentMembershipDepartment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DepartmentMembershipDepartment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DepartmentMembershipDepartment' from JSON`,
+  );
+}
+
+/** @internal */
+export const DepartmentMembershipContact$inboundSchema: z.ZodType<
+  DepartmentMembershipContact,
+  z.ZodTypeDef,
+  unknown
+> = z.union([Contact$inboundSchema, z.number().int()]);
+
+/** @internal */
+export type DepartmentMembershipContact$Outbound = Contact$Outbound | number;
+
+/** @internal */
+export const DepartmentMembershipContact$outboundSchema: z.ZodType<
+  DepartmentMembershipContact$Outbound,
+  z.ZodTypeDef,
+  DepartmentMembershipContact
+> = z.union([Contact$outboundSchema, z.number().int()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DepartmentMembershipContact$ {
+  /** @deprecated use `DepartmentMembershipContact$inboundSchema` instead. */
+  export const inboundSchema = DepartmentMembershipContact$inboundSchema;
+  /** @deprecated use `DepartmentMembershipContact$outboundSchema` instead. */
+  export const outboundSchema = DepartmentMembershipContact$outboundSchema;
+  /** @deprecated use `DepartmentMembershipContact$Outbound` instead. */
+  export type Outbound = DepartmentMembershipContact$Outbound;
+}
+
+export function departmentMembershipContactToJSON(
+  departmentMembershipContact: DepartmentMembershipContact,
+): string {
+  return JSON.stringify(
+    DepartmentMembershipContact$outboundSchema.parse(
+      departmentMembershipContact,
+    ),
+  );
+}
+
+export function departmentMembershipContactFromJSON(
+  jsonString: string,
+): SafeParseResult<DepartmentMembershipContact, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DepartmentMembershipContact$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DepartmentMembershipContact' from JSON`,
+  );
+}
+
+/** @internal */
+export const DepartmentMembership$inboundSchema: z.ZodType<
+  DepartmentMembership,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  department: z.nullable(
+    z.union([DepartmentSummary$inboundSchema, z.number().int()]),
+  ).optional(),
+  contact: z.nullable(z.union([Contact$inboundSchema, z.number().int()]))
+    .optional(),
+});
+
+/** @internal */
+export type DepartmentMembership$Outbound = {
+  id: number;
+  department?: DepartmentSummary$Outbound | number | null | undefined;
+  contact?: Contact$Outbound | number | null | undefined;
+};
+
+/** @internal */
+export const DepartmentMembership$outboundSchema: z.ZodType<
+  DepartmentMembership$Outbound,
+  z.ZodTypeDef,
+  DepartmentMembership
+> = z.object({
+  id: z.number().int(),
+  department: z.nullable(
+    z.union([DepartmentSummary$outboundSchema, z.number().int()]),
+  ).optional(),
+  contact: z.nullable(z.union([Contact$outboundSchema, z.number().int()]))
+    .optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DepartmentMembership$ {
+  /** @deprecated use `DepartmentMembership$inboundSchema` instead. */
+  export const inboundSchema = DepartmentMembership$inboundSchema;
+  /** @deprecated use `DepartmentMembership$outboundSchema` instead. */
+  export const outboundSchema = DepartmentMembership$outboundSchema;
+  /** @deprecated use `DepartmentMembership$Outbound` instead. */
+  export type Outbound = DepartmentMembership$Outbound;
+}
+
+export function departmentMembershipToJSON(
+  departmentMembership: DepartmentMembership,
+): string {
+  return JSON.stringify(
+    DepartmentMembership$outboundSchema.parse(departmentMembership),
+  );
+}
+
+export function departmentMembershipFromJSON(
+  jsonString: string,
+): SafeParseResult<DepartmentMembership, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DepartmentMembership$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DepartmentMembership' from JSON`,
+  );
+}

package/src/models/components/expand.ts

@@ -84,6 +84,8 @@ export const Expand = {
   ZoneRules: "zone.rules",
   SystemFacilities: "system.facilities",
   SubscriptionExpeditedOffer: "subscription.expedited_offer",
+  DepartmentMembershipContact: "department_membership.contact",
+  DepartmentMembershipDepartment: "department_membership.department",
 } as const;
 /**
  * An expansion scope that is valid for the object being requested.

package/src/models/components/index.ts

@@ -14,6 +14,7 @@ export * from "./credentialstatus.js";
 export * from "./credit.js";
 export * from "./datarequest.js";
 export * from "./department.js";
+export * from "./departmentmembership.js";
 export * from "./departmentsummary.js";
 export * from "./desc.js";
 export * from "./expand.js";
@@ -46,6 +47,7 @@ export * from "./supportarticle.js";
 export * from "./systemsummary.js";
 export * from "./user.js";
 export * from "./userlocation.js";
+export * from "./usersummary.js";
 export * from "./vendor.js";
 export * from "./vendoradditionalfacilityfields.js";
 export * from "./vendorcredentialdatarequest.js";

package/src/models/components/usersummary.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";
+
+/**
+ * A simplified representation of a User, typically used in list views.
+ */
+export type UserSummary = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const UserSummary$inboundSchema: z.ZodType<
+  UserSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
+
+/** @internal */
+export type UserSummary$Outbound = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const UserSummary$outboundSchema: z.ZodType<
+  UserSummary$Outbound,
+  z.ZodTypeDef,
+  UserSummary
+> = z.object({
+  id: z.number().int(),
+  name: 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 UserSummary$ {
+  /** @deprecated use `UserSummary$inboundSchema` instead. */
+  export const inboundSchema = UserSummary$inboundSchema;
+  /** @deprecated use `UserSummary$outboundSchema` instead. */
+  export const outboundSchema = UserSummary$outboundSchema;
+  /** @deprecated use `UserSummary$Outbound` instead. */
+  export type Outbound = UserSummary$Outbound;
+}
+
+export function userSummaryToJSON(userSummary: UserSummary): string {
+  return JSON.stringify(UserSummary$outboundSchema.parse(userSummary));
+}
+
+export function userSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<UserSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserSummary' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -33,6 +33,7 @@ export * from "./getvendorsdetails.js";
 export * from "./getwebhookendpoint.js";
 export * from "./listallwebhookendpoints.js";
 export * from "./listorsearchcompanies.js";
+export * from "./listorsearchdepartmentcontacts.js";
 export * from "./listorsearchdepartments.js";
 export * from "./listorsearchfacilities.js";
 export * from "./listorsearchsecurityzones.js";

package/src/models/operations/listorsearchdepartmentcontacts.ts

@@ -0,0 +1,280 @@
+/*
+ * 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 ListOrSearchDepartmentContactsRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  /**
+   * A comma-separated list of object attributes to sort on.
+   */
+  sort?: string | null | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * Search for objects by the search string
+   */
+  search?: string | undefined;
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListOrSearchDepartmentContactsResponseBody = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.DepartmentMembership | null>;
+};
+
+export type ListOrSearchDepartmentContactsResponse = {
+  result: ListOrSearchDepartmentContactsResponseBody;
+};
+
+/** @internal */
+export const ListOrSearchDepartmentContactsRequest$inboundSchema: z.ZodType<
+  ListOrSearchDepartmentContactsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$inboundSchema.optional(),
+  page: z.number().int().optional(),
+  items_per_page: z.number().int().optional(),
+  search: z.string().optional(),
+  expand: z.array(components.Expand$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "items_per_page": "itemsPerPage",
+  });
+});
+
+/** @internal */
+export type ListOrSearchDepartmentContactsRequest$Outbound = {
+  id: number;
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  search?: string | undefined;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ListOrSearchDepartmentContactsRequest$outboundSchema: z.ZodType<
+  ListOrSearchDepartmentContactsRequest$Outbound,
+  z.ZodTypeDef,
+  ListOrSearchDepartmentContactsRequest
+> = z.object({
+  id: z.number().int(),
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  search: z.string().optional(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListOrSearchDepartmentContactsRequest$ {
+  /** @deprecated use `ListOrSearchDepartmentContactsRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    ListOrSearchDepartmentContactsRequest$inboundSchema;
+  /** @deprecated use `ListOrSearchDepartmentContactsRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    ListOrSearchDepartmentContactsRequest$outboundSchema;
+  /** @deprecated use `ListOrSearchDepartmentContactsRequest$Outbound` instead. */
+  export type Outbound = ListOrSearchDepartmentContactsRequest$Outbound;
+}
+
+export function listOrSearchDepartmentContactsRequestToJSON(
+  listOrSearchDepartmentContactsRequest: ListOrSearchDepartmentContactsRequest,
+): string {
+  return JSON.stringify(
+    ListOrSearchDepartmentContactsRequest$outboundSchema.parse(
+      listOrSearchDepartmentContactsRequest,
+    ),
+  );
+}
+
+export function listOrSearchDepartmentContactsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListOrSearchDepartmentContactsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListOrSearchDepartmentContactsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListOrSearchDepartmentContactsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListOrSearchDepartmentContactsResponseBody$inboundSchema:
+  z.ZodType<ListOrSearchDepartmentContactsResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      pager: components.Pager$inboundSchema,
+      items: z.array(z.nullable(components.DepartmentMembership$inboundSchema)),
+    });
+
+/** @internal */
+export type ListOrSearchDepartmentContactsResponseBody$Outbound = {
+  pager: components.Pager$Outbound;
+  items: Array<components.DepartmentMembership$Outbound | null>;
+};
+
+/** @internal */
+export const ListOrSearchDepartmentContactsResponseBody$outboundSchema:
+  z.ZodType<
+    ListOrSearchDepartmentContactsResponseBody$Outbound,
+    z.ZodTypeDef,
+    ListOrSearchDepartmentContactsResponseBody
+  > = z.object({
+    pager: components.Pager$outboundSchema,
+    items: z.array(z.nullable(components.DepartmentMembership$outboundSchema)),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListOrSearchDepartmentContactsResponseBody$ {
+  /** @deprecated use `ListOrSearchDepartmentContactsResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    ListOrSearchDepartmentContactsResponseBody$inboundSchema;
+  /** @deprecated use `ListOrSearchDepartmentContactsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    ListOrSearchDepartmentContactsResponseBody$outboundSchema;
+  /** @deprecated use `ListOrSearchDepartmentContactsResponseBody$Outbound` instead. */
+  export type Outbound = ListOrSearchDepartmentContactsResponseBody$Outbound;
+}
+
+export function listOrSearchDepartmentContactsResponseBodyToJSON(
+  listOrSearchDepartmentContactsResponseBody:
+    ListOrSearchDepartmentContactsResponseBody,
+): string {
+  return JSON.stringify(
+    ListOrSearchDepartmentContactsResponseBody$outboundSchema.parse(
+      listOrSearchDepartmentContactsResponseBody,
+    ),
+  );
+}
+
+export function listOrSearchDepartmentContactsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListOrSearchDepartmentContactsResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListOrSearchDepartmentContactsResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListOrSearchDepartmentContactsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListOrSearchDepartmentContactsResponse$inboundSchema: z.ZodType<
+  ListOrSearchDepartmentContactsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() =>
+    ListOrSearchDepartmentContactsResponseBody$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListOrSearchDepartmentContactsResponse$Outbound = {
+  Result: ListOrSearchDepartmentContactsResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListOrSearchDepartmentContactsResponse$outboundSchema: z.ZodType<
+  ListOrSearchDepartmentContactsResponse$Outbound,
+  z.ZodTypeDef,
+  ListOrSearchDepartmentContactsResponse
+> = z.object({
+  result: z.lazy(() =>
+    ListOrSearchDepartmentContactsResponseBody$outboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    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 ListOrSearchDepartmentContactsResponse$ {
+  /** @deprecated use `ListOrSearchDepartmentContactsResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    ListOrSearchDepartmentContactsResponse$inboundSchema;
+  /** @deprecated use `ListOrSearchDepartmentContactsResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    ListOrSearchDepartmentContactsResponse$outboundSchema;
+  /** @deprecated use `ListOrSearchDepartmentContactsResponse$Outbound` instead. */
+  export type Outbound = ListOrSearchDepartmentContactsResponse$Outbound;
+}
+
+export function listOrSearchDepartmentContactsResponseToJSON(
+  listOrSearchDepartmentContactsResponse:
+    ListOrSearchDepartmentContactsResponse,
+): string {
+  return JSON.stringify(
+    ListOrSearchDepartmentContactsResponse$outboundSchema.parse(
+      listOrSearchDepartmentContactsResponse,
+    ),
+  );
+}
+
+export function listOrSearchDepartmentContactsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListOrSearchDepartmentContactsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListOrSearchDepartmentContactsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListOrSearchDepartmentContactsResponse' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -13,6 +13,7 @@ export * from "./invoicesCreateInvoice.js";
 export * from "./invoicesMakePayment.js";
 export * from "./invoicesUpdateInvoice.js";
 export * from "./organizationsGetFacility.js";
+export * from "./organizationsListOrSearchDepartmentContacts.js";
 export * from "./organizationsListOrSearchDepartments.js";
 export * from "./organizationsListOrSearchFacilities.js";
 export * from "./supportArticlesGetSupportArticle.js";