@greensecurity/javascript-sdk 0.9.1

package/src/models/components/user.ts

@@ -0,0 +1,451 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Contact,
+  Contact$inboundSchema,
+  Contact$Outbound,
+  Contact$outboundSchema,
+} from "./contact.js";
+
+/**
+ * The flavor of user will determine the most relevant user experience for this user as well as permissions
+ */
+export const UserType = {
+  Api: "API",
+  Admin: "Admin",
+  CompanyManager: "Company Manager",
+  FacilityAdmin: "Facility Admin",
+  FacilityUser: "Facility User",
+  InventoryManager: "Inventory Manager",
+  SystemUser: "System User",
+  UserType: "User Type",
+  Vendor: "Vendor",
+} as const;
+/**
+ * The flavor of user will determine the most relevant user experience for this user as well as permissions
+ */
+export type UserType = ClosedEnum<typeof UserType>;
+
+export type UserUser = {
+  /**
+   * This identifier is only used to reference the underlying user. Based on the `user_type` a more relevant identifier may be used to get relvant information from other endpoints.
+   */
+  id: number;
+  /**
+   * First name of the user
+   */
+  firstName?: string | undefined;
+  /**
+   * Last name of the user
+   */
+  lastName?: string | undefined;
+  /**
+   * Email address (not always valid)
+   */
+  email: string;
+  phone?: string | null | undefined;
+  /**
+   * The flavor of user will determine the most relevant user experience for this user as well as permissions
+   */
+  userType: UserType;
+  /**
+   * The timezone of the user. This is used to display times in the user's local time. If not present, use the device's local timezone.
+   */
+  timezone?: string | null | undefined;
+};
+
+/**
+ * A `permanent` user token can be used to access any API endpoint as the logged in user. A `one time` token is used to authenticate the user once.
+ */
+export const TokenType = {
+  Permanent: "permanent",
+  OneTime: "one time",
+} as const;
+/**
+ * A `permanent` user token can be used to access any API endpoint as the logged in user. A `one time` token is used to authenticate the user once.
+ */
+export type TokenType = ClosedEnum<typeof TokenType>;
+
+export type UserToken = {
+  /**
+   * This token can be passed in authorization headers for this user.
+   */
+  token: string;
+  /**
+   * A `permanent` user token can be used to access any API endpoint as the logged in user. A `one time` token is used to authenticate the user once.
+   */
+  tokenType?: TokenType | undefined;
+};
+
+export type Vendor = {};
+
+export type InventoryManager = {};
+
+/**
+ * The User object describes a person or service account.
+ */
+export type User = {
+  /**
+   * A `gatekeeper` is a special type of service user. This type of service user is assigned to Kiosks and Apps to verify Vendors using APIs that have some access to facility data.
+   */
+  isGatekeeper: boolean;
+  success: boolean;
+  user: UserUser;
+  userToken: UserToken;
+  vendor?: Vendor | undefined;
+  inventoryManager?: InventoryManager | undefined;
+  /**
+   * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+   */
+  contact?: Contact | undefined;
+};
+
+/** @internal */
+export const UserType$inboundSchema: z.ZodNativeEnum<typeof UserType> = z
+  .nativeEnum(UserType);
+
+/** @internal */
+export const UserType$outboundSchema: z.ZodNativeEnum<typeof UserType> =
+  UserType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UserType$ {
+  /** @deprecated use `UserType$inboundSchema` instead. */
+  export const inboundSchema = UserType$inboundSchema;
+  /** @deprecated use `UserType$outboundSchema` instead. */
+  export const outboundSchema = UserType$outboundSchema;
+}
+
+/** @internal */
+export const UserUser$inboundSchema: z.ZodType<
+  UserUser,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  first_name: z.string().optional(),
+  last_name: z.string().optional(),
+  email: z.string(),
+  phone: z.nullable(z.string()).optional(),
+  user_type: UserType$inboundSchema,
+  timezone: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "first_name": "firstName",
+    "last_name": "lastName",
+    "user_type": "userType",
+  });
+});
+
+/** @internal */
+export type UserUser$Outbound = {
+  id: number;
+  first_name?: string | undefined;
+  last_name?: string | undefined;
+  email: string;
+  phone?: string | null | undefined;
+  user_type: string;
+  timezone?: string | null | undefined;
+};
+
+/** @internal */
+export const UserUser$outboundSchema: z.ZodType<
+  UserUser$Outbound,
+  z.ZodTypeDef,
+  UserUser
+> = z.object({
+  id: z.number().int(),
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  email: z.string(),
+  phone: z.nullable(z.string()).optional(),
+  userType: UserType$outboundSchema,
+  timezone: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    firstName: "first_name",
+    lastName: "last_name",
+    userType: "user_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UserUser$ {
+  /** @deprecated use `UserUser$inboundSchema` instead. */
+  export const inboundSchema = UserUser$inboundSchema;
+  /** @deprecated use `UserUser$outboundSchema` instead. */
+  export const outboundSchema = UserUser$outboundSchema;
+  /** @deprecated use `UserUser$Outbound` instead. */
+  export type Outbound = UserUser$Outbound;
+}
+
+export function userUserToJSON(userUser: UserUser): string {
+  return JSON.stringify(UserUser$outboundSchema.parse(userUser));
+}
+
+export function userUserFromJSON(
+  jsonString: string,
+): SafeParseResult<UserUser, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserUser$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserUser' from JSON`,
+  );
+}
+
+/** @internal */
+export const TokenType$inboundSchema: z.ZodNativeEnum<typeof TokenType> = z
+  .nativeEnum(TokenType);
+
+/** @internal */
+export const TokenType$outboundSchema: z.ZodNativeEnum<typeof TokenType> =
+  TokenType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TokenType$ {
+  /** @deprecated use `TokenType$inboundSchema` instead. */
+  export const inboundSchema = TokenType$inboundSchema;
+  /** @deprecated use `TokenType$outboundSchema` instead. */
+  export const outboundSchema = TokenType$outboundSchema;
+}
+
+/** @internal */
+export const UserToken$inboundSchema: z.ZodType<
+  UserToken,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: z.string(),
+  token_type: TokenType$inboundSchema.default("permanent"),
+}).transform((v) => {
+  return remap$(v, {
+    "token_type": "tokenType",
+  });
+});
+
+/** @internal */
+export type UserToken$Outbound = {
+  token: string;
+  token_type: string;
+};
+
+/** @internal */
+export const UserToken$outboundSchema: z.ZodType<
+  UserToken$Outbound,
+  z.ZodTypeDef,
+  UserToken
+> = z.object({
+  token: z.string(),
+  tokenType: TokenType$outboundSchema.default("permanent"),
+}).transform((v) => {
+  return remap$(v, {
+    tokenType: "token_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UserToken$ {
+  /** @deprecated use `UserToken$inboundSchema` instead. */
+  export const inboundSchema = UserToken$inboundSchema;
+  /** @deprecated use `UserToken$outboundSchema` instead. */
+  export const outboundSchema = UserToken$outboundSchema;
+  /** @deprecated use `UserToken$Outbound` instead. */
+  export type Outbound = UserToken$Outbound;
+}
+
+export function userTokenToJSON(userToken: UserToken): string {
+  return JSON.stringify(UserToken$outboundSchema.parse(userToken));
+}
+
+export function userTokenFromJSON(
+  jsonString: string,
+): SafeParseResult<UserToken, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserToken$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserToken' from JSON`,
+  );
+}
+
+/** @internal */
+export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Vendor$Outbound = {};
+
+/** @internal */
+export const Vendor$outboundSchema: z.ZodType<
+  Vendor$Outbound,
+  z.ZodTypeDef,
+  Vendor
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Vendor$ {
+  /** @deprecated use `Vendor$inboundSchema` instead. */
+  export const inboundSchema = Vendor$inboundSchema;
+  /** @deprecated use `Vendor$outboundSchema` instead. */
+  export const outboundSchema = Vendor$outboundSchema;
+  /** @deprecated use `Vendor$Outbound` instead. */
+  export type Outbound = Vendor$Outbound;
+}
+
+export function vendorToJSON(vendor: Vendor): string {
+  return JSON.stringify(Vendor$outboundSchema.parse(vendor));
+}
+
+export function vendorFromJSON(
+  jsonString: string,
+): SafeParseResult<Vendor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Vendor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Vendor' from JSON`,
+  );
+}
+
+/** @internal */
+export const InventoryManager$inboundSchema: z.ZodType<
+  InventoryManager,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type InventoryManager$Outbound = {};
+
+/** @internal */
+export const InventoryManager$outboundSchema: z.ZodType<
+  InventoryManager$Outbound,
+  z.ZodTypeDef,
+  InventoryManager
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InventoryManager$ {
+  /** @deprecated use `InventoryManager$inboundSchema` instead. */
+  export const inboundSchema = InventoryManager$inboundSchema;
+  /** @deprecated use `InventoryManager$outboundSchema` instead. */
+  export const outboundSchema = InventoryManager$outboundSchema;
+  /** @deprecated use `InventoryManager$Outbound` instead. */
+  export type Outbound = InventoryManager$Outbound;
+}
+
+export function inventoryManagerToJSON(
+  inventoryManager: InventoryManager,
+): string {
+  return JSON.stringify(
+    InventoryManager$outboundSchema.parse(inventoryManager),
+  );
+}
+
+export function inventoryManagerFromJSON(
+  jsonString: string,
+): SafeParseResult<InventoryManager, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InventoryManager$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InventoryManager' from JSON`,
+  );
+}
+
+/** @internal */
+export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
+  .object({
+    is_gatekeeper: z.boolean(),
+    success: z.boolean(),
+    user: z.lazy(() => UserUser$inboundSchema),
+    user_token: z.lazy(() => UserToken$inboundSchema),
+    vendor: z.lazy(() => Vendor$inboundSchema).optional(),
+    inventory_manager: z.lazy(() => InventoryManager$inboundSchema).optional(),
+    contact: Contact$inboundSchema.optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "is_gatekeeper": "isGatekeeper",
+      "user_token": "userToken",
+      "inventory_manager": "inventoryManager",
+    });
+  });
+
+/** @internal */
+export type User$Outbound = {
+  is_gatekeeper: boolean;
+  success: boolean;
+  user: UserUser$Outbound;
+  user_token: UserToken$Outbound;
+  vendor?: Vendor$Outbound | undefined;
+  inventory_manager?: InventoryManager$Outbound | undefined;
+  contact?: Contact$Outbound | undefined;
+};
+
+/** @internal */
+export const User$outboundSchema: z.ZodType<User$Outbound, z.ZodTypeDef, User> =
+  z.object({
+    isGatekeeper: z.boolean(),
+    success: z.boolean(),
+    user: z.lazy(() => UserUser$outboundSchema),
+    userToken: z.lazy(() => UserToken$outboundSchema),
+    vendor: z.lazy(() => Vendor$outboundSchema).optional(),
+    inventoryManager: z.lazy(() => InventoryManager$outboundSchema).optional(),
+    contact: Contact$outboundSchema.optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      isGatekeeper: "is_gatekeeper",
+      userToken: "user_token",
+      inventoryManager: "inventory_manager",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace User$ {
+  /** @deprecated use `User$inboundSchema` instead. */
+  export const inboundSchema = User$inboundSchema;
+  /** @deprecated use `User$outboundSchema` instead. */
+  export const outboundSchema = User$outboundSchema;
+  /** @deprecated use `User$Outbound` instead. */
+  export type Outbound = User$Outbound;
+}
+
+export function userToJSON(user: User): string {
+  return JSON.stringify(User$outboundSchema.parse(user));
+}
+
+export function userFromJSON(
+  jsonString: string,
+): SafeParseResult<User, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => User$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'User' from JSON`,
+  );
+}

package/src/models/components/vendorjobtitle.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Represents a job title that a vendor should select from to identify their primary job function. Job titles are categorized in a tree hierarchy (string separated by `|` pipe symbols).
+ *
+ * @remarks
+ *
+ * For example, a job with the name `Category|Sub Category|Title` represents a job called `Title` that should be displayed to the user in a tree of `Category -> Sub Category -> Title`
+ */
+export type VendorJobTitle = {
+  id: number;
+  /**
+   * An arbitrarily deep categorized name of a job title separated by `|` pipe symbols.
+   */
+  job: string;
+};
+
+/** @internal */
+export const VendorJobTitle$inboundSchema: z.ZodType<
+  VendorJobTitle,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  job: z.string(),
+});
+
+/** @internal */
+export type VendorJobTitle$Outbound = {
+  id: number;
+  job: string;
+};
+
+/** @internal */
+export const VendorJobTitle$outboundSchema: z.ZodType<
+  VendorJobTitle$Outbound,
+  z.ZodTypeDef,
+  VendorJobTitle
+> = z.object({
+  id: z.number().int(),
+  job: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VendorJobTitle$ {
+  /** @deprecated use `VendorJobTitle$inboundSchema` instead. */
+  export const inboundSchema = VendorJobTitle$inboundSchema;
+  /** @deprecated use `VendorJobTitle$outboundSchema` instead. */
+  export const outboundSchema = VendorJobTitle$outboundSchema;
+  /** @deprecated use `VendorJobTitle$Outbound` instead. */
+  export type Outbound = VendorJobTitle$Outbound;
+}
+
+export function vendorJobTitleToJSON(vendorJobTitle: VendorJobTitle): string {
+  return JSON.stringify(VendorJobTitle$outboundSchema.parse(vendorJobTitle));
+}
+
+export function vendorJobTitleFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorJobTitle, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorJobTitle$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorJobTitle' from JSON`,
+  );
+}

package/src/models/components/vendortype.ts

@@ -0,0 +1,170 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AppliesTo = {
+  companyId?: number | undefined;
+  companyGroupId?: number | undefined;
+  vendorGroupId?: number | undefined;
+  everyoneElse: boolean;
+};
+
+/**
+ * An object which represents a specific `level` or type of vendor. These can be customized by `Company`, `VendorGroup`, or `CompanyGroup`.
+ */
+export type VendorType = {
+  name: string;
+  shortName: string;
+  sortOrder: number;
+  appliesTo: AppliesTo;
+};
+
+/** @internal */
+export const AppliesTo$inboundSchema: z.ZodType<
+  AppliesTo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  company_id: z.number().int().optional(),
+  company_group_id: z.number().int().optional(),
+  vendor_group_id: z.number().int().optional(),
+  everyone_else: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "company_id": "companyId",
+    "company_group_id": "companyGroupId",
+    "vendor_group_id": "vendorGroupId",
+    "everyone_else": "everyoneElse",
+  });
+});
+
+/** @internal */
+export type AppliesTo$Outbound = {
+  company_id?: number | undefined;
+  company_group_id?: number | undefined;
+  vendor_group_id?: number | undefined;
+  everyone_else: boolean;
+};
+
+/** @internal */
+export const AppliesTo$outboundSchema: z.ZodType<
+  AppliesTo$Outbound,
+  z.ZodTypeDef,
+  AppliesTo
+> = z.object({
+  companyId: z.number().int().optional(),
+  companyGroupId: z.number().int().optional(),
+  vendorGroupId: z.number().int().optional(),
+  everyoneElse: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    companyGroupId: "company_group_id",
+    vendorGroupId: "vendor_group_id",
+    everyoneElse: "everyone_else",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppliesTo$ {
+  /** @deprecated use `AppliesTo$inboundSchema` instead. */
+  export const inboundSchema = AppliesTo$inboundSchema;
+  /** @deprecated use `AppliesTo$outboundSchema` instead. */
+  export const outboundSchema = AppliesTo$outboundSchema;
+  /** @deprecated use `AppliesTo$Outbound` instead. */
+  export type Outbound = AppliesTo$Outbound;
+}
+
+export function appliesToToJSON(appliesTo: AppliesTo): string {
+  return JSON.stringify(AppliesTo$outboundSchema.parse(appliesTo));
+}
+
+export function appliesToFromJSON(
+  jsonString: string,
+): SafeParseResult<AppliesTo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppliesTo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppliesTo' from JSON`,
+  );
+}
+
+/** @internal */
+export const VendorType$inboundSchema: z.ZodType<
+  VendorType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  short_name: z.string(),
+  sort_order: z.number().int(),
+  applies_to: z.lazy(() => AppliesTo$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "short_name": "shortName",
+    "sort_order": "sortOrder",
+    "applies_to": "appliesTo",
+  });
+});
+
+/** @internal */
+export type VendorType$Outbound = {
+  name: string;
+  short_name: string;
+  sort_order: number;
+  applies_to: AppliesTo$Outbound;
+};
+
+/** @internal */
+export const VendorType$outboundSchema: z.ZodType<
+  VendorType$Outbound,
+  z.ZodTypeDef,
+  VendorType
+> = z.object({
+  name: z.string(),
+  shortName: z.string(),
+  sortOrder: z.number().int(),
+  appliesTo: z.lazy(() => AppliesTo$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    shortName: "short_name",
+    sortOrder: "sort_order",
+    appliesTo: "applies_to",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VendorType$ {
+  /** @deprecated use `VendorType$inboundSchema` instead. */
+  export const inboundSchema = VendorType$inboundSchema;
+  /** @deprecated use `VendorType$outboundSchema` instead. */
+  export const outboundSchema = VendorType$outboundSchema;
+  /** @deprecated use `VendorType$Outbound` instead. */
+  export type Outbound = VendorType$Outbound;
+}
+
+export function vendorTypeToJSON(vendorType: VendorType): string {
+  return JSON.stringify(VendorType$outboundSchema.parse(vendorType));
+}
+
+export function vendorTypeFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorType, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorType$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorType' from JSON`,
+  );
+}