@greensecurity/javascript-sdk 0.43.1-beta.54 → 0.43.1-beta.58

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/index.ts

@@ -7,6 +7,7 @@ export * from "./_types.js";
 
 export * from "./alertsListAlerts.js";
 export * from "./alertsUpdateUserAlerts.js";
+export * from "./companiesGetCompany.js";
 export * from "./companiesListOrSearchCompanies.js";
 export * from "./dataRequestsAddDataRequestFile.js";
 export * from "./dataRequestsDeleteDataRequestFile.js";
@@ -77,6 +78,7 @@ export * from "./vendorsListVendorCredentialFiles.js";
 export * from "./vendorsListVendorCredentialHistory.js";
 export * from "./vendorsListVendorCredentials.js";
 export * from "./vendorsListVendorCredits.js";
+export * from "./vendorsListVendorCustomFields.js";
 export * from "./vendorsListVendorFacilityStatuses.js";
 export * from "./vendorsListVendorInvoices.js";
 export * from "./vendorsListVendorJobTitles.js";

package/src/react-query/vendorsChangeSubscription.ts

@@ -28,7 +28,10 @@ export type VendorsChangeSubscriptionMutationData =
  * Change subscription
  *
  * @remarks
- * Calculate subscription price
+ * Change a vendor's credentialing subscription by updating the vendor type
+ * and/or target facilities. If the new selection increases the subscription
+ * price, an invoice is created and the payment profile is charged; the
+ * response includes the invoice id.
  */
 export function useVendorsChangeSubscriptionMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsListVendorAdditionalFacilityFields.ts

@@ -53,7 +53,9 @@ export {
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFields(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,
@@ -76,7 +78,9 @@ export function useVendorsListVendorAdditionalFacilityFields(
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsSuspense(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,
@@ -102,7 +106,9 @@ export function useVendorsListVendorAdditionalFacilityFieldsSuspense(
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsInfinite(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,
@@ -142,7 +148,9 @@ export function useVendorsListVendorAdditionalFacilityFieldsInfinite(
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsInfiniteSuspense(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,

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

@@ -0,0 +1,198 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsListVendorCustomFields } from "../funcs/vendorsListVendorCustomFields.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 VendorsListVendorCustomFieldsQueryData =
+  operations.ListVendorCustomFieldsResponse;
+
+export type VendorsListVendorCustomFieldsInfiniteQueryData = PageIterator<
+  operations.ListVendorCustomFieldsResponse,
+  { page: number }
+>;
+
+export type VendorsListVendorCustomFieldsPageParams = PageIterator<
+  operations.ListVendorCustomFieldsResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchVendorsListVendorCustomFields(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsListVendorCustomFieldsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchVendorsListVendorCustomFieldsInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildVendorsListVendorCustomFieldsInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as VendorsListVendorCustomFieldsPageParams,
+    getNextPageParam: (
+      previousPage: VendorsListVendorCustomFieldsInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildVendorsListVendorCustomFieldsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsListVendorCustomFieldsQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorCustomFields(request.vendorIdOrMe, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function vendorsListVendorCustomFieldsQueryFn(
+      ctx,
+    ): Promise<VendorsListVendorCustomFieldsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsListVendorCustomFields(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildVendorsListVendorCustomFieldsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      VendorsListVendorCustomFieldsPageParams
+    >,
+  ) => Promise<VendorsListVendorCustomFieldsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorCustomFieldsInfinite(
+      request.vendorIdOrMe,
+      {
+        sort: request.sort,
+        desc: request.desc,
+        page: request.page,
+        itemsPerPage: request.itemsPerPage,
+      },
+    ),
+    queryFn: async function vendorsListVendorCustomFieldsQuery(
+      ctx,
+    ): Promise<VendorsListVendorCustomFieldsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          vendorsListVendorCustomFields(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        vendorsListVendorCustomFields(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyVendorsListVendorCustomFields(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendorCustomFields",
+    vendorIdOrMe,
+    parameters,
+  ];
+}
+
+export function queryKeyVendorsListVendorCustomFieldsInfinite(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendorCustomFields",
+    "infinite",
+    vendorIdOrMe,
+    parameters,
+  ];
+}

package/src/react-query/vendorsListVendorCustomFields.ts

@@ -0,0 +1,230 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  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 {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorsListVendorCustomFieldsInfiniteQuery,
+  buildVendorsListVendorCustomFieldsQuery,
+  prefetchVendorsListVendorCustomFields,
+  prefetchVendorsListVendorCustomFieldsInfinite,
+  queryKeyVendorsListVendorCustomFields,
+  queryKeyVendorsListVendorCustomFieldsInfinite,
+  VendorsListVendorCustomFieldsInfiniteQueryData,
+  VendorsListVendorCustomFieldsPageParams,
+  VendorsListVendorCustomFieldsQueryData,
+} from "./vendorsListVendorCustomFields.core.js";
+export {
+  buildVendorsListVendorCustomFieldsInfiniteQuery,
+  buildVendorsListVendorCustomFieldsQuery,
+  prefetchVendorsListVendorCustomFields,
+  prefetchVendorsListVendorCustomFieldsInfinite,
+  queryKeyVendorsListVendorCustomFields,
+  queryKeyVendorsListVendorCustomFieldsInfinite,
+  type VendorsListVendorCustomFieldsInfiniteQueryData,
+  type VendorsListVendorCustomFieldsPageParams,
+  type VendorsListVendorCustomFieldsQueryData,
+};
+
+/**
+ * List of vendor custom fields
+ *
+ * @remarks
+ * List of vendor custom fields
+ */
+export function useVendorsListVendorCustomFields(
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: QueryHookOptions<VendorsListVendorCustomFieldsQueryData>,
+): UseQueryResult<VendorsListVendorCustomFieldsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsListVendorCustomFieldsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List of vendor custom fields
+ *
+ * @remarks
+ * List of vendor custom fields
+ */
+export function useVendorsListVendorCustomFieldsSuspense(
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: SuspenseQueryHookOptions<VendorsListVendorCustomFieldsQueryData>,
+): UseSuspenseQueryResult<VendorsListVendorCustomFieldsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsListVendorCustomFieldsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List of vendor custom fields
+ *
+ * @remarks
+ * List of vendor custom fields
+ */
+export function useVendorsListVendorCustomFieldsInfinite(
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: InfiniteQueryHookOptions<
+    VendorsListVendorCustomFieldsInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorCustomFieldsInfiniteQueryData,
+    VendorsListVendorCustomFieldsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    VendorsListVendorCustomFieldsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorCustomFieldsInfiniteQueryData,
+      VendorsListVendorCustomFieldsPageParams
+    >,
+    QueryKey,
+    VendorsListVendorCustomFieldsPageParams
+  >({
+    ...buildVendorsListVendorCustomFieldsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List of vendor custom fields
+ *
+ * @remarks
+ * List of vendor custom fields
+ */
+export function useVendorsListVendorCustomFieldsInfiniteSuspense(
+  request: operations.ListVendorCustomFieldsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    VendorsListVendorCustomFieldsInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorCustomFieldsInfiniteQueryData,
+    VendorsListVendorCustomFieldsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    VendorsListVendorCustomFieldsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorCustomFieldsInfiniteQueryData,
+      VendorsListVendorCustomFieldsPageParams
+    >,
+    QueryKey,
+    VendorsListVendorCustomFieldsPageParams
+  >({
+    ...buildVendorsListVendorCustomFieldsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setVendorsListVendorCustomFieldsData(
+  client: QueryClient,
+  queryKeyBase: [
+    vendorIdOrMe: string,
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    },
+  ],
+  data: VendorsListVendorCustomFieldsQueryData,
+): VendorsListVendorCustomFieldsQueryData | undefined {
+  const key = queryKeyVendorsListVendorCustomFields(...queryKeyBase);
+
+  return client.setQueryData<VendorsListVendorCustomFieldsQueryData>(key, data);
+}
+
+export function invalidateVendorsListVendorCustomFields(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      vendorIdOrMe: string,
+      parameters: {
+        sort?: string | null | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorCustomFields",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsListVendorCustomFields(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorCustomFields",
+    ],
+  });
+}

package/src/sdk/companies.ts

@@ -2,9 +2,12 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { companiesGetCompany } from "../funcs/companiesGetCompany.js";
 import { companiesListOrSearchCompanies } from "../funcs/companiesListOrSearchCompanies.js";
 import { ClientSDK, 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";
 
 export class Companies extends ClientSDK {
@@ -26,4 +29,26 @@ export class Companies extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get company
+   *
+   * @remarks
+   * Get company details.
+   *
+   * Available `expand` scopes are:
+   *
+   * company.location
+   * company.vendor_type_restrictions
+   */
+  async getCompany(
+    request: operations.GetCompanyRequest,
+    options?: RequestOptions,
+  ): Promise<components.Company> {
+    return unwrapAsync(companiesGetCompany(
+      this,
+      request,
+      options,
+    ));
+  }
 }