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

package/src/funcs/zonesGetSecurityZone.ts

@@ -37,6 +37,8 @@ import { Result } from "../types/fp.js";
  * - zone.facility
  * - zone.department
  * - zone.rules
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function zonesGetSecurityZone(
   client: GreenSecurityCore,
@@ -112,7 +114,7 @@ async function $do(
   }));
 
   const securityInput = await extractSecurity(client._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
 
   const context = {
     options: client._options,

package/src/funcs/zonesListOrSearchSecurityZones.ts

@@ -37,6 +37,8 @@ import {
  *
  * @remarks
  * List or search security zones
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function zonesListOrSearchSecurityZones(
   client: GreenSecurityCore,
@@ -122,7 +124,7 @@ async function $do(
   }));
 
   const securityInput = await extractSecurity(client._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
 
   const context = {
     options: client._options,

package/src/funcs/zonesSecurityZoneCheckin.ts

@@ -30,6 +30,8 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Security zone checkin request
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
 export function zonesSecurityZoneCheckin(
   client: GreenSecurityCore,
@@ -97,7 +99,7 @@ async function $do(
   }));
 
   const securityInput = await extractSecurity(client._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
 
   const context = {
     options: client._options,

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.106",
-  genVersion: "2.869.25",
+  sdkVersion: "0.43.1-beta.110",
+  genVersion: "2.879.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.43.1-beta.106 2.869.25 0.0.11 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.43.1-beta.110 2.879.1 0.0.11 @greensecurity/javascript-sdk",
 } as const;

package/src/lib/security.ts

@@ -240,8 +240,9 @@ function applyBearer(
 
 export function resolveGlobalSecurity(
   security: Partial<components.Security> | null | undefined,
+  allowedFields?: number[],
 ): SecurityState | null {
-  return resolveSecurity(
+  let inputs: SecurityInput[][] = [
     [
       {
         fieldName: "token",
@@ -256,7 +257,18 @@ export function resolveGlobalSecurity(
         value: security?.bearerJwt ?? env().GREEN_SECURITY_BEARER_JWT,
       },
     ],
-  );
+  ];
+
+  if (allowedFields) {
+    inputs = allowedFields.map((i) => {
+      if (i < 0 || i >= inputs.length) {
+        throw new RangeError(`invalid allowedFields index ${i}`);
+      }
+      return inputs[i]!;
+    });
+  }
+
+  return resolveSecurity(...inputs);
 }
 
 export async function extractSecurity<

package/src/models/components/alert.ts

@@ -23,6 +23,7 @@ export type Type = OpenEnum<typeof Type>;
  */
 export type Alert = {
   id?: number | undefined;
+  alertTargetId?: number | null | undefined;
   dateAdded?: string | null | undefined;
   dateStarts?: string | null | undefined;
   message?: string | null | undefined;
@@ -32,6 +33,7 @@ export type Alert = {
   plainText?: string | null | undefined;
   viewed?: boolean | null | undefined;
   dateViewed?: string | null | undefined;
+  closeButtonText?: string | null | undefined;
 };
 
 /** @internal */
@@ -42,6 +44,7 @@ export const Type$inboundSchema: z.ZodType<Type, z.ZodTypeDef, unknown> =
 export const Alert$inboundSchema: z.ZodType<Alert, z.ZodTypeDef, unknown> = z
   .object({
     id: types.optional(types.number()),
+    alert_target_id: z.nullable(types.number()).optional(),
     date_added: z.nullable(types.string()).optional(),
     date_starts: z.nullable(types.string()).optional(),
     message: z.nullable(types.string()).optional(),
@@ -51,12 +54,15 @@ export const Alert$inboundSchema: z.ZodType<Alert, z.ZodTypeDef, unknown> = z
     plain_text: z.nullable(types.string()).optional(),
     viewed: z.nullable(types.boolean()).optional(),
     date_viewed: z.nullable(types.string()).optional(),
+    close_button_text: z.nullable(types.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
+      "alert_target_id": "alertTargetId",
       "date_added": "dateAdded",
       "date_starts": "dateStarts",
       "plain_text": "plainText",
       "date_viewed": "dateViewed",
+      "close_button_text": "closeButtonText",
     });
   });
 

package/src/models/components/index.ts

@@ -42,6 +42,7 @@ export * from "./loginemailandpassword.js";
 export * from "./loginrequirementsfromemail.js";
 export * from "./mfarequiredresponse.js";
 export * from "./pager.js";
+export * from "./passwordnotsetresponse.js";
 export * from "./passwordrequiredresponse.js";
 export * from "./paymentprofile.js";
 export * from "./paymentprofileinfo.js";

package/src/models/components/passwordnotsetresponse.ts

@@ -0,0 +1,52 @@
+/*
+ * 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";
+
+/**
+ * The response is sent when the user exists but has no password set. Redirect the user to redirect_url to complete the forgot-password flow.
+ */
+export type PasswordNotSetResponse = {
+  requires: "password_reset";
+  success: boolean;
+  /**
+   * User exists but has no password set (e.g. newly invited company manager).
+   */
+  error: string;
+  /**
+   * URL to redirect the user to set their password (forgot password flow). Includes return_url query param when provided in the request.
+   */
+  redirectUrl: string;
+};
+
+/** @internal */
+export const PasswordNotSetResponse$inboundSchema: z.ZodType<
+  PasswordNotSetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requires: types.literal("password_reset"),
+  success: types.boolean(),
+  error: types.string(),
+  redirect_url: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "redirect_url": "redirectUrl",
+  });
+});
+
+export function passwordNotSetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PasswordNotSetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PasswordNotSetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PasswordNotSetResponse' from JSON`,
+  );
+}

package/src/models/operations/addcompanymanager.ts

@@ -0,0 +1,121 @@
+/*
+ * 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 AddCompanyManagerRequestBody = {
+  /**
+   * Email address for the new company manager
+   */
+  email: string;
+  /**
+   * First name
+   */
+  firstName: string;
+  /**
+   * Last name
+   */
+  lastName: string;
+};
+
+export type AddCompanyManagerRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  requestBody: AddCompanyManagerRequestBody;
+};
+
+/**
+ * The request was successful.
+ */
+export type AddCompanyManagerAddCompanyManagerOk = {
+  success: boolean;
+};
+
+/** @internal */
+export type AddCompanyManagerRequestBody$Outbound = {
+  email: string;
+  first_name: string;
+  last_name: string;
+};
+
+/** @internal */
+export const AddCompanyManagerRequestBody$outboundSchema: z.ZodType<
+  AddCompanyManagerRequestBody$Outbound,
+  z.ZodTypeDef,
+  AddCompanyManagerRequestBody
+> = z.object({
+  email: z.string(),
+  firstName: z.string(),
+  lastName: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    firstName: "first_name",
+    lastName: "last_name",
+  });
+});
+
+export function addCompanyManagerRequestBodyToJSON(
+  addCompanyManagerRequestBody: AddCompanyManagerRequestBody,
+): string {
+  return JSON.stringify(
+    AddCompanyManagerRequestBody$outboundSchema.parse(
+      addCompanyManagerRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type AddCompanyManagerRequest$Outbound = {
+  id: number;
+  RequestBody: AddCompanyManagerRequestBody$Outbound;
+};
+
+/** @internal */
+export const AddCompanyManagerRequest$outboundSchema: z.ZodType<
+  AddCompanyManagerRequest$Outbound,
+  z.ZodTypeDef,
+  AddCompanyManagerRequest
+> = z.object({
+  id: z.number().int(),
+  requestBody: z.lazy(() => AddCompanyManagerRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function addCompanyManagerRequestToJSON(
+  addCompanyManagerRequest: AddCompanyManagerRequest,
+): string {
+  return JSON.stringify(
+    AddCompanyManagerRequest$outboundSchema.parse(addCompanyManagerRequest),
+  );
+}
+
+/** @internal */
+export const AddCompanyManagerAddCompanyManagerOk$inboundSchema: z.ZodType<
+  AddCompanyManagerAddCompanyManagerOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: types.boolean(),
+});
+
+export function addCompanyManagerAddCompanyManagerOkFromJSON(
+  jsonString: string,
+): SafeParseResult<AddCompanyManagerAddCompanyManagerOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AddCompanyManagerAddCompanyManagerOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AddCompanyManagerAddCompanyManagerOk' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -4,6 +4,7 @@
 
 export * from "./acceptinvitation.js";
 export * from "./acceptvendorcredential.js";
+export * from "./addcompanymanager.js";
 export * from "./adddatarequestfile.js";
 export * from "./addmobiledevice.js";
 export * from "./addvendorcredentialfile.js";

package/src/models/operations/listalerts.ts

@@ -5,10 +5,23 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 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";
 
+/**
+ * Filter alerts by mobile or web client type.
+ */
+export const AlertType = {
+  All: "all",
+  Mobile: "mobile",
+} as const;
+/**
+ * Filter alerts by mobile or web client type.
+ */
+export type AlertType = ClosedEnum<typeof AlertType>;
+
 export type ListAlertsRequest = {
   /**
    * A comma-separated list of object attributes to sort on.
@@ -30,6 +43,10 @@ export type ListAlertsRequest = {
    * Either the ID of the user rep or the keyword "me" to represent the current user.
    */
   userIdOrMe?: string | undefined;
+  /**
+   * Filter alerts by mobile or web client type.
+   */
+  alertType?: AlertType | undefined;
 };
 
 /**
@@ -47,6 +64,10 @@ export type ListAlertsResponse = {
   result: ListAlertsListAlertsOk;
 };
 
+/** @internal */
+export const AlertType$outboundSchema: z.ZodNativeEnum<typeof AlertType> = z
+  .nativeEnum(AlertType);
+
 /** @internal */
 export type ListAlertsRequest$Outbound = {
   sort?: string | null | undefined;
@@ -54,6 +75,7 @@ export type ListAlertsRequest$Outbound = {
   page?: number | undefined;
   items_per_page?: number | undefined;
   user_id_or_me?: string | undefined;
+  alert_type?: string | undefined;
 };
 
 /** @internal */
@@ -67,10 +89,12 @@ export const ListAlertsRequest$outboundSchema: z.ZodType<
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),
   userIdOrMe: z.string().optional(),
+  alertType: AlertType$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
     userIdOrMe: "user_id_or_me",
+    alertType: "alert_type",
   });
 });
 

package/src/models/operations/postauthenticate.ts

@@ -22,13 +22,15 @@ export type PostAuthenticateRequestBody =
 export type PostAuthenticateResponseBody =
   | components.MfaRequiredResponse
   | components.SamlLoginRequiredResponse
-  | components.PasswordRequiredResponse;
+  | components.PasswordRequiredResponse
+  | components.PasswordNotSetResponse;
 
 export type PostAuthenticateResponse =
   | components.User
   | components.MfaRequiredResponse
   | components.SamlLoginRequiredResponse
-  | components.PasswordRequiredResponse;
+  | components.PasswordRequiredResponse
+  | components.PasswordNotSetResponse;
 
 /** @internal */
 export type PostAuthenticateRequestBody$Outbound =
@@ -64,6 +66,7 @@ export const PostAuthenticateResponseBody$inboundSchema: z.ZodType<
   components.MfaRequiredResponse$inboundSchema,
   components.SamlLoginRequiredResponse$inboundSchema,
   components.PasswordRequiredResponse$inboundSchema,
+  components.PasswordNotSetResponse$inboundSchema,
 ]);
 
 export function postAuthenticateResponseBodyFromJSON(
@@ -87,6 +90,7 @@ export const PostAuthenticateResponse$inboundSchema: z.ZodType<
     components.MfaRequiredResponse$inboundSchema,
     components.SamlLoginRequiredResponse$inboundSchema,
     components.PasswordRequiredResponse$inboundSchema,
+    components.PasswordNotSetResponse$inboundSchema,
   ]),
 ]);
 

package/src/models/operations/updateuseralerts.ts

@@ -11,6 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpdateUserAlertsRequestBody = {
   alertIds?: Array<number> | undefined;
+  alertTargetIds?: Array<number> | undefined;
   /**
    * The ID of the user to update alerts for. Only authorized API Users can specify a user other than themselves.
    *
@@ -29,6 +30,7 @@ export type UpdateUserAlertsUpdateUserAlertsOk = {
 /** @internal */
 export type UpdateUserAlertsRequestBody$Outbound = {
   alert_ids?: Array<number> | undefined;
+  alert_target_ids?: Array<number> | undefined;
   user_id?: number | undefined;
 };
 
@@ -39,10 +41,12 @@ export const UpdateUserAlertsRequestBody$outboundSchema: z.ZodType<
   UpdateUserAlertsRequestBody
 > = z.object({
   alertIds: z.array(z.number().int()).optional(),
+  alertTargetIds: z.array(z.number().int()).optional(),
   userId: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
     alertIds: "alert_ids",
+    alertTargetIds: "alert_target_ids",
     userId: "user_id",
   });
 });

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

@@ -78,6 +78,7 @@ export function buildAlertsListAlertsQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       userIdOrMe: request.userIdOrMe,
+      alertType: request.alertType,
     }),
     queryFn: async function alertsListAlertsQueryFn(
       ctx,
@@ -119,6 +120,7 @@ export function buildAlertsListAlertsInfiniteQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       userIdOrMe: request.userIdOrMe,
+      alertType: request.alertType,
     }),
     queryFn: async function alertsListAlertsQuery(
       ctx,
@@ -157,6 +159,7 @@ export function queryKeyAlertsListAlerts(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     userIdOrMe?: string | undefined;
+    alertType?: operations.AlertType | undefined;
   },
 ): QueryKey {
   return ["@greensecurity/javascript-sdk", "alerts", "listAlerts", parameters];
@@ -169,6 +172,7 @@ export function queryKeyAlertsListAlertsInfinite(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     userIdOrMe?: string | undefined;
+    alertType?: operations.AlertType | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/alertsListAlerts.ts

@@ -201,6 +201,7 @@ export function setAlertsListAlertsData(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       userIdOrMe?: string | undefined;
+      alertType?: operations.AlertType | undefined;
     },
   ],
   data: AlertsListAlertsQueryData,
@@ -219,6 +220,7 @@ export function invalidateAlertsListAlerts(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       userIdOrMe?: string | undefined;
+      alertType?: operations.AlertType | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

package/src/react-query/companiesAddCompanyManager.ts

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesAddCompanyManager } from "../funcs/companiesAddCompanyManager.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 CompaniesAddCompanyManagerMutationVariables = {
+  request: operations.AddCompanyManagerRequest;
+  options?: RequestOptions;
+};
+
+export type CompaniesAddCompanyManagerMutationData =
+  operations.AddCompanyManagerAddCompanyManagerOk;
+
+export type CompaniesAddCompanyManagerMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Add company manager
+ *
+ * @remarks
+ * Creates a new company manager for the specified company.
+ * A welcome email is sent to the new manager with login instructions.
+ * Requires `company_managers` add permission. Company managers can add to their
+ * own company; API users can add to companies in their marketplace app scope.
+ */
+export function useCompaniesAddCompanyManagerMutation(
+  options?: MutationHookOptions<
+    CompaniesAddCompanyManagerMutationData,
+    CompaniesAddCompanyManagerMutationError,
+    CompaniesAddCompanyManagerMutationVariables
+  >,
+): UseMutationResult<
+  CompaniesAddCompanyManagerMutationData,
+  CompaniesAddCompanyManagerMutationError,
+  CompaniesAddCompanyManagerMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildCompaniesAddCompanyManagerMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyCompaniesAddCompanyManager(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "companies", "addCompanyManager"];
+}
+
+export function buildCompaniesAddCompanyManagerMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: CompaniesAddCompanyManagerMutationVariables,
+  ) => Promise<CompaniesAddCompanyManagerMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyCompaniesAddCompanyManager(),
+    mutationFn: function companiesAddCompanyManagerMutationFn({
+      request,
+      options,
+    }): Promise<CompaniesAddCompanyManagerMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(companiesAddCompanyManager(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/index.ts

@@ -7,6 +7,7 @@ export * from "./_types.js";
 
 export * from "./alertsListAlerts.js";
 export * from "./alertsUpdateUserAlerts.js";
+export * from "./companiesAddCompanyManager.js";
 export * from "./companiesGetCompany.js";
 export * from "./companiesListCompanyManagers.js";
 export * from "./companiesListOrSearchCompanies.js";

package/src/sdk/companies.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { companiesAddCompanyManager } from "../funcs/companiesAddCompanyManager.js";
 import { companiesGetCompany } from "../funcs/companiesGetCompany.js";
 import { companiesListCompanyManagers } from "../funcs/companiesListCompanyManagers.js";
 import { companiesListOrSearchCompanies } from "../funcs/companiesListOrSearchCompanies.js";
@@ -53,6 +54,26 @@ export class Companies extends ClientSDK {
     ));
   }
 
+  /**
+   * Add company manager
+   *
+   * @remarks
+   * Creates a new company manager for the specified company.
+   * A welcome email is sent to the new manager with login instructions.
+   * Requires `company_managers` add permission. Company managers can add to their
+   * own company; API users can add to companies in their marketplace app scope.
+   */
+  async addCompanyManager(
+    request: operations.AddCompanyManagerRequest,
+    options?: RequestOptions,
+  ): Promise<operations.AddCompanyManagerAddCompanyManagerOk> {
+    return unwrapAsync(companiesAddCompanyManager(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List or search company managers
    *