@greensecurity/javascript-sdk 0.43.1-beta.104 → 0.43.1-beta.108

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

@@ -12,17 +12,20 @@ import { usersGetCurrentUser } from "../funcs/usersGetCurrentUser.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 UsersGetCurrentUserQueryData = components.User;
 
 export function prefetchUsersGetCurrentUser(
   queryClient: QueryClient,
   client$: GreenSecurityCore,
+  request: operations.GetCurrentUserRequest,
   options?: RequestOptions,
 ): Promise<void> {
   return queryClient.prefetchQuery({
     ...buildUsersGetCurrentUserQuery(
       client$,
+      request,
       options,
     ),
   });
@@ -30,6 +33,7 @@ export function prefetchUsersGetCurrentUser(
 
 export function buildUsersGetCurrentUserQuery(
   client$: GreenSecurityCore,
+  request: operations.GetCurrentUserRequest,
   options?: RequestOptions,
 ): {
   queryKey: QueryKey;
@@ -38,7 +42,7 @@ export function buildUsersGetCurrentUserQuery(
   ) => Promise<UsersGetCurrentUserQueryData>;
 } {
   return {
-    queryKey: queryKeyUsersGetCurrentUser(),
+    queryKey: queryKeyUsersGetCurrentUser({ expand: request.expand }),
     queryFn: async function usersGetCurrentUserQueryFn(
       ctx,
     ): Promise<UsersGetCurrentUserQueryData> {
@@ -55,12 +59,20 @@ export function buildUsersGetCurrentUserQuery(
 
       return unwrapAsync(usersGetCurrentUser(
         client$,
+        request,
         mergedOptions,
       ));
     },
   };
 }
 
-export function queryKeyUsersGetCurrentUser(): QueryKey {
-  return ["@greensecurity/javascript-sdk", "users", "getCurrentUser"];
+export function queryKeyUsersGetCurrentUser(
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "users",
+    "getCurrentUser",
+    parameters,
+  ];
 }

package/src/react-query/usersGetCurrentUser.ts

@@ -10,6 +10,7 @@ import {
   useSuspenseQuery,
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
 import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
 import {
   ConnectionError,
@@ -21,8 +22,13 @@ import {
 import * as errors from "../models/errors/index.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
 import { useGreenSecurityContext } from "./_context.js";
-import { QueryHookOptions, SuspenseQueryHookOptions } from "./_types.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
 import {
   buildUsersGetCurrentUserQuery,
   prefetchUsersGetCurrentUser,
@@ -51,9 +57,11 @@ export type UsersGetCurrentUserQueryError =
  * Get current user
  *
  * @remarks
- * Returns a user object for the user represented by the authorization token
+ * Returns a user object for the user represented by the authorization token.
+ * For Company Manager users, the `company` object supports expand. Available values: company.vendor_fields, company.location, company.vendor_type_restrictions.
  */
 export function useUsersGetCurrentUser(
+  request: operations.GetCurrentUserRequest,
   options?: QueryHookOptions<
     UsersGetCurrentUserQueryData,
     UsersGetCurrentUserQueryError
@@ -63,6 +71,7 @@ export function useUsersGetCurrentUser(
   return useQuery({
     ...buildUsersGetCurrentUserQuery(
       client,
+      request,
       options,
     ),
     ...options,
@@ -73,9 +82,11 @@ export function useUsersGetCurrentUser(
  * Get current user
  *
  * @remarks
- * Returns a user object for the user represented by the authorization token
+ * Returns a user object for the user represented by the authorization token.
+ * For Company Manager users, the `company` object supports expand. Available values: company.vendor_fields, company.location, company.vendor_type_restrictions.
  */
 export function useUsersGetCurrentUserSuspense(
+  request: operations.GetCurrentUserRequest,
   options?: SuspenseQueryHookOptions<
     UsersGetCurrentUserQueryData,
     UsersGetCurrentUserQueryError
@@ -88,6 +99,7 @@ export function useUsersGetCurrentUserSuspense(
   return useSuspenseQuery({
     ...buildUsersGetCurrentUserQuery(
       client,
+      request,
       options,
     ),
     ...options,
@@ -96,13 +108,32 @@ export function useUsersGetCurrentUserSuspense(
 
 export function setUsersGetCurrentUserData(
   client: QueryClient,
+  queryKeyBase: [parameters: { expand?: Array<components.Expand> | undefined }],
   data: UsersGetCurrentUserQueryData,
 ): UsersGetCurrentUserQueryData | undefined {
-  const key = queryKeyUsersGetCurrentUser();
+  const key = queryKeyUsersGetCurrentUser(...queryKeyBase);
 
   return client.setQueryData<UsersGetCurrentUserQueryData>(key, data);
 }
 
+export function invalidateUsersGetCurrentUser(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "users",
+      "getCurrentUser",
+      ...queryKeyBase,
+    ],
+  });
+}
+
 export function invalidateAllUsersGetCurrentUser(
   client: QueryClient,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

package/src/react-query/vendorFieldsCreateVendorField.ts

@@ -0,0 +1,120 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorFieldsCreateVendorField } from "../funcs/vendorFieldsCreateVendorField.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.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 VendorFieldsCreateVendorFieldMutationVariables = {
+  request: operations.CreateVendorFieldRequestBody;
+  options?: RequestOptions;
+};
+
+export type VendorFieldsCreateVendorFieldMutationData =
+  operations.CreateVendorFieldResponseBody;
+
+export type VendorFieldsCreateVendorFieldMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create vendor field
+ *
+ * @remarks
+ * Create a new vendor field for a company. The name can only be set on creation;
+ * once created, only the show_to_vendor flag can be updated via PATCH.
+ * Requires access to the company (company manager, admin, or API user with company scope).
+ *
+ * For API users: source_user_id is required. The API user acts on behalf of that user
+ * (e.g. a company manager). The app must be activated for that user via MarketplaceAppActivation.
+ */
+export function useVendorFieldsCreateVendorFieldMutation(
+  options?: MutationHookOptions<
+    VendorFieldsCreateVendorFieldMutationData,
+    VendorFieldsCreateVendorFieldMutationError,
+    VendorFieldsCreateVendorFieldMutationVariables
+  >,
+): UseMutationResult<
+  VendorFieldsCreateVendorFieldMutationData,
+  VendorFieldsCreateVendorFieldMutationError,
+  VendorFieldsCreateVendorFieldMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorFieldsCreateVendorFieldMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorFieldsCreateVendorField(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor-fields",
+    "createVendorField",
+  ];
+}
+
+export function buildVendorFieldsCreateVendorFieldMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorFieldsCreateVendorFieldMutationVariables,
+  ) => Promise<VendorFieldsCreateVendorFieldMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorFieldsCreateVendorField(),
+    mutationFn: function vendorFieldsCreateVendorFieldMutationFn({
+      request,
+      options,
+    }): Promise<VendorFieldsCreateVendorFieldMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorFieldsCreateVendorField(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorFieldsUpdateVendorField.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorFieldsUpdateVendorField } from "../funcs/vendorFieldsUpdateVendorField.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.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 VendorFieldsUpdateVendorFieldMutationVariables = {
+  request: operations.UpdateVendorFieldRequest;
+  options?: RequestOptions;
+};
+
+export type VendorFieldsUpdateVendorFieldMutationData =
+  operations.UpdateVendorFieldResponseBody;
+
+export type VendorFieldsUpdateVendorFieldMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Update vendor field
+ *
+ * @remarks
+ * Update a vendor field. Only the show_to_vendor flag can be changed;
+ * the name cannot be modified after creation.
+ *
+ * For API users: source_user_id is required. The API user acts on behalf of that user.
+ */
+export function useVendorFieldsUpdateVendorFieldMutation(
+  options?: MutationHookOptions<
+    VendorFieldsUpdateVendorFieldMutationData,
+    VendorFieldsUpdateVendorFieldMutationError,
+    VendorFieldsUpdateVendorFieldMutationVariables
+  >,
+): UseMutationResult<
+  VendorFieldsUpdateVendorFieldMutationData,
+  VendorFieldsUpdateVendorFieldMutationError,
+  VendorFieldsUpdateVendorFieldMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorFieldsUpdateVendorFieldMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorFieldsUpdateVendorField(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor-fields",
+    "updateVendorField",
+  ];
+}
+
+export function buildVendorFieldsUpdateVendorFieldMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorFieldsUpdateVendorFieldMutationVariables,
+  ) => Promise<VendorFieldsUpdateVendorFieldMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorFieldsUpdateVendorField(),
+    mutationFn: function vendorFieldsUpdateVendorFieldMutationFn({
+      request,
+      options,
+    }): Promise<VendorFieldsUpdateVendorFieldMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorFieldsUpdateVendorField(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/sdk.ts

@@ -15,12 +15,18 @@ import { PaymentProfile } from "./paymentprofile.js";
 import { SupportArticles } from "./supportarticles.js";
 import { Systems } from "./systems.js";
 import { Users } from "./users.js";
+import { VendorFields } from "./vendorfields.js";
 import { Vendors } from "./vendors.js";
 import { VendorScans } from "./vendorscans.js";
 import { Webhooks } from "./webhooks.js";
 import { Zones } from "./zones.js";
 
 export class GreenSecurity extends ClientSDK {
+  private _vendorFields?: VendorFields;
+  get vendorFields(): VendorFields {
+    return (this._vendorFields ??= new VendorFields(this._options));
+  }
+
   private _vendors?: Vendors;
   get vendors(): Vendors {
     return (this._vendors ??= new Vendors(this._options));

package/src/sdk/users.ts

@@ -22,13 +22,16 @@ export class Users extends ClientSDK {
    * Get current user
    *
    * @remarks
-   * Returns a user object for the user represented by the authorization token
+   * Returns a user object for the user represented by the authorization token.
+   * For Company Manager users, the `company` object supports expand. Available values: company.vendor_fields, company.location, company.vendor_type_restrictions.
    */
   async getCurrentUser(
+    request: operations.GetCurrentUserRequest,
     options?: RequestOptions,
   ): Promise<components.User> {
     return unwrapAsync(usersGetCurrentUser(
       this,
+      request,
       options,
     ));
   }

package/src/sdk/vendorfields.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorFieldsCreateVendorField } from "../funcs/vendorFieldsCreateVendorField.js";
+import { vendorFieldsUpdateVendorField } from "../funcs/vendorFieldsUpdateVendorField.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class VendorFields extends ClientSDK {
+  /**
+   * Create vendor field
+   *
+   * @remarks
+   * Create a new vendor field for a company. The name can only be set on creation;
+   * once created, only the show_to_vendor flag can be updated via PATCH.
+   * Requires access to the company (company manager, admin, or API user with company scope).
+   *
+   * For API users: source_user_id is required. The API user acts on behalf of that user
+   * (e.g. a company manager). The app must be activated for that user via MarketplaceAppActivation.
+   */
+  async createVendorField(
+    request: operations.CreateVendorFieldRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateVendorFieldResponseBody> {
+    return unwrapAsync(vendorFieldsCreateVendorField(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update vendor field
+   *
+   * @remarks
+   * Update a vendor field. Only the show_to_vendor flag can be changed;
+   * the name cannot be modified after creation.
+   *
+   * For API users: source_user_id is required. The API user acts on behalf of that user.
+   */
+  async updateVendorField(
+    request: operations.UpdateVendorFieldRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateVendorFieldResponseBody> {
+    return unwrapAsync(vendorFieldsUpdateVendorField(
+      this,
+      request,
+      options,
+    ));
+  }
+}