@greensecurity/javascript-sdk 0.43.1-beta.115 → 0.43.1-beta.116

package/src/__tests__/users.test.ts

@@ -91,3 +91,109 @@ test("Users Switch Account", async () => {
     userToken: {},
   });
 });
+
+test("Users Update User", async () => {
+  const testHttpClient = createTestHTTPClient("updateUser");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.users.updateUser({
+    id: "<id>",
+    requestBody: {
+      timezone: "America/New_York",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    user: {
+      isGatekeeper: true,
+      success: true,
+      user: {
+        id: 123,
+        firstName: "John",
+        lastName: "Doe",
+        email: "john@example.com",
+        phone: "555-555-5555",
+        userType: "Facility User",
+        timezone: "America/Chicago",
+      },
+      userToken: {
+        token: "WDCINRKRKYQ3TUEUEUEHEGWN6WKXP7N12345C8CSHQVJD7D6I",
+        tokenType: "permanent",
+      },
+      vendor: {
+        badge: {
+          badgeType: "rfid",
+        },
+        vendorJob: {
+          id: 154462,
+          job: "Account Representatives/Managers|Account Executive",
+        },
+        primaryFacility: {
+          contacts: {
+            contact: {
+              status: "Deleted",
+              department: 123,
+            },
+            adminContact: {
+              status: "Inactive",
+              department: 123,
+            },
+            techContact: {
+              status: "Deleted",
+              department: 123,
+            },
+            greenSecurityCsm: {
+              status: "Inactive",
+              department: 123,
+            },
+            accountManager: {
+              status: "Inactive",
+              department: 123,
+            },
+          },
+          vendorGuestPolicy: {
+            enabled: true,
+            vendorGuestLimitAndOr: "and",
+            vendorGuestRequireEmail: true,
+          },
+        },
+      },
+      contact: {
+        status: "Deleted",
+        department: 123,
+      },
+    },
+  });
+});
+
+test("Users Update User Profile Picture", async () => {
+  const testHttpClient = createTestHTTPClient("updateUserProfilePicture");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.users.updateUserProfilePicture({
+    idOrMe: "<value>",
+    requestBody: {
+      imageFileName: "<value>",
+      imageContentType: "image/jpeg",
+      imageFileSize: 443381,
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    id: 541107,
+  });
+});

package/src/__tests__/webhooks.test.ts

@@ -20,7 +20,7 @@ test("Webhooks List All Webhook Endpoints", async () => {
   const testWebhookListForVendorUserResult = await greenSecurity.webhooks
     .listAllWebhookEndpoints({
       itemsPerPage: 25,
-      desc: 0,
+      desc: true,
       sort: "",
     });
   expect(testWebhookListForVendorUserResult).toBeDefined();

package/src/__tests__/zones.test.ts

@@ -39,52 +39,36 @@ test("Zones List Or Search Security Zones", async () => {
         facility: {
           contacts: {
             contact: {
-              status: "Inactive",
+              status: "Deleted",
               department: 123,
             },
-            adminContact: null,
-            techContact: {
-              status: "Inactive",
+            adminContact: {
+              status: "Active",
               department: 123,
             },
-            greenSecurityCsm: {
+            techContact: {
               status: "Deleted",
               department: 123,
             },
-            accountManager: null,
-          },
-          vendorGuestPolicy: {
-            enabled: true,
-            vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: true,
-          },
-        },
-      },
-      {
-        facility: {
-          contacts: {
-            contact: {
-              status: "Inactive",
-              department: 123,
-            },
-            adminContact: null,
-            techContact: {
+            greenSecurityCsm: {
               status: "Inactive",
               department: 123,
             },
-            greenSecurityCsm: {
-              status: "Deleted",
+            accountManager: {
+              status: "Active",
               department: 123,
             },
-            accountManager: null,
           },
           vendorGuestPolicy: {
-            enabled: true,
+            enabled: false,
             vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: true,
+            vendorGuestRequireEmail: false,
           },
         },
       },
+      {
+        facility: {},
+      },
     ],
   });
 });
@@ -101,9 +85,8 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    longitude: 5514.78,
-    latitude: 3322.97,
-    zoneId: 97443,
+    qrCode: "<value>",
+    zoneId: 185875,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/funcs/usersUpdateUser.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeJSON, encodeSimple } 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";
+
+/**
+ * Update user by ID
+ *
+ * @remarks
+ * Updates the contact information, address, and locale settings of a user.
+ * Pass `me` as `{id}` to update the authenticated user's own profile.
+ *
+ * Only submitted fields are applied — unrecognised fields are silently ignored.
+ * Changing `email` automatically resets `bounced_email` to `false`.
+ *
+ * To rotate an API token use `POST /users/api_key_rotator` instead.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function usersUpdateUser(
+  client: GreenSecurityCore,
+  request: operations.UpdateUserRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UpdateUserUpdateUserOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.UpdateUserRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.UpdateUserUpdateUserOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.UpdateUserRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/users/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "updateUser",
+    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: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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", "404", "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.UpdateUserUpdateUserOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.UpdateUserUpdateUserOk$inboundSchema),
+    M.jsonErr([400, 401, 403, 404, 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/usersUpdateUserProfilePicture.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeJSON, encodeSimple } 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";
+
+/**
+ * Register profile picture metadata for S3 direct upload
+ *
+ * @remarks
+ * Register profile picture metadata for a user. The client should then upload the file directly to S3 at user_profile_image/{id}.{ext}. An AWS Lambda function processes the image (resize to tiny/thumb/large) and triggers a callback. Use 'me' as the id for the authenticated user. Requires authentication and either self-ownership or 'users:edit' permission. API users must be authorized via MarketplaceAppActivation.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function usersUpdateUserProfilePicture(
+  client: GreenSecurityCore,
+  request: operations.UpdateUserProfilePictureRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UpdateUserProfilePictureUpdateUserProfilePictureOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.UpdateUserProfilePictureRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.UpdateUserProfilePictureUpdateUserProfilePictureOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.UpdateUserProfilePictureRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    id_or_me: encodeSimple("id_or_me", payload.id_or_me, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/users/{id_or_me}/profile_picture")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "updateUserProfilePicture",
+    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: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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", "404", "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.UpdateUserProfilePictureUpdateUserProfilePictureOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations
+        .UpdateUserProfilePictureUpdateUserProfilePictureOk$inboundSchema,
+    ),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail([422, "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/vendorFieldsCreateVendorField.ts

@@ -29,8 +29,9 @@ import { Result } from "../types/fp.js";
  * 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.
+ * Create a new vendor field for a company. Each company may have at most one custom
+ * vendor field; if one already exists, the request fails with 422. 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

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

package/src/models/components/company.ts

@@ -8,6 +8,10 @@ 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";
+import {
+  CompanyVendorField,
+  CompanyVendorField$inboundSchema,
+} from "./companyvendorfield.js";
 import {
   CompanyVendorTypeRestriction,
   CompanyVendorTypeRestriction$inboundSchema,
@@ -56,6 +60,10 @@ export type Company = {
   contact?: CompanyContact | undefined;
   tax?: Tax | undefined;
   stats?: Stats | undefined;
+  /**
+   * Result of expanding `company.vendor_fields` on the company object.
+   */
+  vendorFields?: Array<CompanyVendorField> | null | undefined;
   vendorTypeRestrictions?:
     | Array<CompanyVendorTypeRestriction | null>
     | null
@@ -176,12 +184,15 @@ export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
     contact: types.optional(z.lazy(() => CompanyContact$inboundSchema)),
     tax: types.optional(z.lazy(() => Tax$inboundSchema)),
     stats: types.optional(z.lazy(() => Stats$inboundSchema)),
+    vendor_fields: z.nullable(z.array(CompanyVendorField$inboundSchema))
+      .optional(),
     vendor_type_restrictions: z.nullable(
       z.array(types.nullable(CompanyVendorTypeRestriction$inboundSchema)),
     ).optional(),
   }).transform((v) => {
     return remap$(v, {
       "credit_balance": "creditBalance",
+      "vendor_fields": "vendorFields",
       "vendor_type_restrictions": "vendorTypeRestrictions",
     });
   });

package/src/models/components/companyvendorfield.ts

@@ -0,0 +1,47 @@
+/*
+ * 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";
+
+/**
+ * A vendor field definition created by a company.
+ */
+export type CompanyVendorField = {
+  id: number;
+  name: string;
+  showToVendor: boolean;
+  fieldType: string;
+};
+
+/** @internal */
+export const CompanyVendorField$inboundSchema: z.ZodType<
+  CompanyVendorField,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  name: types.string(),
+  show_to_vendor: types.boolean(),
+  field_type: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "show_to_vendor": "showToVendor",
+    "field_type": "fieldType",
+  });
+});
+
+export function companyVendorFieldFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyVendorField, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyVendorField$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyVendorField' from JSON`,
+  );
+}

package/src/models/components/expand.ts

@@ -11,6 +11,8 @@ import { ClosedEnum } from "../../types/enums.js";
 export const Expand = {
   User: "user",
   CompanyLocation: "company.location",
+  CompanyVendorFields: "company.vendor_fields",
+  CompanyVendorTypeRestrictions: "company.vendor_type_restrictions",
   ContactFacility: "contact.facility",
   ContactSystem: "contact.system",
   ContactDepartment: "contact.department",

package/src/models/components/index.ts

@@ -7,6 +7,7 @@ export * from "./alert.js";
 export * from "./backgroundcheckresult.js";
 export * from "./company.js";
 export * from "./companymanager.js";
+export * from "./companyvendorfield.js";
 export * from "./companyvendortyperestriction.js";
 export * from "./contact.js";
 export * from "./contenttype.js";