@greensecurity/javascript-sdk 0.43.1-beta.84 → 0.43.1-beta.88

package/src/funcs/usersGetLinkedUsers.ts

@@ -0,0 +1,177 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get linked users
+ *
+ * @remarks
+ * Returns a list of users linked to the authenticated user.
+ *
+ * For regular users, returns their own linked users.
+ *
+ * For API users, the `user_id` parameter is required. The API user must
+ * have an active app activation for the requested user.
+ */
+export function usersGetLinkedUsers(
+  client: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetLinkedUsersGetLinkedUsersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetLinkedUsersGetLinkedUsersOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetLinkedUsersRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/users/linked-users")();
+
+  const query = encodeFormQuery({
+    "user_id": payload.user_id,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getLinkedUsers",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "422", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetLinkedUsersGetLinkedUsersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetLinkedUsersGetLinkedUsersOk$inboundSchema),
+    M.jsonErr([400, 401, 403, 422], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/vendorsGetVendorsDetails.ts

@@ -55,6 +55,7 @@ import { Result } from "../types/fp.js";
  * vendor.vendor_groups
  * vendor.has_credentialed_facilities
  * vendor.has_emerald_status
+ * vendor.client_app_config
  */
 export function vendorsGetVendorsDetails(
   client: GreenSecurityCore,

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.11",
-  sdkVersion: "0.43.1-beta.82",
+  sdkVersion: "0.43.1-beta.86",
   genVersion: "2.794.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.43.1-beta.82 2.794.1 0.0.11 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.43.1-beta.86 2.794.1 0.0.11 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/expand.ts

@@ -43,6 +43,7 @@ export const Expand = {
   VendorRegistrationData: "vendor.registration_data",
   VendorRegistrationFinished: "vendor.registration_finished",
   VendorRequiredBadgeType: "vendor.required_badge_type",
+  VendorClientAppConfig: "vendor.client_app_config",
   VendorTargetFacilities: "vendor.target_facilities",
   VendorUser: "vendor.user",
   VendorVendorGroups: "vendor.vendor_groups",

package/src/models/components/subscription.ts

@@ -27,7 +27,7 @@ export type Subscription = {
   dateEnds?: string | null | undefined;
   status?: string | null | undefined;
   locked?: boolean | null | undefined;
-  variantTitle?: string | null | undefined;
+  variantTitle?: string | undefined;
   /**
    * Reduced list of attributes of the Invoice line item record
    */
@@ -52,7 +52,7 @@ export const Subscription$inboundSchema: z.ZodType<
   date_ends: z.nullable(types.string()).optional(),
   status: z.nullable(types.string()).optional(),
   locked: z.nullable(types.boolean()).optional(),
-  variant_title: z.nullable(types.string()).optional(),
+  variant_title: types.optional(types.string()),
   current_line_item: z.nullable(InvoiceItem$inboundSchema).optional(),
   next_line_item: z.nullable(InvoiceItem$inboundSchema).optional(),
   current_financial_status: z.nullable(FinancialStatus$inboundSchema)

package/src/models/components/vendor.ts

@@ -60,6 +60,10 @@ export type One = {
 
 export type VendorUser = One | number;
 
+export type ClientAppConfig = {
+  showNewAppVersionDetails?: boolean | null | undefined;
+};
+
 export type VendorJob = VendorJobTitle | number;
 
 export type VendorVendorType = VendorType | number;
@@ -132,6 +136,7 @@ export type Vendor = {
   user?: One | number | undefined;
   registrationData?: { [k: string]: any } | null | undefined;
   registrationFinished?: boolean | null | undefined;
+  clientAppConfig?: ClientAppConfig | null | undefined;
   vendorJob?: VendorJobTitle | number | null | undefined;
   vendorType?: VendorType | number | null | undefined;
   /**
@@ -264,6 +269,29 @@ export function vendorUserFromJSON(
   );
 }
 
+/** @internal */
+export const ClientAppConfig$inboundSchema: z.ZodType<
+  ClientAppConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  show_new_app_version_details: z.nullable(types.boolean()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "show_new_app_version_details": "showNewAppVersionDetails",
+  });
+});
+
+export function clientAppConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<ClientAppConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ClientAppConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ClientAppConfig' from JSON`,
+  );
+}
+
 /** @internal */
 export const VendorJob$inboundSchema: z.ZodType<
   VendorJob,
@@ -530,6 +558,8 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     ),
     registration_data: z.nullable(z.record(z.any())).optional(),
     registration_finished: z.nullable(types.boolean()).optional(),
+    client_app_config: z.nullable(z.lazy(() => ClientAppConfig$inboundSchema))
+      .optional(),
     vendor_job: z.nullable(
       smartUnion([VendorJobTitle$inboundSchema, types.number()]),
     ).optional(),
@@ -589,6 +619,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
       "has_emerald_status": "hasEmeraldStatus",
       "registration_data": "registrationData",
       "registration_finished": "registrationFinished",
+      "client_app_config": "clientAppConfig",
       "vendor_job": "vendorJob",
       "vendor_type": "vendorType",
       "qr_code": "qrCode",

package/src/models/components/vendorcredentialsummary.ts

@@ -75,6 +75,7 @@ export type VendorCredentialSummary = {
   jsonData?: string | null | undefined;
   filename?: string | null | undefined;
   alternateId?: number | null | undefined;
+  appliesToCompany?: boolean | null | undefined;
   credential?: Credential | number | null | undefined;
   vendor?: Vendor | number | null | undefined;
   invoice?: Invoice | number | null | undefined;
@@ -257,6 +258,7 @@ export const VendorCredentialSummary$inboundSchema: z.ZodType<
   json_data: z.nullable(types.string()).optional(),
   filename: z.nullable(types.string()).optional(),
   alternate_id: z.nullable(types.number()).optional(),
+  applies_to_company: z.nullable(types.boolean()).optional(),
   credential: z.nullable(smartUnion([Credential$inboundSchema, types.number()]))
     .optional(),
   vendor: z.nullable(smartUnion([Vendor$inboundSchema, types.number()]))
@@ -301,6 +303,7 @@ export const VendorCredentialSummary$inboundSchema: z.ZodType<
     "date_valid": "dateValid",
     "json_data": "jsonData",
     "alternate_id": "alternateId",
+    "applies_to_company": "appliesToCompany",
     "vendor_credential_files": "vendorCredentialFiles",
     "latest_vendor_credential_id": "latestVendorCredentialId",
     "previously_approved": "previouslyApproved",

package/src/models/operations/getlinkedusers.ts

@@ -0,0 +1,110 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetLinkedUsersRequest = {
+  /**
+   * The ID of the user to fetch linked users for. Required for API users.
+   */
+  userId?: number | undefined;
+};
+
+export type LinkedUsers = {
+  id: number;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email: string;
+  userType: string;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type GetLinkedUsersGetLinkedUsersOk = {
+  linkedUsers: Array<LinkedUsers>;
+};
+
+/** @internal */
+export type GetLinkedUsersRequest$Outbound = {
+  user_id?: number | undefined;
+};
+
+/** @internal */
+export const GetLinkedUsersRequest$outboundSchema: z.ZodType<
+  GetLinkedUsersRequest$Outbound,
+  z.ZodTypeDef,
+  GetLinkedUsersRequest
+> = z.object({
+  userId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    userId: "user_id",
+  });
+});
+
+export function getLinkedUsersRequestToJSON(
+  getLinkedUsersRequest: GetLinkedUsersRequest,
+): string {
+  return JSON.stringify(
+    GetLinkedUsersRequest$outboundSchema.parse(getLinkedUsersRequest),
+  );
+}
+
+/** @internal */
+export const LinkedUsers$inboundSchema: z.ZodType<
+  LinkedUsers,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  first_name: z.nullable(types.string()).optional(),
+  last_name: z.nullable(types.string()).optional(),
+  email: types.string(),
+  user_type: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "first_name": "firstName",
+    "last_name": "lastName",
+    "user_type": "userType",
+  });
+});
+
+export function linkedUsersFromJSON(
+  jsonString: string,
+): SafeParseResult<LinkedUsers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LinkedUsers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LinkedUsers' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetLinkedUsersGetLinkedUsersOk$inboundSchema: z.ZodType<
+  GetLinkedUsersGetLinkedUsersOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  linked_users: z.array(z.lazy(() => LinkedUsers$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "linked_users": "linkedUsers",
+  });
+});
+
+export function getLinkedUsersGetLinkedUsersOkFromJSON(
+  jsonString: string,
+): SafeParseResult<GetLinkedUsersGetLinkedUsersOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetLinkedUsersGetLinkedUsersOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetLinkedUsersGetLinkedUsersOk' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -29,6 +29,7 @@ export * from "./expeditetimeremaining.js";
 export * from "./getcompany.js";
 export * from "./getfacility.js";
 export * from "./getfhirconfig.js";
+export * from "./getlinkedusers.js";
 export * from "./getnextscreeningquestion.js";
 export * from "./getnextunansweredscreeningquestion.js";
 export * from "./getsecurityzone.js";

package/src/models/operations/updatevendordetails.ts

@@ -21,6 +21,13 @@ export const EmailRecepient = {
  */
 export type EmailRecepient = ClosedEnum<typeof EmailRecepient>;
 
+export type ClientAppConfig = {
+  /**
+   * The vendor's show_new_app_version_details value to update
+   */
+  showNewAppVersionDetails?: boolean | undefined;
+};
+
 export type UpdateVendorDetailsRequestBody = {
   /**
    * The QR code value
@@ -30,6 +37,7 @@ export type UpdateVendorDetailsRequestBody = {
    * The vendor's email_recepient value to update
    */
   emailRecepient?: EmailRecepient | undefined;
+  clientAppConfig?: ClientAppConfig | undefined;
   /**
    * The vendor's send_weekly_summary_email value to update
    */
@@ -65,10 +73,35 @@ export const EmailRecepient$outboundSchema: z.ZodNativeEnum<
   typeof EmailRecepient
 > = z.nativeEnum(EmailRecepient);
 
+/** @internal */
+export type ClientAppConfig$Outbound = {
+  show_new_app_version_details?: boolean | undefined;
+};
+
+/** @internal */
+export const ClientAppConfig$outboundSchema: z.ZodType<
+  ClientAppConfig$Outbound,
+  z.ZodTypeDef,
+  ClientAppConfig
+> = z.object({
+  showNewAppVersionDetails: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    showNewAppVersionDetails: "show_new_app_version_details",
+  });
+});
+
+export function clientAppConfigToJSON(
+  clientAppConfig: ClientAppConfig,
+): string {
+  return JSON.stringify(ClientAppConfig$outboundSchema.parse(clientAppConfig));
+}
+
 /** @internal */
 export type UpdateVendorDetailsRequestBody$Outbound = {
   qr_code?: string | undefined;
   email_recepient?: string | undefined;
+  client_app_config?: ClientAppConfig$Outbound | undefined;
   send_weekly_summary_email?: boolean | undefined;
   title?: string | undefined;
   location?: components.UserLocation$Outbound | null | undefined;
@@ -84,6 +117,7 @@ export const UpdateVendorDetailsRequestBody$outboundSchema: z.ZodType<
 > = z.object({
   qrCode: z.string().optional(),
   emailRecepient: EmailRecepient$outboundSchema.optional(),
+  clientAppConfig: z.lazy(() => ClientAppConfig$outboundSchema).optional(),
   sendWeeklySummaryEmail: z.boolean().optional(),
   title: z.string().optional(),
   location: z.nullable(components.UserLocation$outboundSchema).optional(),
@@ -93,6 +127,7 @@ export const UpdateVendorDetailsRequestBody$outboundSchema: z.ZodType<
   return remap$(v, {
     qrCode: "qr_code",
     emailRecepient: "email_recepient",
+    clientAppConfig: "client_app_config",
     sendWeeklySummaryEmail: "send_weekly_summary_email",
     primaryDepartmentId: "primary_department_id",
   });

package/src/react-query/index.ts

@@ -42,6 +42,7 @@ export * from "./supportArticlesListOrSearchSupportArticles.js";
 export * from "./systemsListSystems.js";
 export * from "./usersChangePassword.js";
 export * from "./usersGetCurrentUser.js";
+export * from "./usersGetLinkedUsers.js";
 export * from "./usersGetUserById.js";
 export * from "./usersMagiclink.js";
 export * from "./usersPassword.js";

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

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { usersGetLinkedUsers } from "../funcs/usersGetLinkedUsers.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 UsersGetLinkedUsersQueryData =
+  operations.GetLinkedUsersGetLinkedUsersOk;
+
+export function prefetchUsersGetLinkedUsers(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildUsersGetLinkedUsersQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildUsersGetLinkedUsersQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<UsersGetLinkedUsersQueryData>;
+} {
+  return {
+    queryKey: queryKeyUsersGetLinkedUsers({ userId: request.userId }),
+    queryFn: async function usersGetLinkedUsersQueryFn(
+      ctx,
+    ): Promise<UsersGetLinkedUsersQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(usersGetLinkedUsers(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyUsersGetLinkedUsers(
+  parameters: { userId?: number | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "users",
+    "getLinkedUsers",
+    parameters,
+  ];
+}