@greensecurity/javascript-sdk 0.39.1 → 0.39.4

package/src/models/operations/listorsearchvendorinvitees.ts

@@ -0,0 +1,261 @@
+/*
+ * 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 ListOrSearchVendorInviteesRequest = {
+  /**
+   * 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;
+  /**
+   * 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;
+  /**
+   * Search for objects by the search string
+   */
+  search?: string | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListOrSearchVendorInviteesResponseBody = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.Contact | null>;
+};
+
+export type ListOrSearchVendorInviteesResponse = {
+  result: ListOrSearchVendorInviteesResponseBody;
+};
+
+/** @internal */
+export const ListOrSearchVendorInviteesRequest$inboundSchema: z.ZodType<
+  ListOrSearchVendorInviteesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$inboundSchema.optional(),
+  page: z.number().int().optional(),
+  items_per_page: z.number().int().optional(),
+  expand: z.array(components.Expand$inboundSchema).optional(),
+  search: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "items_per_page": "itemsPerPage",
+  });
+});
+
+/** @internal */
+export type ListOrSearchVendorInviteesRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  expand?: Array<string> | undefined;
+  search?: string | undefined;
+};
+
+/** @internal */
+export const ListOrSearchVendorInviteesRequest$outboundSchema: z.ZodType<
+  ListOrSearchVendorInviteesRequest$Outbound,
+  z.ZodTypeDef,
+  ListOrSearchVendorInviteesRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  search: z.string().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 ListOrSearchVendorInviteesRequest$ {
+  /** @deprecated use `ListOrSearchVendorInviteesRequest$inboundSchema` instead. */
+  export const inboundSchema = ListOrSearchVendorInviteesRequest$inboundSchema;
+  /** @deprecated use `ListOrSearchVendorInviteesRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    ListOrSearchVendorInviteesRequest$outboundSchema;
+  /** @deprecated use `ListOrSearchVendorInviteesRequest$Outbound` instead. */
+  export type Outbound = ListOrSearchVendorInviteesRequest$Outbound;
+}
+
+export function listOrSearchVendorInviteesRequestToJSON(
+  listOrSearchVendorInviteesRequest: ListOrSearchVendorInviteesRequest,
+): string {
+  return JSON.stringify(
+    ListOrSearchVendorInviteesRequest$outboundSchema.parse(
+      listOrSearchVendorInviteesRequest,
+    ),
+  );
+}
+
+export function listOrSearchVendorInviteesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListOrSearchVendorInviteesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListOrSearchVendorInviteesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListOrSearchVendorInviteesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListOrSearchVendorInviteesResponseBody$inboundSchema: z.ZodType<
+  ListOrSearchVendorInviteesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(z.nullable(components.Contact$inboundSchema)),
+});
+
+/** @internal */
+export type ListOrSearchVendorInviteesResponseBody$Outbound = {
+  pager: components.Pager$Outbound;
+  items: Array<components.Contact$Outbound | null>;
+};
+
+/** @internal */
+export const ListOrSearchVendorInviteesResponseBody$outboundSchema: z.ZodType<
+  ListOrSearchVendorInviteesResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListOrSearchVendorInviteesResponseBody
+> = z.object({
+  pager: components.Pager$outboundSchema,
+  items: z.array(z.nullable(components.Contact$outboundSchema)),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListOrSearchVendorInviteesResponseBody$ {
+  /** @deprecated use `ListOrSearchVendorInviteesResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    ListOrSearchVendorInviteesResponseBody$inboundSchema;
+  /** @deprecated use `ListOrSearchVendorInviteesResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    ListOrSearchVendorInviteesResponseBody$outboundSchema;
+  /** @deprecated use `ListOrSearchVendorInviteesResponseBody$Outbound` instead. */
+  export type Outbound = ListOrSearchVendorInviteesResponseBody$Outbound;
+}
+
+export function listOrSearchVendorInviteesResponseBodyToJSON(
+  listOrSearchVendorInviteesResponseBody:
+    ListOrSearchVendorInviteesResponseBody,
+): string {
+  return JSON.stringify(
+    ListOrSearchVendorInviteesResponseBody$outboundSchema.parse(
+      listOrSearchVendorInviteesResponseBody,
+    ),
+  );
+}
+
+export function listOrSearchVendorInviteesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListOrSearchVendorInviteesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListOrSearchVendorInviteesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListOrSearchVendorInviteesResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListOrSearchVendorInviteesResponse$inboundSchema: z.ZodType<
+  ListOrSearchVendorInviteesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListOrSearchVendorInviteesResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListOrSearchVendorInviteesResponse$Outbound = {
+  Result: ListOrSearchVendorInviteesResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListOrSearchVendorInviteesResponse$outboundSchema: z.ZodType<
+  ListOrSearchVendorInviteesResponse$Outbound,
+  z.ZodTypeDef,
+  ListOrSearchVendorInviteesResponse
+> = z.object({
+  result: z.lazy(() => ListOrSearchVendorInviteesResponseBody$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 ListOrSearchVendorInviteesResponse$ {
+  /** @deprecated use `ListOrSearchVendorInviteesResponse$inboundSchema` instead. */
+  export const inboundSchema = ListOrSearchVendorInviteesResponse$inboundSchema;
+  /** @deprecated use `ListOrSearchVendorInviteesResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    ListOrSearchVendorInviteesResponse$outboundSchema;
+  /** @deprecated use `ListOrSearchVendorInviteesResponse$Outbound` instead. */
+  export type Outbound = ListOrSearchVendorInviteesResponse$Outbound;
+}
+
+export function listOrSearchVendorInviteesResponseToJSON(
+  listOrSearchVendorInviteesResponse: ListOrSearchVendorInviteesResponse,
+): string {
+  return JSON.stringify(
+    ListOrSearchVendorInviteesResponse$outboundSchema.parse(
+      listOrSearchVendorInviteesResponse,
+    ),
+  );
+}
+
+export function listOrSearchVendorInviteesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListOrSearchVendorInviteesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListOrSearchVendorInviteesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListOrSearchVendorInviteesResponse' from JSON`,
+  );
+}

package/src/react-query/eventsListOrSearchVendorInvitees.ts

@@ -0,0 +1,378 @@
+/*
+ * 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 { eventsListOrSearchVendorInvitees } from "../funcs/eventsListOrSearchVendorInvitees.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 EventsListOrSearchVendorInviteesQueryData =
+  operations.ListOrSearchVendorInviteesResponse;
+
+export type EventsListOrSearchVendorInviteesInfiniteQueryData = PageIterator<
+  operations.ListOrSearchVendorInviteesResponse,
+  { page: number }
+>;
+
+export type EventsListOrSearchVendorInviteesPageParams = PageIterator<
+  operations.ListOrSearchVendorInviteesResponse,
+  { page: number }
+>["~next"];
+
+/**
+ * List or search vendor invitees
+ *
+ * @remarks
+ * List or search vendor invitees.
+ *
+ * Available `expand` scopes are:
+ *
+ * - contact.facility
+ * - contact.system
+ * - contact.department
+ * - contact.user
+ */
+export function useEventsListOrSearchVendorInvitees(
+  request: operations.ListOrSearchVendorInviteesRequest,
+  options?: QueryHookOptions<EventsListOrSearchVendorInviteesQueryData>,
+): UseQueryResult<EventsListOrSearchVendorInviteesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildEventsListOrSearchVendorInviteesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search vendor invitees
+ *
+ * @remarks
+ * List or search vendor invitees.
+ *
+ * Available `expand` scopes are:
+ *
+ * - contact.facility
+ * - contact.system
+ * - contact.department
+ * - contact.user
+ */
+export function useEventsListOrSearchVendorInviteesSuspense(
+  request: operations.ListOrSearchVendorInviteesRequest,
+  options?: SuspenseQueryHookOptions<EventsListOrSearchVendorInviteesQueryData>,
+): UseSuspenseQueryResult<EventsListOrSearchVendorInviteesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildEventsListOrSearchVendorInviteesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search vendor invitees
+ *
+ * @remarks
+ * List or search vendor invitees.
+ *
+ * Available `expand` scopes are:
+ *
+ * - contact.facility
+ * - contact.system
+ * - contact.department
+ * - contact.user
+ */
+export function useEventsListOrSearchVendorInviteesInfinite(
+  request: operations.ListOrSearchVendorInviteesRequest,
+  options?: InfiniteQueryHookOptions<
+    EventsListOrSearchVendorInviteesInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    EventsListOrSearchVendorInviteesInfiniteQueryData,
+    EventsListOrSearchVendorInviteesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    EventsListOrSearchVendorInviteesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      EventsListOrSearchVendorInviteesInfiniteQueryData,
+      EventsListOrSearchVendorInviteesPageParams
+    >,
+    QueryKey,
+    EventsListOrSearchVendorInviteesPageParams
+  >({
+    ...buildEventsListOrSearchVendorInviteesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List or search vendor invitees
+ *
+ * @remarks
+ * List or search vendor invitees.
+ *
+ * Available `expand` scopes are:
+ *
+ * - contact.facility
+ * - contact.system
+ * - contact.department
+ * - contact.user
+ */
+export function useEventsListOrSearchVendorInviteesInfiniteSuspense(
+  request: operations.ListOrSearchVendorInviteesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    EventsListOrSearchVendorInviteesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    EventsListOrSearchVendorInviteesInfiniteQueryData,
+    EventsListOrSearchVendorInviteesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    EventsListOrSearchVendorInviteesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      EventsListOrSearchVendorInviteesInfiniteQueryData,
+      EventsListOrSearchVendorInviteesPageParams
+    >,
+    QueryKey,
+    EventsListOrSearchVendorInviteesPageParams
+  >({
+    ...buildEventsListOrSearchVendorInviteesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchEventsListOrSearchVendorInvitees(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchVendorInviteesRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildEventsListOrSearchVendorInviteesQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setEventsListOrSearchVendorInviteesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+      search?: string | undefined;
+    },
+  ],
+  data: EventsListOrSearchVendorInviteesQueryData,
+): EventsListOrSearchVendorInviteesQueryData | undefined {
+  const key = queryKeyEventsListOrSearchVendorInvitees(...queryKeyBase);
+
+  return client.setQueryData<EventsListOrSearchVendorInviteesQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateEventsListOrSearchVendorInvitees(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+      search?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "events",
+      "listOrSearchVendorInvitees",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllEventsListOrSearchVendorInvitees(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "events",
+      "listOrSearchVendorInvitees",
+    ],
+  });
+}
+
+export function buildEventsListOrSearchVendorInviteesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchVendorInviteesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<EventsListOrSearchVendorInviteesQueryData>;
+} {
+  return {
+    queryKey: queryKeyEventsListOrSearchVendorInvitees({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+      search: request.search,
+    }),
+    queryFn: async function eventsListOrSearchVendorInviteesQueryFn(
+      ctx,
+    ): Promise<EventsListOrSearchVendorInviteesQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(eventsListOrSearchVendorInvitees(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildEventsListOrSearchVendorInviteesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchVendorInviteesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      EventsListOrSearchVendorInviteesPageParams
+    >,
+  ) => Promise<EventsListOrSearchVendorInviteesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyEventsListOrSearchVendorInvitees({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+      search: request.search,
+    }),
+    queryFn: async function eventsListOrSearchVendorInviteesQuery(
+      ctx,
+    ): Promise<EventsListOrSearchVendorInviteesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(eventsListOrSearchVendorInvitees(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(eventsListOrSearchVendorInvitees(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyEventsListOrSearchVendorInvitees(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    expand?: Array<components.Expand> | undefined;
+    search?: string | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "events",
+    "listOrSearchVendorInvitees",
+    parameters,
+  ];
+}

package/src/react-query/index.ts

@@ -9,6 +9,7 @@ export * from "./companiesListOrSearchCompanies.js";
 export * from "./dataRequestsAddDataRequestFile.js";
 export * from "./dataRequestsDeleteDataRequestFile.js";
 export * from "./dataRequestsUpdateDataRequest.js";
+export * from "./eventsListOrSearchVendorInvitees.js";
 export * from "./invoicesCreateInvoice.js";
 export * from "./invoicesMakePayment.js";
 export * from "./invoicesUpdateInvoice.js";

package/src/sdk/events.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { eventsListOrSearchVendorInvitees } from "../funcs/eventsListOrSearchVendorInvitees.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Events extends ClientSDK {
+  /**
+   * List or search vendor invitees
+   *
+   * @remarks
+   * List or search vendor invitees.
+   *
+   * Available `expand` scopes are:
+   *
+   * - contact.facility
+   * - contact.system
+   * - contact.department
+   * - contact.user
+   */
+  async listOrSearchVendorInvitees(
+    request: operations.ListOrSearchVendorInviteesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListOrSearchVendorInviteesResponse,
+      { page: number }
+    >
+  > {
+    return unwrapResultIterator(eventsListOrSearchVendorInvitees(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -5,6 +5,7 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { Companies } from "./companies.js";
 import { DataRequests } from "./datarequests.js";
+import { Events } from "./events.js";
 import { Invoices } from "./invoices.js";
 import { Organizations } from "./organizations.js";
 import { SupportArticles } from "./supportarticles.js";
@@ -66,6 +67,11 @@ export class GreenSecurity extends ClientSDK {
     return (this._invoices ??= new Invoices(this._options));
   }
 
+  private _events?: Events;
+  get events(): Events {
+    return (this._events ??= new Events(this._options));
+  }
+
   private _systems?: Systems;
   get systems(): Systems {
     return (this._systems ??= new Systems(this._options));