@greensecurity/javascript-sdk 0.43.1-beta.124 → 0.43.1-beta.126

package/src/models/operations/listlocations.ts

@@ -42,7 +42,7 @@ export type ListLocationsRequest = {
   eventId?: number | undefined;
 };
 
-export type Items = {
+export type ListLocationsItems = {
   id?: string | undefined;
   label?: string | undefined;
 };
@@ -51,7 +51,7 @@ export type Items = {
  * The request was successful, and the server has returned the requested resource in the response body.
  */
 export type ListLocationsListLocationsOk = {
-  items: Array<Items>;
+  items: Array<ListLocationsItems>;
   /**
    * Pagination information for a pageable list
    */
@@ -104,19 +104,22 @@ export function listLocationsRequestToJSON(
 }
 
 /** @internal */
-export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
-  .object({
-    id: types.optional(types.string()),
-    label: types.optional(types.string()),
-  });
+export const ListLocationsItems$inboundSchema: z.ZodType<
+  ListLocationsItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.string()),
+  label: types.optional(types.string()),
+});
 
-export function itemsFromJSON(
+export function listLocationsItemsFromJSON(
   jsonString: string,
-): SafeParseResult<Items, SDKValidationError> {
+): SafeParseResult<ListLocationsItems, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Items$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Items' from JSON`,
+    (x) => ListLocationsItems$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListLocationsItems' from JSON`,
   );
 }
 
@@ -126,7 +129,7 @@ export const ListLocationsListLocationsOk$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  items: z.array(z.lazy(() => Items$inboundSchema)),
+  items: z.array(z.lazy(() => ListLocationsItems$inboundSchema)),
   pager: components.Pager$inboundSchema,
 });
 

package/src/models/operations/listlookupsystems.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d2e563b6fe83
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Expand = {
+  SystemFacilities: "system.facilities",
+  SystemLocation: "system.location",
+} as const;
+export type Expand = ClosedEnum<typeof Expand>;
+
+/**
+ * Filter systems to those with facilities of the given use type.
+ */
+export const Use = {
+  Credentialing: "credentialing",
+  VisitorManagement: "visitor_management",
+} as const;
+/**
+ * Filter systems to those with facilities of the given use type.
+ */
+export type Use = ClosedEnum<typeof Use>;
+
+export type ListLookupSystemsRequest = {
+  /**
+   * Expand values to include in the response. Allowed: `system.facilities`, `system.location`
+   */
+  expand?: Array<Expand> | undefined;
+  /**
+   * Filter systems to those with facilities of the given use type.
+   */
+  use?: Use | undefined;
+};
+
+/**
+ * The request was successful.
+ */
+export type ListLookupSystemsResponseBody = {
+  systems: Array<components.SystemSummary>;
+};
+
+/** @internal */
+export const Expand$outboundSchema: z.ZodNativeEnum<typeof Expand> = z
+  .nativeEnum(Expand);
+
+/** @internal */
+export const Use$outboundSchema: z.ZodNativeEnum<typeof Use> = z.nativeEnum(
+  Use,
+);
+
+/** @internal */
+export type ListLookupSystemsRequest$Outbound = {
+  expand?: Array<string> | undefined;
+  use?: string | undefined;
+};
+
+/** @internal */
+export const ListLookupSystemsRequest$outboundSchema: z.ZodType<
+  ListLookupSystemsRequest$Outbound,
+  z.ZodTypeDef,
+  ListLookupSystemsRequest
+> = z.object({
+  expand: z.array(Expand$outboundSchema).optional(),
+  use: Use$outboundSchema.optional(),
+});
+
+export function listLookupSystemsRequestToJSON(
+  listLookupSystemsRequest: ListLookupSystemsRequest,
+): string {
+  return JSON.stringify(
+    ListLookupSystemsRequest$outboundSchema.parse(listLookupSystemsRequest),
+  );
+}
+
+/** @internal */
+export const ListLookupSystemsResponseBody$inboundSchema: z.ZodType<
+  ListLookupSystemsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  systems: z.array(components.SystemSummary$inboundSchema),
+});
+
+export function listLookupSystemsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListLookupSystemsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListLookupSystemsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListLookupSystemsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/listvendoradditionalfacilityfields.ts

@@ -7,10 +7,27 @@ 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 ListVendorAdditionalFacilityFieldsRequest = {
+  /**
+   * 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;
   /**
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
@@ -23,16 +40,46 @@ export type ListVendorAdditionalFacilityFieldsRequest = {
   vendorIdOrMe: string;
 };
 
+/**
+ * Legacy VendorFieldValue row (deprecated shape).
+ */
+export type Items = {
+  /**
+   * VendorFieldValue id
+   */
+  id?: number | undefined;
+  system?: string | null | undefined;
+  facility?: string | null | undefined;
+  /**
+   * Display name of the underlying VendorField
+   */
+  field?: string | null | undefined;
+  value?: string | null | undefined;
+};
+
 /**
  * The request was successful.
  */
 export type ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk =
   {
-    items: Array<components.VendorCustomFields>;
+    items: Array<Items>;
+    /**
+     * Pagination information for a pageable list
+     */
+    pager: components.Pager;
   };
 
+export type ListVendorAdditionalFacilityFieldsResponse = {
+  result:
+    ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk;
+};
+
 /** @internal */
 export type ListVendorAdditionalFacilityFieldsRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
   vendor_id_or_me: string;
 };
 
@@ -43,9 +90,14 @@ export const ListVendorAdditionalFacilityFieldsRequest$outboundSchema:
     z.ZodTypeDef,
     ListVendorAdditionalFacilityFieldsRequest
   > = z.object({
+    sort: z.nullable(z.string()).optional(),
+    desc: components.Desc$outboundSchema.optional(),
+    page: z.number().int().optional(),
+    itemsPerPage: z.number().int().optional(),
     vendorIdOrMe: z.string(),
   }).transform((v) => {
     return remap$(v, {
+      itemsPerPage: "items_per_page",
       vendorIdOrMe: "vendor_id_or_me",
     });
   });
@@ -61,6 +113,26 @@ export function listVendorAdditionalFacilityFieldsRequestToJSON(
   );
 }
 
+/** @internal */
+export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.optional(types.number()),
+    system: z.nullable(types.string()).optional(),
+    facility: z.nullable(types.string()).optional(),
+    field: z.nullable(types.string()).optional(),
+    value: z.nullable(types.string()).optional(),
+  });
+
+export function itemsFromJSON(
+  jsonString: string,
+): SafeParseResult<Items, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Items$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Items' from JSON`,
+  );
+}
+
 /** @internal */
 export const ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk$inboundSchema:
   z.ZodType<
@@ -68,7 +140,8 @@ export const ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityField
     z.ZodTypeDef,
     unknown
   > = z.object({
-    items: z.array(components.VendorCustomFields$inboundSchema),
+    items: z.array(z.lazy(() => Items$inboundSchema)),
+    pager: components.Pager$inboundSchema,
   });
 
 export function listVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOkFromJSON(
@@ -85,3 +158,32 @@ export function listVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFi
     `Failed to parse 'ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk' from JSON`,
   );
 }
+
+/** @internal */
+export const ListVendorAdditionalFacilityFieldsResponse$inboundSchema:
+  z.ZodType<ListVendorAdditionalFacilityFieldsResponse, z.ZodTypeDef, unknown> =
+    z.object({
+      Result: z.lazy(() =>
+        ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk$inboundSchema
+      ),
+    }).transform((v) => {
+      return remap$(v, {
+        "Result": "result",
+      });
+    });
+
+export function listVendorAdditionalFacilityFieldsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListVendorAdditionalFacilityFieldsResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListVendorAdditionalFacilityFieldsResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListVendorAdditionalFacilityFieldsResponse' from JSON`,
+  );
+}

package/src/models/operations/securityzonecheckin.ts

@@ -50,10 +50,12 @@ export type SecurityZoneCheckinRequestBody2 = {
   expand?: Array<RequestBodyExpand> | undefined;
 };
 
-export const Expand = {
+export const SecurityZoneCheckinRequestBodyExpand = {
   VendorScanBadgeData: "vendor_scan.badge_data",
 } as const;
-export type Expand = ClosedEnum<typeof Expand>;
+export type SecurityZoneCheckinRequestBodyExpand = ClosedEnum<
+  typeof SecurityZoneCheckinRequestBodyExpand
+>;
 
 export type One = {
   /**
@@ -84,7 +86,7 @@ export type One = {
   scanType?: components.ScanType | undefined;
   recheckVendorScanId?: number | undefined;
   temperature?: number | undefined;
-  expand?: Array<Expand> | undefined;
+  expand?: Array<SecurityZoneCheckinRequestBodyExpand> | undefined;
 };
 
 export type SecurityZoneCheckinRequestBody =
@@ -231,8 +233,10 @@ export function securityZoneCheckinRequestBody2ToJSON(
 }
 
 /** @internal */
-export const Expand$outboundSchema: z.ZodNativeEnum<typeof Expand> = z
-  .nativeEnum(Expand);
+export const SecurityZoneCheckinRequestBodyExpand$outboundSchema:
+  z.ZodNativeEnum<typeof SecurityZoneCheckinRequestBodyExpand> = z.nativeEnum(
+    SecurityZoneCheckinRequestBodyExpand,
+  );
 
 /** @internal */
 export type One$Outbound = {
@@ -280,7 +284,8 @@ export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
     scanType: components.ScanType$outboundSchema.optional(),
     recheckVendorScanId: z.number().int().optional(),
     temperature: z.number().optional(),
-    expand: z.array(Expand$outboundSchema).optional(),
+    expand: z.array(SecurityZoneCheckinRequestBodyExpand$outboundSchema)
+      .optional(),
   }).transform((v) => {
     return remap$(v, {
       qrCode: "qr_code",

package/src/models/operations/updateuserprofilepicture.ts

@@ -49,13 +49,17 @@ export type UpdateUserProfilePictureRequest = {
 };
 
 /**
- * Metadata registered. Upload the file directly to S3 at user_profile_image/{id}.{ext}.
+ * Metadata registered. Upload the file to the returned presigned S3 URL using HTTP PUT with the same Content-Type as image_content_type.
  */
 export type UpdateUserProfilePictureUpdateUserProfilePictureOk = {
   /**
-   * User ID to use as the S3 upload key
+   * User ID associated with the profile picture
    */
   id: number;
+  /**
+   * Presigned S3 URL for uploading the image file via HTTP PUT. The URL is short-lived and tied to the image_content_type submitted in the request.
+   */
+  uploadUrl: string;
 };
 
 /** @internal */
@@ -136,6 +140,11 @@ export const UpdateUserProfilePictureUpdateUserProfilePictureOk$inboundSchema:
     unknown
   > = z.object({
     id: types.number(),
+    upload_url: types.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "upload_url": "uploadUrl",
+    });
   });
 
 export function updateUserProfilePictureUpdateUserProfilePictureOkFromJSON(

package/src/react-query/index.ts

@@ -40,11 +40,13 @@ export * from "./invoicesInvoicesExport.js";
 export * from "./invoicesListInvoices.js";
 export * from "./invoicesMakePayment.js";
 export * from "./invoicesUpdateInvoice.js";
+export * from "./lookupsListLookupSystems.js";
 export * from "./mobileDevicesAddMobileDevice.js";
 export * from "./organizationsGetFacility.js";
 export * from "./organizationsListOrSearchDepartmentContacts.js";
 export * from "./organizationsListOrSearchDepartments.js";
 export * from "./organizationsListOrSearchFacilities.js";
+export * from "./paymentProfileDeletePaymentProfile.js";
 export * from "./paymentProfileGetPaymentProfile.js";
 export * from "./supportArticlesGetSupportArticle.js";
 export * from "./supportArticlesListOrSearchSupportArticles.js";
@@ -77,6 +79,7 @@ export * from "./vendorsChangeSubscription.js";
 export * from "./vendorsCheckDownloadCode.js";
 export * from "./vendorsCreateNewVendorCredentialVersion.js";
 export * from "./vendorsCreateOrUpdateBcr.js";
+export * from "./vendorsCreateVendorByCompanyManager.js";
 export * from "./vendorsCreateVendorCompany.js";
 export * from "./vendorsCreateVendorRegistration.js";
 export * from "./vendorsDeclineVendorCredential.js";

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

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dcc4b9055b7d
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { lookupsListLookupSystems } from "../funcs/lookupsListLookupSystems.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";
+export type LookupsListLookupSystemsQueryData =
+  operations.ListLookupSystemsResponseBody;
+
+export function prefetchLookupsListLookupSystems(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListLookupSystemsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildLookupsListLookupSystemsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildLookupsListLookupSystemsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListLookupSystemsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<LookupsListLookupSystemsQueryData>;
+} {
+  return {
+    queryKey: queryKeyLookupsListLookupSystems({
+      expand: request.expand,
+      use: request.use,
+    }),
+    queryFn: async function lookupsListLookupSystemsQueryFn(
+      ctx,
+    ): Promise<LookupsListLookupSystemsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(lookupsListLookupSystems(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyLookupsListLookupSystems(
+  parameters: {
+    expand?: Array<operations.Expand> | undefined;
+    use?: operations.Use | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "lookups",
+    "listLookupSystems",
+    parameters,
+  ];
+}

package/src/react-query/lookupsListLookupSystems.ts

@@ -0,0 +1,168 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a3c073cb1932
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildLookupsListLookupSystemsQuery,
+  LookupsListLookupSystemsQueryData,
+  prefetchLookupsListLookupSystems,
+  queryKeyLookupsListLookupSystems,
+} from "./lookupsListLookupSystems.core.js";
+export {
+  buildLookupsListLookupSystemsQuery,
+  type LookupsListLookupSystemsQueryData,
+  prefetchLookupsListLookupSystems,
+  queryKeyLookupsListLookupSystems,
+};
+
+export type LookupsListLookupSystemsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List systems for dropdown/picker use
+ *
+ * @remarks
+ * Returns all credentialing-eligible systems (and optionally their facilities) for the authenticated user.
+ * Designed for lightweight dropdown and picker UIs.
+ *
+ * - **Company manager**: returns systems scoped to their site.
+ * - **Vendor**: returns systems available to that vendor.
+ * - **API user**: returns systems scoped to their MarketplaceAppActivation (facility, system, or site level).
+ *
+ * Use `expand=system.facilities` to include the facilities array on each system.
+ */
+export function useLookupsListLookupSystems(
+  request: operations.ListLookupSystemsRequest,
+  options?: QueryHookOptions<
+    LookupsListLookupSystemsQueryData,
+    LookupsListLookupSystemsQueryError
+  >,
+): UseQueryResult<
+  LookupsListLookupSystemsQueryData,
+  LookupsListLookupSystemsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildLookupsListLookupSystemsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List systems for dropdown/picker use
+ *
+ * @remarks
+ * Returns all credentialing-eligible systems (and optionally their facilities) for the authenticated user.
+ * Designed for lightweight dropdown and picker UIs.
+ *
+ * - **Company manager**: returns systems scoped to their site.
+ * - **Vendor**: returns systems available to that vendor.
+ * - **API user**: returns systems scoped to their MarketplaceAppActivation (facility, system, or site level).
+ *
+ * Use `expand=system.facilities` to include the facilities array on each system.
+ */
+export function useLookupsListLookupSystemsSuspense(
+  request: operations.ListLookupSystemsRequest,
+  options?: SuspenseQueryHookOptions<
+    LookupsListLookupSystemsQueryData,
+    LookupsListLookupSystemsQueryError
+  >,
+): UseSuspenseQueryResult<
+  LookupsListLookupSystemsQueryData,
+  LookupsListLookupSystemsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildLookupsListLookupSystemsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setLookupsListLookupSystemsData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      expand?: Array<operations.Expand> | undefined;
+      use?: operations.Use | undefined;
+    },
+  ],
+  data: LookupsListLookupSystemsQueryData,
+): LookupsListLookupSystemsQueryData | undefined {
+  const key = queryKeyLookupsListLookupSystems(...queryKeyBase);
+
+  return client.setQueryData<LookupsListLookupSystemsQueryData>(key, data);
+}
+
+export function invalidateLookupsListLookupSystems(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      expand?: Array<operations.Expand> | undefined;
+      use?: operations.Use | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "lookups",
+      "listLookupSystems",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllLookupsListLookupSystems(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "lookups", "listLookupSystems"],
+  });
+}