@greensecurity/javascript-sdk 0.9.1

package/src/models/errors/apierror.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export class APIError extends Error {
+  public readonly statusCode: number;
+  public readonly contentType: string;
+
+  constructor(
+    message: string,
+    public readonly rawResponse: Response,
+    public readonly body: string = "",
+  ) {
+    const statusCode = rawResponse.status;
+    const contentType = rawResponse.headers.get("content-type") || "";
+    const bodyString = body.length > 0 ? `\n${body}` : "";
+
+    super(
+      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
+    );
+
+    this.statusCode = statusCode;
+    this.contentType = contentType;
+
+    this.name = "APIError";
+  }
+}

package/src/models/errors/apierrorresponse.ts

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * Green Security uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe’s servers (these are rare).
+ *
+ * @remarks
+ *
+ * Some 4xx errors that could be handled programmatically (e.g., invalid input) include an error description that briefly explains the error reported.
+ */
+export type ApiErrorResponseData = {
+  error: string;
+  success: boolean;
+  code?: number | null | undefined;
+};
+
+/**
+ * Green Security uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe’s servers (these are rare).
+ *
+ * @remarks
+ *
+ * Some 4xx errors that could be handled programmatically (e.g., invalid input) include an error description that briefly explains the error reported.
+ */
+export class ApiErrorResponse extends Error {
+  error: string;
+  success: boolean;
+  code?: number | null | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ApiErrorResponseData;
+
+  constructor(err: ApiErrorResponseData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.error = err.error;
+    this.success = err.success;
+    if (err.code != null) this.code = err.code;
+
+    this.name = "ApiErrorResponse";
+  }
+}
+
+/** @internal */
+export const ApiErrorResponse$inboundSchema: z.ZodType<
+  ApiErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+  success: z.boolean(),
+  code: z.nullable(z.number().int()).optional(),
+})
+  .transform((v) => {
+    return new ApiErrorResponse(v);
+  });
+
+/** @internal */
+export type ApiErrorResponse$Outbound = {
+  error: string;
+  success: boolean;
+  code?: number | null | undefined;
+};
+
+/** @internal */
+export const ApiErrorResponse$outboundSchema: z.ZodType<
+  ApiErrorResponse$Outbound,
+  z.ZodTypeDef,
+  ApiErrorResponse
+> = z.instanceof(ApiErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: z.string(),
+    success: z.boolean(),
+    code: z.nullable(z.number().int()).optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ApiErrorResponse$ {
+  /** @deprecated use `ApiErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = ApiErrorResponse$inboundSchema;
+  /** @deprecated use `ApiErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = ApiErrorResponse$outboundSchema;
+  /** @deprecated use `ApiErrorResponse$Outbound` instead. */
+  export type Outbound = ApiErrorResponse$Outbound;
+}

package/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}

package/src/models/errors/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./apierror.js";
+export * from "./apierrorresponse.js";
+export * from "./httpclienterrors.js";
+export * from "./sdkvalidationerror.js";

package/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(`${message}: ${cause}`);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}
+
+export function formatZodError(err: z.ZodError, level = 0): string {
+  let pre = "  ".repeat(level);
+  pre = level > 0 ? `│${pre}` : pre;
+  pre += " ".repeat(level);
+
+  let message = "";
+  const append = (str: string) => (message += `\n${pre}${str}`);
+
+  const len = err.issues.length;
+  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
+
+  if (len) {
+    append(`┌ ${headline}:`);
+  }
+
+  for (const issue of err.issues) {
+    let path = issue.path.join(".");
+    path = path ? `<root>.${path}` : "<root>";
+    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
+    switch (issue.code) {
+      case "invalid_literal":
+      case "invalid_type": {
+        append(`│     Want: ${issue.expected}`);
+        append(`│      Got: ${issue.received}`);
+        break;
+      }
+      case "unrecognized_keys": {
+        append(`│     Keys: ${issue.keys.join(", ")}`);
+        break;
+      }
+      case "invalid_enum_value": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        append(`│         Got: ${issue.received}`);
+        break;
+      }
+      case "invalid_union_discriminator": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        break;
+      }
+      case "invalid_union": {
+        const len = issue.unionErrors.length;
+        append(
+          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
+        );
+        issue.unionErrors.forEach((err, i) => {
+          append(`│   ✖︎ Member ${i + 1} of ${len}`);
+          append(`${formatZodError(err, level + 1)}`);
+        });
+      }
+    }
+  }
+
+  if (err.issues.length) {
+    append(`└─*`);
+  }
+
+  return message.slice(1);
+}

package/src/models/operations/createvendorregistration.ts

@@ -0,0 +1,237 @@
+/*
+ * 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 CreateVendorRegistrationRequestBody = {
+  /**
+   * The vendor's email address
+   */
+  email: string;
+  /**
+   * The password is required. It must meet the following complexity rules:
+   *
+   * @remarks
+   *
+   * 1. At least 8 characters long
+   * 2. Contains at least 1 upper case character
+   * 3. Contains at least 1 lower case character
+   * 4. Contains at least 1 number
+   * 5. Contains at least 1 symbol
+   * 6. Must not include the user name or email address
+   */
+  password: string;
+  /**
+   * [IANA TimeZone Identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
+   */
+  timezone?: string | undefined;
+  /**
+   * Leave this undefined/null unless you have been assigned an Affiliate ID by Green Security.
+   */
+  affiliateId?: number | undefined;
+  /**
+   * If the vendor is being invited to join a specific Vendor Group, provide the ID of that Vendor Group.
+   */
+  vendorGroupId?: number | undefined;
+  /**
+   * If the vendor is being invited to join a specific company that already exists, provide the company ID that was part of the invitation. Leave empty otherwise.
+   */
+  managingCompanyId?: number | undefined;
+};
+
+export type Data = {};
+
+/**
+ * The request was successful, and a new resource was created.
+ */
+export type CreateVendorRegistrationResponseBody = {
+  data: Data;
+};
+
+/** @internal */
+export const CreateVendorRegistrationRequestBody$inboundSchema: z.ZodType<
+  CreateVendorRegistrationRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string(),
+  password: z.string(),
+  timezone: z.string().optional(),
+  affiliate_id: z.number().int().optional(),
+  vendor_group_id: z.number().int().optional(),
+  managing_company_id: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "affiliate_id": "affiliateId",
+    "vendor_group_id": "vendorGroupId",
+    "managing_company_id": "managingCompanyId",
+  });
+});
+
+/** @internal */
+export type CreateVendorRegistrationRequestBody$Outbound = {
+  email: string;
+  password: string;
+  timezone?: string | undefined;
+  affiliate_id?: number | undefined;
+  vendor_group_id?: number | undefined;
+  managing_company_id?: number | undefined;
+};
+
+/** @internal */
+export const CreateVendorRegistrationRequestBody$outboundSchema: z.ZodType<
+  CreateVendorRegistrationRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateVendorRegistrationRequestBody
+> = z.object({
+  email: z.string(),
+  password: z.string(),
+  timezone: z.string().optional(),
+  affiliateId: z.number().int().optional(),
+  vendorGroupId: z.number().int().optional(),
+  managingCompanyId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    affiliateId: "affiliate_id",
+    vendorGroupId: "vendor_group_id",
+    managingCompanyId: "managing_company_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateVendorRegistrationRequestBody$ {
+  /** @deprecated use `CreateVendorRegistrationRequestBody$inboundSchema` instead. */
+  export const inboundSchema =
+    CreateVendorRegistrationRequestBody$inboundSchema;
+  /** @deprecated use `CreateVendorRegistrationRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateVendorRegistrationRequestBody$outboundSchema;
+  /** @deprecated use `CreateVendorRegistrationRequestBody$Outbound` instead. */
+  export type Outbound = CreateVendorRegistrationRequestBody$Outbound;
+}
+
+export function createVendorRegistrationRequestBodyToJSON(
+  createVendorRegistrationRequestBody: CreateVendorRegistrationRequestBody,
+): string {
+  return JSON.stringify(
+    CreateVendorRegistrationRequestBody$outboundSchema.parse(
+      createVendorRegistrationRequestBody,
+    ),
+  );
+}
+
+export function createVendorRegistrationRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateVendorRegistrationRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateVendorRegistrationRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateVendorRegistrationRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Data$Outbound = {};
+
+/** @internal */
+export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
+  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 Data$ {
+  /** @deprecated use `Data$inboundSchema` instead. */
+  export const inboundSchema = Data$inboundSchema;
+  /** @deprecated use `Data$outboundSchema` instead. */
+  export const outboundSchema = Data$outboundSchema;
+  /** @deprecated use `Data$Outbound` instead. */
+  export type Outbound = Data$Outbound;
+}
+
+export function dataToJSON(data: Data): string {
+  return JSON.stringify(Data$outboundSchema.parse(data));
+}
+
+export function dataFromJSON(
+  jsonString: string,
+): SafeParseResult<Data, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Data$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Data' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateVendorRegistrationResponseBody$inboundSchema: z.ZodType<
+  CreateVendorRegistrationResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.lazy(() => Data$inboundSchema),
+});
+
+/** @internal */
+export type CreateVendorRegistrationResponseBody$Outbound = {
+  data: Data$Outbound;
+};
+
+/** @internal */
+export const CreateVendorRegistrationResponseBody$outboundSchema: z.ZodType<
+  CreateVendorRegistrationResponseBody$Outbound,
+  z.ZodTypeDef,
+  CreateVendorRegistrationResponseBody
+> = z.object({
+  data: z.lazy(() => Data$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateVendorRegistrationResponseBody$ {
+  /** @deprecated use `CreateVendorRegistrationResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    CreateVendorRegistrationResponseBody$inboundSchema;
+  /** @deprecated use `CreateVendorRegistrationResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateVendorRegistrationResponseBody$outboundSchema;
+  /** @deprecated use `CreateVendorRegistrationResponseBody$Outbound` instead. */
+  export type Outbound = CreateVendorRegistrationResponseBody$Outbound;
+}
+
+export function createVendorRegistrationResponseBodyToJSON(
+  createVendorRegistrationResponseBody: CreateVendorRegistrationResponseBody,
+): string {
+  return JSON.stringify(
+    CreateVendorRegistrationResponseBody$outboundSchema.parse(
+      createVendorRegistrationResponseBody,
+    ),
+  );
+}
+
+export function createVendorRegistrationResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateVendorRegistrationResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateVendorRegistrationResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateVendorRegistrationResponseBody' from JSON`,
+  );
+}

package/src/models/operations/getfacility.ts

@@ -0,0 +1,69 @@
+/*
+ * 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";
+
+export type GetFacilityRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+};
+
+/** @internal */
+export const GetFacilityRequest$inboundSchema: z.ZodType<
+  GetFacilityRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+});
+
+/** @internal */
+export type GetFacilityRequest$Outbound = {
+  id: number;
+};
+
+/** @internal */
+export const GetFacilityRequest$outboundSchema: z.ZodType<
+  GetFacilityRequest$Outbound,
+  z.ZodTypeDef,
+  GetFacilityRequest
+> = z.object({
+  id: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetFacilityRequest$ {
+  /** @deprecated use `GetFacilityRequest$inboundSchema` instead. */
+  export const inboundSchema = GetFacilityRequest$inboundSchema;
+  /** @deprecated use `GetFacilityRequest$outboundSchema` instead. */
+  export const outboundSchema = GetFacilityRequest$outboundSchema;
+  /** @deprecated use `GetFacilityRequest$Outbound` instead. */
+  export type Outbound = GetFacilityRequest$Outbound;
+}
+
+export function getFacilityRequestToJSON(
+  getFacilityRequest: GetFacilityRequest,
+): string {
+  return JSON.stringify(
+    GetFacilityRequest$outboundSchema.parse(getFacilityRequest),
+  );
+}
+
+export function getFacilityRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetFacilityRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetFacilityRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetFacilityRequest' from JSON`,
+  );
+}

package/src/models/operations/getuserbyid.ts

@@ -0,0 +1,69 @@
+/*
+ * 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";
+
+export type GetUserByIdRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+};
+
+/** @internal */
+export const GetUserByIdRequest$inboundSchema: z.ZodType<
+  GetUserByIdRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+});
+
+/** @internal */
+export type GetUserByIdRequest$Outbound = {
+  id: number;
+};
+
+/** @internal */
+export const GetUserByIdRequest$outboundSchema: z.ZodType<
+  GetUserByIdRequest$Outbound,
+  z.ZodTypeDef,
+  GetUserByIdRequest
+> = z.object({
+  id: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetUserByIdRequest$ {
+  /** @deprecated use `GetUserByIdRequest$inboundSchema` instead. */
+  export const inboundSchema = GetUserByIdRequest$inboundSchema;
+  /** @deprecated use `GetUserByIdRequest$outboundSchema` instead. */
+  export const outboundSchema = GetUserByIdRequest$outboundSchema;
+  /** @deprecated use `GetUserByIdRequest$Outbound` instead. */
+  export type Outbound = GetUserByIdRequest$Outbound;
+}
+
+export function getUserByIdRequestToJSON(
+  getUserByIdRequest: GetUserByIdRequest,
+): string {
+  return JSON.stringify(
+    GetUserByIdRequest$outboundSchema.parse(getUserByIdRequest),
+  );
+}
+
+export function getUserByIdRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetUserByIdRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetUserByIdRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetUserByIdRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./createvendorregistration.js";
+export * from "./getfacility.js";
+export * from "./getuserbyid.js";
+export * from "./listorsearchfacilities.js";
+export * from "./listvendorjobtitles.js";
+export * from "./logsuserintothesystem.js";