@greensecurity/javascript-sdk 0.31.17 → 0.35.1

package/src/react-query/vendorsCreateOrUpdateBcr.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsCreateOrUpdateBcr } from "../funcs/vendorsCreateOrUpdateBcr.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type VendorsCreateOrUpdateBcrMutationVariables = {
+  request: operations.CreateOrUpdateBcrRequest;
+  options?: RequestOptions;
+};
+
+export type VendorsCreateOrUpdateBcrMutationData = boolean;
+
+/**
+ * Create or update BackgroundCheckResults
+ *
+ * @remarks
+ * It will create or update BackgroundCheckResults
+ */
+export function useVendorsCreateOrUpdateBcrMutation(
+  options?: MutationHookOptions<
+    VendorsCreateOrUpdateBcrMutationData,
+    Error,
+    VendorsCreateOrUpdateBcrMutationVariables
+  >,
+): UseMutationResult<
+  VendorsCreateOrUpdateBcrMutationData,
+  Error,
+  VendorsCreateOrUpdateBcrMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsCreateOrUpdateBcrMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsCreateOrUpdateBcr(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "vendors", "createOrUpdateBcr"];
+}
+
+export function buildVendorsCreateOrUpdateBcrMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsCreateOrUpdateBcrMutationVariables,
+  ) => Promise<VendorsCreateOrUpdateBcrMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsCreateOrUpdateBcr(),
+    mutationFn: function vendorsCreateOrUpdateBcrMutationFn({
+      request,
+      options,
+    }): Promise<VendorsCreateOrUpdateBcrMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsCreateOrUpdateBcr(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsGetVendorLegalName.ts

@@ -0,0 +1,165 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsGetVendorLegalName } from "../funcs/vendorsGetVendorLegalName.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type VendorsGetVendorLegalNameQueryData =
+  operations.GetVendorLegalNameResponseBody;
+
+/**
+ * Get Vendor legal name
+ *
+ * @remarks
+ * Get vendor legal name
+ */
+export function useVendorsGetVendorLegalName(
+  request: operations.GetVendorLegalNameRequest,
+  options?: QueryHookOptions<VendorsGetVendorLegalNameQueryData>,
+): UseQueryResult<VendorsGetVendorLegalNameQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetVendorLegalNameQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get Vendor legal name
+ *
+ * @remarks
+ * Get vendor legal name
+ */
+export function useVendorsGetVendorLegalNameSuspense(
+  request: operations.GetVendorLegalNameRequest,
+  options?: SuspenseQueryHookOptions<VendorsGetVendorLegalNameQueryData>,
+): UseSuspenseQueryResult<VendorsGetVendorLegalNameQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetVendorLegalNameQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchVendorsGetVendorLegalName(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorLegalNameRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorLegalNameQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsGetVendorLegalNameData(
+  client: QueryClient,
+  queryKeyBase: [vendorIdOrMe: string],
+  data: VendorsGetVendorLegalNameQueryData,
+): VendorsGetVendorLegalNameQueryData | undefined {
+  const key = queryKeyVendorsGetVendorLegalName(...queryKeyBase);
+
+  return client.setQueryData<VendorsGetVendorLegalNameQueryData>(key, data);
+}
+
+export function invalidateVendorsGetVendorLegalName(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[vendorIdOrMe: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorLegalName",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetVendorLegalName(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorLegalName",
+    ],
+  });
+}
+
+export function buildVendorsGetVendorLegalNameQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorLegalNameRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorLegalNameQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorLegalName(request.vendorIdOrMe),
+    queryFn: async function vendorsGetVendorLegalNameQueryFn(
+      ctx,
+    ): Promise<VendorsGetVendorLegalNameQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsGetVendorLegalName(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorLegalName(
+  vendorIdOrMe: string,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorLegalName",
+    vendorIdOrMe,
+  ];
+}

package/src/react-query/vendorsListVendorCredentialDataRequests.ts

@@ -0,0 +1,222 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsListVendorCredentialDataRequests } from "../funcs/vendorsListVendorCredentialDataRequests.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 { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type VendorsListVendorCredentialDataRequestsQueryData = Array<
+  components.VendorCredentialDataRequest | null
+>;
+
+/**
+ * List vendor credential data requests
+ *
+ * @remarks
+ * Retrieve an vendor credential data requests.
+ *
+ * Available `expand` scopes are:
+ *
+ * - vendor_credential_data_request.vendor_credential
+ * - vendor_credential_data_request.data_request
+ */
+export function useVendorsListVendorCredentialDataRequests(
+  request: operations.ListVendorCredentialDataRequestsRequest,
+  options?: QueryHookOptions<VendorsListVendorCredentialDataRequestsQueryData>,
+): UseQueryResult<VendorsListVendorCredentialDataRequestsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsListVendorCredentialDataRequestsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor credential data requests
+ *
+ * @remarks
+ * Retrieve an vendor credential data requests.
+ *
+ * Available `expand` scopes are:
+ *
+ * - vendor_credential_data_request.vendor_credential
+ * - vendor_credential_data_request.data_request
+ */
+export function useVendorsListVendorCredentialDataRequestsSuspense(
+  request: operations.ListVendorCredentialDataRequestsRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsListVendorCredentialDataRequestsQueryData
+  >,
+): UseSuspenseQueryResult<
+  VendorsListVendorCredentialDataRequestsQueryData,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsListVendorCredentialDataRequestsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchVendorsListVendorCredentialDataRequests(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCredentialDataRequestsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsListVendorCredentialDataRequestsQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsListVendorCredentialDataRequestsData(
+  client: QueryClient,
+  queryKeyBase: [
+    vendorCredentialId: number,
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+    },
+  ],
+  data: VendorsListVendorCredentialDataRequestsQueryData,
+): VendorsListVendorCredentialDataRequestsQueryData | undefined {
+  const key = queryKeyVendorsListVendorCredentialDataRequests(...queryKeyBase);
+
+  return client.setQueryData<VendorsListVendorCredentialDataRequestsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorsListVendorCredentialDataRequests(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      vendorCredentialId: number,
+      parameters: {
+        sort?: string | null | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+        expand?: Array<components.Expand> | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorCredentialDataRequests",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsListVendorCredentialDataRequests(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorCredentialDataRequests",
+    ],
+  });
+}
+
+export function buildVendorsListVendorCredentialDataRequestsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCredentialDataRequestsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsListVendorCredentialDataRequestsQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorCredentialDataRequests(
+      request.vendorCredentialId,
+      {
+        sort: request.sort,
+        desc: request.desc,
+        page: request.page,
+        itemsPerPage: request.itemsPerPage,
+        expand: request.expand,
+      },
+    ),
+    queryFn: async function vendorsListVendorCredentialDataRequestsQueryFn(
+      ctx,
+    ): Promise<VendorsListVendorCredentialDataRequestsQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsListVendorCredentialDataRequests(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsListVendorCredentialDataRequests(
+  vendorCredentialId: number,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendorCredentialDataRequests",
+    vendorCredentialId,
+    parameters,
+  ];
+}

package/src/sdk/datarequests.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { dataRequestsAddDataRequestFile } from "../funcs/dataRequestsAddDataRequestFile.js";
+import { dataRequestsDeleteDataRequestFile } from "../funcs/dataRequestsDeleteDataRequestFile.js";
+import { dataRequestsUpdateDataRequest } from "../funcs/dataRequestsUpdateDataRequest.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DataRequests extends ClientSDK {
+  /**
+   * Add vendor credential data request
+   *
+   * @remarks
+   * It will set the vendor credential data request file attributes
+   */
+  async addDataRequestFile(
+    request: operations.AddDataRequestFileRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(dataRequestsAddDataRequestFile(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete vendor credential data request file
+   *
+   * @remarks
+   * It will delete the vendor credential data request file
+   */
+  async deleteDataRequestFile(
+    request: operations.DeleteDataRequestFileRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(dataRequestsDeleteDataRequestFile(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update vendor credential data request
+   *
+   * @remarks
+   * It will update the vendor credential data request attributes
+   */
+  async updateDataRequest(
+    request: operations.UpdateDataRequestRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(dataRequestsUpdateDataRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -4,6 +4,7 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Companies } from "./companies.js";
+import { DataRequests } from "./datarequests.js";
 import { Organizations } from "./organizations.js";
 import { SupportArticles } from "./supportarticles.js";
 import { Users } from "./users.js";
@@ -52,4 +53,9 @@ export class GreenSecurity extends ClientSDK {
   get zones(): Zones {
     return (this._zones ??= new Zones(this._options));
   }
+
+  private _dataRequests?: DataRequests;
+  get dataRequests(): DataRequests {
+    return (this._dataRequests ??= new DataRequests(this._options));
+  }
 }

package/src/sdk/vendors.ts

@@ -4,6 +4,8 @@
 
 import { vendorsAddVendorCredentialFile } from "../funcs/vendorsAddVendorCredentialFile.js";
 import { vendorsAddVendorManagedByCompany } from "../funcs/vendorsAddVendorManagedByCompany.js";
+import { vendorsCreateNewVendorCredentialVersion } from "../funcs/vendorsCreateNewVendorCredentialVersion.js";
+import { vendorsCreateOrUpdateBcr } from "../funcs/vendorsCreateOrUpdateBcr.js";
 import { vendorsCreateVendorCompany } from "../funcs/vendorsCreateVendorCompany.js";
 import { vendorsCreateVendorRegistration } from "../funcs/vendorsCreateVendorRegistration.js";
 import { vendorsDeclineVendorCredential } from "../funcs/vendorsDeclineVendorCredential.js";
@@ -13,8 +15,10 @@ import { vendorsExpediteTimeRemaining } from "../funcs/vendorsExpediteTimeRemain
 import { vendorsGetVendorCredentialDetails } from "../funcs/vendorsGetVendorCredentialDetails.js";
 import { vendorsGetVendorCredentialFile } from "../funcs/vendorsGetVendorCredentialFile.js";
 import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoiceDetails.js";
+import { vendorsGetVendorLegalName } from "../funcs/vendorsGetVendorLegalName.js";
 import { vendorsGetVendorsDetails } from "../funcs/vendorsGetVendorsDetails.js";
 import { vendorsListVendorAdditionalFacilityFields } from "../funcs/vendorsListVendorAdditionalFacilityFields.js";
+import { vendorsListVendorCredentialDataRequests } from "../funcs/vendorsListVendorCredentialDataRequests.js";
 import { vendorsListVendorCredentialFiles } from "../funcs/vendorsListVendorCredentialFiles.js";
 import { vendorsListVendorCredentialHistory } from "../funcs/vendorsListVendorCredentialHistory.js";
 import { vendorsListVendorCredentials } from "../funcs/vendorsListVendorCredentials.js";
@@ -184,6 +188,23 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * Get Vendor legal name
+   *
+   * @remarks
+   * Get vendor legal name
+   */
+  async getVendorLegalName(
+    request: operations.GetVendorLegalNameRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetVendorLegalNameResponseBody> {
+    return unwrapAsync(vendorsGetVendorLegalName(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Decline vendor credential
    *
@@ -257,6 +278,40 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * Create or update BackgroundCheckResults
+   *
+   * @remarks
+   * It will create or update BackgroundCheckResults
+   */
+  async createOrUpdateBcr(
+    request: operations.CreateOrUpdateBcrRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(vendorsCreateOrUpdateBcr(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create new vendor credential version
+   *
+   * @remarks
+   * It will submit vendor credential
+   */
+  async createNewVendorCredentialVersion(
+    request: operations.CreateNewVendorCredentialVersionRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateNewVendorCredentialVersionResponseBody> {
+    return unwrapAsync(vendorsCreateNewVendorCredentialVersion(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List Vendor Credential History
    *
@@ -279,6 +334,28 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * List vendor credential data requests
+   *
+   * @remarks
+   * Retrieve an vendor credential data requests.
+   *
+   * Available `expand` scopes are:
+   *
+   * - vendor_credential_data_request.vendor_credential
+   * - vendor_credential_data_request.data_request
+   */
+  async listVendorCredentialDataRequests(
+    request: operations.ListVendorCredentialDataRequestsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<components.VendorCredentialDataRequest | null>> {
+    return unwrapAsync(vendorsListVendorCredentialDataRequests(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Expedite time remaining
    *