@greensecurity/javascript-sdk 0.37.12 → 0.38.2

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";
@@ -45,6 +46,7 @@ export * from "./vendorsGetSubscription.js";
 export * from "./vendorsGetVendorCredentialDetails.js";
 export * from "./vendorsGetVendorCredentialFile.js";
 export * from "./vendorsGetVendorInvoiceDetails.js";
+export * from "./vendorsGetVendorInvoiceReceipt.js";
 export * from "./vendorsGetVendorLegalName.js";
 export * from "./vendorsGetVendorsDetails.js";
 export * from "./vendorsListVendorAdditionalFacilityFields.js";

package/src/react-query/organizationsListOrSearchDepartmentContacts.ts

@@ -0,0 +1,386 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsListOrSearchDepartmentContacts } from "../funcs/organizationsListOrSearchDepartmentContacts.js";
+import { combineSignals } from "../lib/primitives.js";
+import { 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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type OrganizationsListOrSearchDepartmentContactsQueryData =
+  operations.ListOrSearchDepartmentContactsResponse;
+
+export type OrganizationsListOrSearchDepartmentContactsInfiniteQueryData =
+  PageIterator<
+    operations.ListOrSearchDepartmentContactsResponse,
+    { page: number }
+  >;
+
+export type OrganizationsListOrSearchDepartmentContactsPageParams =
+  PageIterator<
+    operations.ListOrSearchDepartmentContactsResponse,
+    { page: number }
+  >["~next"];
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContacts(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: QueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsQueryData
+  >,
+): UseQueryResult<OrganizationsListOrSearchDepartmentContactsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsListOrSearchDepartmentContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContactsSuspense(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsQueryData
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsListOrSearchDepartmentContactsQueryData,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsListOrSearchDepartmentContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContactsInfinite(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: InfiniteQueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+      OrganizationsListOrSearchDepartmentContactsPageParams
+    >,
+    QueryKey,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >({
+    ...buildOrganizationsListOrSearchDepartmentContactsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContactsInfiniteSuspense(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+      OrganizationsListOrSearchDepartmentContactsPageParams
+    >,
+    QueryKey,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >({
+    ...buildOrganizationsListOrSearchDepartmentContactsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchOrganizationsListOrSearchDepartmentContacts(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchDepartmentContactsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsListOrSearchDepartmentContactsQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setOrganizationsListOrSearchDepartmentContactsData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      search?: string | undefined;
+      expand?: Array<components.Expand> | undefined;
+    },
+  ],
+  data: OrganizationsListOrSearchDepartmentContactsQueryData,
+): OrganizationsListOrSearchDepartmentContactsQueryData | undefined {
+  const key = queryKeyOrganizationsListOrSearchDepartmentContacts(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    OrganizationsListOrSearchDepartmentContactsQueryData
+  >(key, data);
+}
+
+export function invalidateOrganizationsListOrSearchDepartmentContacts(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      id: number,
+      parameters: {
+        sort?: string | null | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+        search?: string | undefined;
+        expand?: Array<components.Expand> | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listOrSearchDepartmentContacts",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsListOrSearchDepartmentContacts(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listOrSearchDepartmentContacts",
+    ],
+  });
+}
+
+export function buildOrganizationsListOrSearchDepartmentContactsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsListOrSearchDepartmentContactsQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListOrSearchDepartmentContacts(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      search: request.search,
+      expand: request.expand,
+    }),
+    queryFn: async function organizationsListOrSearchDepartmentContactsQueryFn(
+      ctx,
+    ): Promise<OrganizationsListOrSearchDepartmentContactsQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(organizationsListOrSearchDepartmentContacts(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildOrganizationsListOrSearchDepartmentContactsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      OrganizationsListOrSearchDepartmentContactsPageParams
+    >,
+  ) => Promise<OrganizationsListOrSearchDepartmentContactsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListOrSearchDepartmentContacts(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      search: request.search,
+      expand: request.expand,
+    }),
+    queryFn: async function organizationsListOrSearchDepartmentContactsQuery(
+      ctx,
+    ): Promise<OrganizationsListOrSearchDepartmentContactsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(organizationsListOrSearchDepartmentContacts(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(organizationsListOrSearchDepartmentContacts(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyOrganizationsListOrSearchDepartmentContacts(
+  id: number,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    search?: string | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "listOrSearchDepartmentContacts",
+    id,
+    parameters,
+  ];
+}