@greensecurity/javascript-sdk 0.43.1-beta.9 → 0.43.1-beta.92

package/src/models/operations/submitscreeningresponse.ts

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SubmitScreeningResponseRequestBody = {
+  /**
+   * ID of the screening question being answered.
+   */
+  screeningQuestionId: number;
+  /**
+   * ID of the selected screening answer for single-select questions.
+   */
+  screeningAnswerId?: number | null | undefined;
+  /**
+   * IDs of the selected screening answers for multi-select questions.
+   *
+   * @remarks
+   */
+  multipleScreeningAnswerIds?: Array<number> | null | undefined;
+  /**
+   * Optional vendor ID. Used when the authenticated user is a company manager submitting a response on behalf of a vendor
+   *
+   * @remarks
+   */
+  vendorId?: number | null | undefined;
+  /**
+   * Custom free-text answer for questions that accept typed input.
+   */
+  customAnswer?: string | null | undefined;
+};
+
+export type SubmitScreeningResponseRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  requestBody: SubmitScreeningResponseRequestBody;
+};
+
+/**
+ * Response returned after a screening question answer is submitted.
+ *
+ * @remarks
+ */
+export type SubmitScreeningResponseResponseBody = {
+  success?: boolean | undefined;
+  /**
+   * Indicates whether there is another unanswered screening question available, assuming triggered actions do not stop the flow.
+   *
+   * @remarks
+   */
+  hasNextQuestion?: boolean | undefined;
+  /**
+   * List of actions triggered by this screening response. Present only when there is no next question (i.e., `has_next_question` is false).
+   *
+   * @remarks
+   */
+  triggeredActions?:
+    | Array<components.ScreeningAnswerActionSummary>
+    | null
+    | undefined;
+};
+
+/** @internal */
+export type SubmitScreeningResponseRequestBody$Outbound = {
+  screening_question_id: number;
+  screening_answer_id?: number | null | undefined;
+  multiple_screening_answer_ids?: Array<number> | null | undefined;
+  vendor_id?: number | null | undefined;
+  custom_answer?: string | null | undefined;
+};
+
+/** @internal */
+export const SubmitScreeningResponseRequestBody$outboundSchema: z.ZodType<
+  SubmitScreeningResponseRequestBody$Outbound,
+  z.ZodTypeDef,
+  SubmitScreeningResponseRequestBody
+> = z.object({
+  screeningQuestionId: z.number().int(),
+  screeningAnswerId: z.nullable(z.number().int()).optional(),
+  multipleScreeningAnswerIds: z.nullable(z.array(z.number().int())).optional(),
+  vendorId: z.nullable(z.number().int()).optional(),
+  customAnswer: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    screeningQuestionId: "screening_question_id",
+    screeningAnswerId: "screening_answer_id",
+    multipleScreeningAnswerIds: "multiple_screening_answer_ids",
+    vendorId: "vendor_id",
+    customAnswer: "custom_answer",
+  });
+});
+
+export function submitScreeningResponseRequestBodyToJSON(
+  submitScreeningResponseRequestBody: SubmitScreeningResponseRequestBody,
+): string {
+  return JSON.stringify(
+    SubmitScreeningResponseRequestBody$outboundSchema.parse(
+      submitScreeningResponseRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type SubmitScreeningResponseRequest$Outbound = {
+  id: number;
+  RequestBody: SubmitScreeningResponseRequestBody$Outbound;
+};
+
+/** @internal */
+export const SubmitScreeningResponseRequest$outboundSchema: z.ZodType<
+  SubmitScreeningResponseRequest$Outbound,
+  z.ZodTypeDef,
+  SubmitScreeningResponseRequest
+> = z.object({
+  id: z.number().int(),
+  requestBody: z.lazy(() => SubmitScreeningResponseRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function submitScreeningResponseRequestToJSON(
+  submitScreeningResponseRequest: SubmitScreeningResponseRequest,
+): string {
+  return JSON.stringify(
+    SubmitScreeningResponseRequest$outboundSchema.parse(
+      submitScreeningResponseRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubmitScreeningResponseResponseBody$inboundSchema: z.ZodType<
+  SubmitScreeningResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: types.optional(types.boolean()),
+  has_next_question: types.optional(types.boolean()),
+  triggered_actions: z.nullable(
+    z.array(components.ScreeningAnswerActionSummary$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_next_question": "hasNextQuestion",
+    "triggered_actions": "triggeredActions",
+  });
+});
+
+export function submitScreeningResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SubmitScreeningResponseResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubmitScreeningResponseResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubmitScreeningResponseResponseBody' from JSON`,
+  );
+}

package/src/models/operations/updateuseralerts.ts

@@ -11,6 +11,12 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpdateUserAlertsRequestBody = {
   alertIds?: Array<number> | undefined;
+  /**
+   * The ID of the user to update alerts for. Only authorized API Users can specify a user other than themselves.
+   *
+   * @remarks
+   */
+  userId?: number | undefined;
 };
 
 /**
@@ -23,6 +29,7 @@ export type UpdateUserAlertsUpdateUserAlertsOk = {
 /** @internal */
 export type UpdateUserAlertsRequestBody$Outbound = {
   alert_ids?: Array<number> | undefined;
+  user_id?: number | undefined;
 };
 
 /** @internal */
@@ -32,9 +39,11 @@ export const UpdateUserAlertsRequestBody$outboundSchema: z.ZodType<
   UpdateUserAlertsRequestBody
 > = z.object({
   alertIds: z.array(z.number().int()).optional(),
+  userId: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
     alertIds: "alert_ids",
+    userId: "user_id",
   });
 });
 

package/src/react-query/alertsListAlerts.core.ts

@@ -77,6 +77,7 @@ export function buildAlertsListAlertsQuery(
       desc: request.desc,
       page: request.page,
       itemsPerPage: request.itemsPerPage,
+      userIdOrMe: request.userIdOrMe,
     }),
     queryFn: async function alertsListAlertsQueryFn(
       ctx,
@@ -117,6 +118,7 @@ export function buildAlertsListAlertsInfiniteQuery(
       desc: request.desc,
       page: request.page,
       itemsPerPage: request.itemsPerPage,
+      userIdOrMe: request.userIdOrMe,
     }),
     queryFn: async function alertsListAlertsQuery(
       ctx,
@@ -154,6 +156,7 @@ export function queryKeyAlertsListAlerts(
     desc?: components.Desc | undefined;
     page?: number | undefined;
     itemsPerPage?: number | undefined;
+    userIdOrMe?: string | undefined;
   },
 ): QueryKey {
   return ["@greensecurity/javascript-sdk", "alerts", "listAlerts", parameters];
@@ -165,6 +168,7 @@ export function queryKeyAlertsListAlertsInfinite(
     desc?: components.Desc | undefined;
     page?: number | undefined;
     itemsPerPage?: number | undefined;
+    userIdOrMe?: string | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/alertsListAlerts.ts

@@ -163,6 +163,7 @@ export function setAlertsListAlertsData(
       desc?: components.Desc | undefined;
       page?: number | undefined;
       itemsPerPage?: number | undefined;
+      userIdOrMe?: string | undefined;
     },
   ],
   data: AlertsListAlertsQueryData,
@@ -180,6 +181,7 @@ export function invalidateAlertsListAlerts(
       desc?: components.Desc | undefined;
       page?: number | undefined;
       itemsPerPage?: number | undefined;
+      userIdOrMe?: string | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

package/src/react-query/companiesGetCompany.core.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesGetCompany } from "../funcs/companiesGetCompany.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";
+export type CompaniesGetCompanyQueryData = components.Company;
+
+export function prefetchCompaniesGetCompany(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetCompanyRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesGetCompanyQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildCompaniesGetCompanyQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetCompanyRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesGetCompanyQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesGetCompany(request.id, {
+      expand: request.expand,
+    }),
+    queryFn: async function companiesGetCompanyQueryFn(
+      ctx,
+    ): Promise<CompaniesGetCompanyQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesGetCompany(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyCompaniesGetCompany(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "getCompany",
+    id,
+    parameters,
+  ];
+}

package/src/react-query/companiesGetCompany.ts

@@ -0,0 +1,125 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildCompaniesGetCompanyQuery,
+  CompaniesGetCompanyQueryData,
+  prefetchCompaniesGetCompany,
+  queryKeyCompaniesGetCompany,
+} from "./companiesGetCompany.core.js";
+export {
+  buildCompaniesGetCompanyQuery,
+  type CompaniesGetCompanyQueryData,
+  prefetchCompaniesGetCompany,
+  queryKeyCompaniesGetCompany,
+};
+
+/**
+ * Get company
+ *
+ * @remarks
+ * Get company details.
+ *
+ * Available `expand` scopes are:
+ *
+ * company.location
+ * company.vendor_type_restrictions
+ */
+export function useCompaniesGetCompany(
+  request: operations.GetCompanyRequest,
+  options?: QueryHookOptions<CompaniesGetCompanyQueryData>,
+): UseQueryResult<CompaniesGetCompanyQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildCompaniesGetCompanyQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get company
+ *
+ * @remarks
+ * Get company details.
+ *
+ * Available `expand` scopes are:
+ *
+ * company.location
+ * company.vendor_type_restrictions
+ */
+export function useCompaniesGetCompanySuspense(
+  request: operations.GetCompanyRequest,
+  options?: SuspenseQueryHookOptions<CompaniesGetCompanyQueryData>,
+): UseSuspenseQueryResult<CompaniesGetCompanyQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildCompaniesGetCompanyQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setCompaniesGetCompanyData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
+  data: CompaniesGetCompanyQueryData,
+): CompaniesGetCompanyQueryData | undefined {
+  const key = queryKeyCompaniesGetCompany(...queryKeyBase);
+
+  return client.setQueryData<CompaniesGetCompanyQueryData>(key, data);
+}
+
+export function invalidateCompaniesGetCompany(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "getCompany",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllCompaniesGetCompany(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "companies", "getCompany"],
+  });
+}

package/src/react-query/companiesListCompanyManagers.core.ts

@@ -0,0 +1,195 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesListCompanyManagers } from "../funcs/companiesListCompanyManagers.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 { pageIteratorToJSON } from "./_types.js";
+export type CompaniesListCompanyManagersQueryData =
+  operations.ListCompanyManagersResponse;
+
+export type CompaniesListCompanyManagersInfiniteQueryData = PageIterator<
+  operations.ListCompanyManagersResponse,
+  { page: number }
+>;
+
+export type CompaniesListCompanyManagersPageParams = PageIterator<
+  operations.ListCompanyManagersResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchCompaniesListCompanyManagers(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagersRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesListCompanyManagersQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchCompaniesListCompanyManagersInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagersRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildCompaniesListCompanyManagersInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as CompaniesListCompanyManagersPageParams,
+    getNextPageParam: (
+      previousPage: CompaniesListCompanyManagersInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildCompaniesListCompanyManagersQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagersRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesListCompanyManagersQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyManagers(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function companiesListCompanyManagersQueryFn(
+      ctx,
+    ): Promise<CompaniesListCompanyManagersQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesListCompanyManagers(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildCompaniesListCompanyManagersInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagersRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      CompaniesListCompanyManagersPageParams
+    >,
+  ) => Promise<CompaniesListCompanyManagersInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyManagersInfinite(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function companiesListCompanyManagersQuery(
+      ctx,
+    ): Promise<CompaniesListCompanyManagersInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          companiesListCompanyManagers(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        companiesListCompanyManagers(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyCompaniesListCompanyManagers(
+  id: number,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyManagers",
+    id,
+    parameters,
+  ];
+}
+
+export function queryKeyCompaniesListCompanyManagersInfinite(
+  id: number,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyManagers",
+    "infinite",
+    id,
+    parameters,
+  ];
+}