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

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.3",
   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.3 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";

package/src/models/operations/listalerts.ts

@@ -0,0 +1,234 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListAlertsRequest = {
+  /**
+   * A comma-separated list of object attributes to sort on.
+   */
+  sort?: string | null | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListAlertsResponseBody = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.Alert>;
+};
+
+export type ListAlertsResponse = {
+  result: ListAlertsResponseBody;
+};
+
+/** @internal */
+export const ListAlertsRequest$inboundSchema: z.ZodType<
+  ListAlertsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$inboundSchema.optional(),
+  page: z.number().int().optional(),
+  items_per_page: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "items_per_page": "itemsPerPage",
+  });
+});
+
+/** @internal */
+export type ListAlertsRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ListAlertsRequest$outboundSchema: z.ZodType<
+  ListAlertsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAlertsRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAlertsRequest$ {
+  /** @deprecated use `ListAlertsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAlertsRequest$inboundSchema;
+  /** @deprecated use `ListAlertsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAlertsRequest$outboundSchema;
+  /** @deprecated use `ListAlertsRequest$Outbound` instead. */
+  export type Outbound = ListAlertsRequest$Outbound;
+}
+
+export function listAlertsRequestToJSON(
+  listAlertsRequest: ListAlertsRequest,
+): string {
+  return JSON.stringify(
+    ListAlertsRequest$outboundSchema.parse(listAlertsRequest),
+  );
+}
+
+export function listAlertsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAlertsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAlertsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAlertsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListAlertsResponseBody$inboundSchema: z.ZodType<
+  ListAlertsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.Alert$inboundSchema),
+});
+
+/** @internal */
+export type ListAlertsResponseBody$Outbound = {
+  pager: components.Pager$Outbound;
+  items: Array<components.Alert$Outbound>;
+};
+
+/** @internal */
+export const ListAlertsResponseBody$outboundSchema: z.ZodType<
+  ListAlertsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListAlertsResponseBody
+> = z.object({
+  pager: components.Pager$outboundSchema,
+  items: z.array(components.Alert$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAlertsResponseBody$ {
+  /** @deprecated use `ListAlertsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListAlertsResponseBody$inboundSchema;
+  /** @deprecated use `ListAlertsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListAlertsResponseBody$outboundSchema;
+  /** @deprecated use `ListAlertsResponseBody$Outbound` instead. */
+  export type Outbound = ListAlertsResponseBody$Outbound;
+}
+
+export function listAlertsResponseBodyToJSON(
+  listAlertsResponseBody: ListAlertsResponseBody,
+): string {
+  return JSON.stringify(
+    ListAlertsResponseBody$outboundSchema.parse(listAlertsResponseBody),
+  );
+}
+
+export function listAlertsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAlertsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAlertsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAlertsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListAlertsResponse$inboundSchema: z.ZodType<
+  ListAlertsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListAlertsResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListAlertsResponse$Outbound = {
+  Result: ListAlertsResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListAlertsResponse$outboundSchema: z.ZodType<
+  ListAlertsResponse$Outbound,
+  z.ZodTypeDef,
+  ListAlertsResponse
+> = z.object({
+  result: z.lazy(() => ListAlertsResponseBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAlertsResponse$ {
+  /** @deprecated use `ListAlertsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListAlertsResponse$inboundSchema;
+  /** @deprecated use `ListAlertsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListAlertsResponse$outboundSchema;
+  /** @deprecated use `ListAlertsResponse$Outbound` instead. */
+  export type Outbound = ListAlertsResponse$Outbound;
+}
+
+export function listAlertsResponseToJSON(
+  listAlertsResponse: ListAlertsResponse,
+): string {
+  return JSON.stringify(
+    ListAlertsResponse$outboundSchema.parse(listAlertsResponse),
+  );
+}
+
+export function listAlertsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAlertsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAlertsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAlertsResponse' from JSON`,
+  );
+}

package/src/models/operations/updateuseralerts.ts

@@ -0,0 +1,140 @@
+/*
+ * 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 UpdateUserAlertsRequestBody = {
+  alertIds?: Array<number> | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type UpdateUserAlertsResponseBody = {
+  success?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateUserAlertsRequestBody$inboundSchema: z.ZodType<
+  UpdateUserAlertsRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  alert_ids: z.array(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "alert_ids": "alertIds",
+  });
+});
+
+/** @internal */
+export type UpdateUserAlertsRequestBody$Outbound = {
+  alert_ids?: Array<number> | undefined;
+};
+
+/** @internal */
+export const UpdateUserAlertsRequestBody$outboundSchema: z.ZodType<
+  UpdateUserAlertsRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateUserAlertsRequestBody
+> = z.object({
+  alertIds: z.array(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    alertIds: "alert_ids",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateUserAlertsRequestBody$ {
+  /** @deprecated use `UpdateUserAlertsRequestBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateUserAlertsRequestBody$inboundSchema;
+  /** @deprecated use `UpdateUserAlertsRequestBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateUserAlertsRequestBody$outboundSchema;
+  /** @deprecated use `UpdateUserAlertsRequestBody$Outbound` instead. */
+  export type Outbound = UpdateUserAlertsRequestBody$Outbound;
+}
+
+export function updateUserAlertsRequestBodyToJSON(
+  updateUserAlertsRequestBody: UpdateUserAlertsRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateUserAlertsRequestBody$outboundSchema.parse(
+      updateUserAlertsRequestBody,
+    ),
+  );
+}
+
+export function updateUserAlertsRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateUserAlertsRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateUserAlertsRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateUserAlertsRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateUserAlertsResponseBody$inboundSchema: z.ZodType<
+  UpdateUserAlertsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean().optional(),
+});
+
+/** @internal */
+export type UpdateUserAlertsResponseBody$Outbound = {
+  success?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateUserAlertsResponseBody$outboundSchema: z.ZodType<
+  UpdateUserAlertsResponseBody$Outbound,
+  z.ZodTypeDef,
+  UpdateUserAlertsResponseBody
+> = z.object({
+  success: z.boolean().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateUserAlertsResponseBody$ {
+  /** @deprecated use `UpdateUserAlertsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateUserAlertsResponseBody$inboundSchema;
+  /** @deprecated use `UpdateUserAlertsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateUserAlertsResponseBody$outboundSchema;
+  /** @deprecated use `UpdateUserAlertsResponseBody$Outbound` instead. */
+  export type Outbound = UpdateUserAlertsResponseBody$Outbound;
+}
+
+export function updateUserAlertsResponseBodyToJSON(
+  updateUserAlertsResponseBody: UpdateUserAlertsResponseBody,
+): string {
+  return JSON.stringify(
+    UpdateUserAlertsResponseBody$outboundSchema.parse(
+      updateUserAlertsResponseBody,
+    ),
+  );
+}
+
+export function updateUserAlertsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateUserAlertsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateUserAlertsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateUserAlertsResponseBody' from JSON`,
+  );
+}