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

package/src/models/components/vendor.ts

@@ -34,6 +34,7 @@ import { VendorType, VendorType$inboundSchema } from "./vendortype.js";
 
 export type Badge = {
   badgeType?: string | undefined;
+  badgeMacAddress?: string | null | undefined;
   requiredBadgeType?: string | null | undefined;
 };
 
@@ -193,10 +194,12 @@ export type Vendor = {
 export const Badge$inboundSchema: z.ZodType<Badge, z.ZodTypeDef, unknown> = z
   .object({
     badge_type: types.optional(types.string()),
+    badge_mac_address: z.nullable(types.string()).optional(),
     required_badge_type: z.nullable(types.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "badge_type": "badgeType",
+      "badge_mac_address": "badgeMacAddress",
       "required_badge_type": "requiredBadgeType",
     });
   });

package/src/models/operations/index.ts

@@ -100,7 +100,9 @@ export * from "./updateevent.js";
 export * from "./updatefhirconfigbyid.js";
 export * from "./updateinvoice.js";
 export * from "./updatesthewebhookendpointwiththegivenid.js";
+export * from "./updateuser.js";
 export * from "./updateuseralerts.js";
+export * from "./updateuserprofilepicture.js";
 export * from "./updatevendorcredentialdata.js";
 export * from "./updatevendorcredentialfile.js";
 export * from "./updatevendordetails.js";

package/src/models/operations/updateuser.ts

@@ -0,0 +1,156 @@
+/*
+ * 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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type UpdateUserRequestBody = {
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  username?: string | undefined;
+  email?: string | undefined;
+  email2?: string | undefined;
+  phone?: string | undefined;
+  mobilePhone?: string | undefined;
+  fax?: string | undefined;
+  address?: string | undefined;
+  address1?: string | undefined;
+  address2?: string | undefined;
+  city?: string | undefined;
+  state?: string | undefined;
+  zip?: string | undefined;
+  country?: string | undefined;
+  timezone?: string | undefined;
+  utcOffset?: number | undefined;
+};
+
+export type UpdateUserRequest = {
+  /**
+   * Numeric user ID or `me` for the authenticated user.
+   */
+  id: string;
+  requestBody: UpdateUserRequestBody;
+};
+
+/**
+ * User updated successfully.
+ */
+export type UpdateUserUpdateUserOk = {
+  /**
+   * The User object describes a person or service account.
+   */
+  user: components.User;
+};
+
+/** @internal */
+export type UpdateUserRequestBody$Outbound = {
+  first_name?: string | undefined;
+  last_name?: string | undefined;
+  username?: string | undefined;
+  email?: string | undefined;
+  email2?: string | undefined;
+  phone?: string | undefined;
+  mobile_phone?: string | undefined;
+  fax?: string | undefined;
+  address?: string | undefined;
+  address1?: string | undefined;
+  address2?: string | undefined;
+  city?: string | undefined;
+  state?: string | undefined;
+  zip?: string | undefined;
+  country?: string | undefined;
+  timezone?: string | undefined;
+  utc_offset?: number | undefined;
+};
+
+/** @internal */
+export const UpdateUserRequestBody$outboundSchema: z.ZodType<
+  UpdateUserRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateUserRequestBody
+> = z.object({
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  username: z.string().optional(),
+  email: z.string().optional(),
+  email2: z.string().optional(),
+  phone: z.string().optional(),
+  mobilePhone: z.string().optional(),
+  fax: z.string().optional(),
+  address: z.string().optional(),
+  address1: z.string().optional(),
+  address2: z.string().optional(),
+  city: z.string().optional(),
+  state: z.string().optional(),
+  zip: z.string().optional(),
+  country: z.string().optional(),
+  timezone: z.string().optional(),
+  utcOffset: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    firstName: "first_name",
+    lastName: "last_name",
+    mobilePhone: "mobile_phone",
+    utcOffset: "utc_offset",
+  });
+});
+
+export function updateUserRequestBodyToJSON(
+  updateUserRequestBody: UpdateUserRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateUserRequestBody$outboundSchema.parse(updateUserRequestBody),
+  );
+}
+
+/** @internal */
+export type UpdateUserRequest$Outbound = {
+  id: string;
+  RequestBody: UpdateUserRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateUserRequest$outboundSchema: z.ZodType<
+  UpdateUserRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateUserRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateUserRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateUserRequestToJSON(
+  updateUserRequest: UpdateUserRequest,
+): string {
+  return JSON.stringify(
+    UpdateUserRequest$outboundSchema.parse(updateUserRequest),
+  );
+}
+
+/** @internal */
+export const UpdateUserUpdateUserOk$inboundSchema: z.ZodType<
+  UpdateUserUpdateUserOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  user: components.User$inboundSchema,
+});
+
+export function updateUserUpdateUserOkFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateUserUpdateUserOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateUserUpdateUserOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateUserUpdateUserOk' from JSON`,
+  );
+}

package/src/models/operations/updateuserprofilepicture.ts

@@ -0,0 +1,154 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * MIME type of the image
+ */
+export const ImageContentType = {
+  ImageJpeg: "image/jpeg",
+  ImagePng: "image/png",
+  ImageGif: "image/gif",
+  ImageWebp: "image/webp",
+} as const;
+/**
+ * MIME type of the image
+ */
+export type ImageContentType = ClosedEnum<typeof ImageContentType>;
+
+export type UpdateUserProfilePictureRequestBody = {
+  /**
+   * Original file name of the image
+   */
+  imageFileName: string;
+  /**
+   * MIME type of the image
+   */
+  imageContentType: ImageContentType;
+  /**
+   * File size in bytes
+   */
+  imageFileSize: number;
+};
+
+export type UpdateUserProfilePictureRequest = {
+  /**
+   * Either the ID of the user rep or the keyword "me" to represent the current user.
+   */
+  idOrMe: string;
+  requestBody: UpdateUserProfilePictureRequestBody;
+};
+
+/**
+ * Metadata registered. Upload the file directly to S3 at user_profile_image/{id}.{ext}.
+ */
+export type UpdateUserProfilePictureUpdateUserProfilePictureOk = {
+  /**
+   * User ID to use as the S3 upload key
+   */
+  id: number;
+};
+
+/** @internal */
+export const ImageContentType$outboundSchema: z.ZodNativeEnum<
+  typeof ImageContentType
+> = z.nativeEnum(ImageContentType);
+
+/** @internal */
+export type UpdateUserProfilePictureRequestBody$Outbound = {
+  image_file_name: string;
+  image_content_type: string;
+  image_file_size: number;
+};
+
+/** @internal */
+export const UpdateUserProfilePictureRequestBody$outboundSchema: z.ZodType<
+  UpdateUserProfilePictureRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateUserProfilePictureRequestBody
+> = z.object({
+  imageFileName: z.string(),
+  imageContentType: ImageContentType$outboundSchema,
+  imageFileSize: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    imageFileName: "image_file_name",
+    imageContentType: "image_content_type",
+    imageFileSize: "image_file_size",
+  });
+});
+
+export function updateUserProfilePictureRequestBodyToJSON(
+  updateUserProfilePictureRequestBody: UpdateUserProfilePictureRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateUserProfilePictureRequestBody$outboundSchema.parse(
+      updateUserProfilePictureRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateUserProfilePictureRequest$Outbound = {
+  id_or_me: string;
+  RequestBody: UpdateUserProfilePictureRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateUserProfilePictureRequest$outboundSchema: z.ZodType<
+  UpdateUserProfilePictureRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateUserProfilePictureRequest
+> = z.object({
+  idOrMe: z.string(),
+  requestBody: z.lazy(() => UpdateUserProfilePictureRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    idOrMe: "id_or_me",
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateUserProfilePictureRequestToJSON(
+  updateUserProfilePictureRequest: UpdateUserProfilePictureRequest,
+): string {
+  return JSON.stringify(
+    UpdateUserProfilePictureRequest$outboundSchema.parse(
+      updateUserProfilePictureRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const UpdateUserProfilePictureUpdateUserProfilePictureOk$inboundSchema:
+  z.ZodType<
+    UpdateUserProfilePictureUpdateUserProfilePictureOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    id: types.number(),
+  });
+
+export function updateUserProfilePictureUpdateUserProfilePictureOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  UpdateUserProfilePictureUpdateUserProfilePictureOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UpdateUserProfilePictureUpdateUserProfilePictureOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'UpdateUserProfilePictureUpdateUserProfilePictureOk' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -56,6 +56,8 @@ export * from "./usersPasswordResetRequest.js";
 export * from "./usersPostAuthenticate.js";
 export * from "./usersRotateApiKey.js";
 export * from "./usersSwitchAccount.js";
+export * from "./usersUpdateUser.js";
+export * from "./usersUpdateUserProfilePicture.js";
 export * from "./vendorFieldsCreateVendorField.js";
 export * from "./vendorFieldsUpdateVendorField.js";
 export * from "./vendorsAcceptVendorCredential.js";

package/src/react-query/usersUpdateUser.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { usersUpdateUser } from "../funcs/usersUpdateUser.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 UsersUpdateUserMutationVariables = {
+  request: operations.UpdateUserRequest;
+  options?: RequestOptions;
+};
+
+export type UsersUpdateUserMutationData = operations.UpdateUserUpdateUserOk;
+
+export type UsersUpdateUserMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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.
+ */
+export function useUsersUpdateUserMutation(
+  options?: MutationHookOptions<
+    UsersUpdateUserMutationData,
+    UsersUpdateUserMutationError,
+    UsersUpdateUserMutationVariables
+  >,
+): UseMutationResult<
+  UsersUpdateUserMutationData,
+  UsersUpdateUserMutationError,
+  UsersUpdateUserMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildUsersUpdateUserMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyUsersUpdateUser(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "users", "updateUser"];
+}
+
+export function buildUsersUpdateUserMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: UsersUpdateUserMutationVariables,
+  ) => Promise<UsersUpdateUserMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyUsersUpdateUser(),
+    mutationFn: function usersUpdateUserMutationFn({
+      request,
+      options,
+    }): Promise<UsersUpdateUserMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(usersUpdateUser(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/usersUpdateUserProfilePicture.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { usersUpdateUserProfilePicture } from "../funcs/usersUpdateUserProfilePicture.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 UsersUpdateUserProfilePictureMutationVariables = {
+  request: operations.UpdateUserProfilePictureRequest;
+  options?: RequestOptions;
+};
+
+export type UsersUpdateUserProfilePictureMutationData =
+  operations.UpdateUserProfilePictureUpdateUserProfilePictureOk;
+
+export type UsersUpdateUserProfilePictureMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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.
+ */
+export function useUsersUpdateUserProfilePictureMutation(
+  options?: MutationHookOptions<
+    UsersUpdateUserProfilePictureMutationData,
+    UsersUpdateUserProfilePictureMutationError,
+    UsersUpdateUserProfilePictureMutationVariables
+  >,
+): UseMutationResult<
+  UsersUpdateUserProfilePictureMutationData,
+  UsersUpdateUserProfilePictureMutationError,
+  UsersUpdateUserProfilePictureMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildUsersUpdateUserProfilePictureMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyUsersUpdateUserProfilePicture(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "users", "updateUserProfilePicture"];
+}
+
+export function buildUsersUpdateUserProfilePictureMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: UsersUpdateUserProfilePictureMutationVariables,
+  ) => Promise<UsersUpdateUserProfilePictureMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyUsersUpdateUserProfilePicture(),
+    mutationFn: function usersUpdateUserProfilePictureMutationFn({
+      request,
+      options,
+    }): Promise<UsersUpdateUserProfilePictureMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(usersUpdateUserProfilePicture(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorFieldsCreateVendorField.ts

@@ -50,8 +50,9 @@ export type VendorFieldsCreateVendorFieldMutationError =
  * 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/sdk/users.ts

@@ -12,6 +12,8 @@ import { usersPasswordResetRequest } from "../funcs/usersPasswordResetRequest.js
 import { usersPostAuthenticate } from "../funcs/usersPostAuthenticate.js";
 import { usersRotateApiKey } from "../funcs/usersRotateApiKey.js";
 import { usersSwitchAccount } from "../funcs/usersSwitchAccount.js";
+import { usersUpdateUser } from "../funcs/usersUpdateUser.js";
+import { usersUpdateUserProfilePicture } from "../funcs/usersUpdateUserProfilePicture.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -53,6 +55,29 @@ export class Users extends ClientSDK {
     ));
   }
 
+  /**
+   * 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.
+   */
+  async updateUser(
+    request: operations.UpdateUserRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateUserUpdateUserOk> {
+    return unwrapAsync(usersUpdateUser(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Logs user into the system
    *
@@ -222,4 +247,21 @@ export class Users extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * 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.
+   */
+  async updateUserProfilePicture(
+    request: operations.UpdateUserProfilePictureRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateUserProfilePictureUpdateUserProfilePictureOk> {
+    return unwrapAsync(usersUpdateUserProfilePicture(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/vendorfields.ts

@@ -13,8 +13,9 @@ 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.
+   * 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