@greensecurity/javascript-sdk 0.40.8-beta.3 → 0.40.8-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.40.8-beta.3",
+  "version": "0.40.8-beta.5",
   "author": "Green Security LLC",
   "type": "module",
   "tshy": {

package/src/__tests__/alerts.test.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { GreenSecurity } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Alerts List Alerts", async () => {
+  const testHttpClient = createTestHTTPClient("listAlerts");
+
+  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.alerts.listAlerts({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+  });
+  expect(result).toBeDefined();
+  expect(result.result).toBeDefined();
+  expect(result.result).toEqual({
+    pager: {
+      baseUrl: "api/vendors/job_titles",
+      sort: "job,title",
+      desc: 0,
+      itemCount: 228,
+      itemsPerPage: 562526,
+      page: 1,
+      useUrlParams: true,
+    },
+    items: [],
+  });
+});
+
+test("Alerts Update User Alerts", async () => {
+  const testHttpClient = createTestHTTPClient("updateUserAlerts");
+
+  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.alerts.updateUserAlerts({});
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/funcs/alertsListAlerts.ts

@@ -0,0 +1,245 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery } 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";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List alerts
+ *
+ * @remarks
+ * List alerts for user.
+ */
+export function alertsListAlerts(
+  client: GreenSecurityCore,
+  request: operations.ListAlertsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListAlertsResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { page: number }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ListAlertsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListAlertsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListAlertsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/alerts")();
+
+  const query = encodeFormQuery({
+    "desc": payload.desc,
+    "items_per_page": payload.items_per_page,
+    "page": payload.page,
+    "sort": payload.sort,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listAlerts",
+    oAuth2Scopes: [],
+
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.ListAlertsResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListAlertsResponse$inboundSchema, { key: "Result" }),
+    M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListAlertsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "items");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      alertsListAlerts(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/funcs/alertsUpdateUserAlerts.ts

@@ -0,0 +1,170 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeJSON } 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 alerts
+ *
+ * @remarks
+ * Update user alerts
+ */
+export function alertsUpdateUserAlerts(
+  client: GreenSecurityCore,
+  request: operations.UpdateUserAlertsRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UpdateUserAlertsResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.UpdateUserAlertsRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.UpdateUserAlertsResponseBody,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.UpdateUserAlertsRequestBody$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/user-alerts")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "updateUserAlerts",
+    oAuth2Scopes: [],
+
+    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", "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.UpdateUserAlertsResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.UpdateUserAlertsResponseBody$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

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.4",
-  sdkVersion: "0.40.8-beta.2",
+  sdkVersion: "0.40.8-beta.4",
   genVersion: "2.687.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.40.8-beta.2 2.687.1 0.0.4 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.40.8-beta.4 2.687.1 0.0.4 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/alert.ts

@@ -0,0 +1,109 @@
+/*
+ * 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";
+
+/**
+ * A simplified representation of a Alert, typically used in list views.
+ */
+export type Alert = {
+  id?: number | undefined;
+  dateAdded?: string | null | undefined;
+  dateStarts?: string | null | undefined;
+  message?: string | null | undefined;
+  status?: string | null | undefined;
+  title?: string | null | undefined;
+  plainText?: string | null | undefined;
+  viewed?: boolean | null | undefined;
+  dateViewed?: string | null | undefined;
+};
+
+/** @internal */
+export const Alert$inboundSchema: z.ZodType<Alert, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.number().int().optional(),
+    date_added: z.nullable(z.string()).optional(),
+    date_starts: z.nullable(z.string()).optional(),
+    message: z.nullable(z.string()).optional(),
+    status: z.nullable(z.string()).optional(),
+    title: z.nullable(z.string()).optional(),
+    plain_text: z.nullable(z.string()).optional(),
+    viewed: z.nullable(z.boolean()).optional(),
+    date_viewed: z.nullable(z.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "date_added": "dateAdded",
+      "date_starts": "dateStarts",
+      "plain_text": "plainText",
+      "date_viewed": "dateViewed",
+    });
+  });
+
+/** @internal */
+export type Alert$Outbound = {
+  id?: number | undefined;
+  date_added?: string | null | undefined;
+  date_starts?: string | null | undefined;
+  message?: string | null | undefined;
+  status?: string | null | undefined;
+  title?: string | null | undefined;
+  plain_text?: string | null | undefined;
+  viewed?: boolean | null | undefined;
+  date_viewed?: string | null | undefined;
+};
+
+/** @internal */
+export const Alert$outboundSchema: z.ZodType<
+  Alert$Outbound,
+  z.ZodTypeDef,
+  Alert
+> = z.object({
+  id: z.number().int().optional(),
+  dateAdded: z.nullable(z.string()).optional(),
+  dateStarts: z.nullable(z.string()).optional(),
+  message: z.nullable(z.string()).optional(),
+  status: z.nullable(z.string()).optional(),
+  title: z.nullable(z.string()).optional(),
+  plainText: z.nullable(z.string()).optional(),
+  viewed: z.nullable(z.boolean()).optional(),
+  dateViewed: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    dateAdded: "date_added",
+    dateStarts: "date_starts",
+    plainText: "plain_text",
+    dateViewed: "date_viewed",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Alert$ {
+  /** @deprecated use `Alert$inboundSchema` instead. */
+  export const inboundSchema = Alert$inboundSchema;
+  /** @deprecated use `Alert$outboundSchema` instead. */
+  export const outboundSchema = Alert$outboundSchema;
+  /** @deprecated use `Alert$Outbound` instead. */
+  export type Outbound = Alert$Outbound;
+}
+
+export function alertToJSON(alert: Alert): string {
+  return JSON.stringify(Alert$outboundSchema.parse(alert));
+}
+
+export function alertFromJSON(
+  jsonString: string,
+): SafeParseResult<Alert, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Alert$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Alert' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -3,6 +3,7 @@
  */
 
 export * from "./activestatus.js";
+export * from "./alert.js";
 export * from "./backgroundcheckresult.js";
 export * from "./company.js";
 export * from "./companyvendortyperestriction.js";

package/src/models/operations/index.ts

@@ -39,6 +39,7 @@ export * from "./getvendorinvoicereceipt.js";
 export * from "./getvendorlegalname.js";
 export * from "./getvendorsdetails.js";
 export * from "./getwebhookendpoint.js";
+export * from "./listalerts.js";
 export * from "./listallwebhookendpoints.js";
 export * from "./listfeed.js";
 export * from "./listlocations.js";
@@ -82,6 +83,7 @@ export * from "./updateevent.js";
 export * from "./updatefhirconfigbyid.js";
 export * from "./updateinvoice.js";
 export * from "./updatesthewebhookendpointwiththegivenid.js";
+export * from "./updateuseralerts.js";
 export * from "./updatevendorcredentialdata.js";
 export * from "./updatevendorcredentialfile.js";
 export * from "./updatevendordetails.js";