@greensecurity/javascript-sdk 0.44.0-beta.55 → 0.44.0-beta.57

package/src/models/components/webhookendpointcreate.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import {
+  WebhookConsumers,
+  WebhookConsumers$Outbound,
+  WebhookConsumers$outboundSchema,
+} from "./webhookconsumers.js";
+import {
+  WebhookSubscription,
+  WebhookSubscription$outboundSchema,
+} from "./webhooksubscription.js";
+import {
+  WebhookSubscriptionDetail,
+  WebhookSubscriptionDetail$Outbound,
+  WebhookSubscriptionDetail$outboundSchema,
+} from "./webhooksubscriptiondetail.js";
+
+export type Subscriptions1 = WebhookSubscriptionDetail | WebhookSubscription;
+
+/**
+ * The events this endpoint receives, in either of two forms, which may be mixed in
+ *
+ * @remarks
+ * one list:
+ *
+ * * an event name, `"Vendor.updated"`, which takes the request wide `expand`
+ * * an object naming a `model`, an `action` and its own `expands`
+ *
+ * A lone object may also be sent on its own. An event may only be registered once
+ * for a given URL, across every endpoint.
+ */
+export type Subscriptions =
+  | WebhookSubscriptionDetail
+  | Array<WebhookSubscriptionDetail | WebhookSubscription>;
+
+/**
+ * The webhook endpoint to register.
+ */
+export type WebhookEndpointCreate = {
+  /**
+   * The absolute HTTPS URL that receives the deliveries, including a host. It may already receive other events, but not this one.
+   */
+  webhookUrl: string;
+  /**
+   * The events this endpoint receives, in either of two forms, which may be mixed in
+   *
+   * @remarks
+   * one list:
+   *
+   * * an event name, `"Vendor.updated"`, which takes the request wide `expand`
+   * * an object naming a `model`, an `action` and its own `expands`
+   *
+   * A lone object may also be sent on its own. An event may only be registered once
+   * for a given URL, across every endpoint.
+   */
+  subscriptions:
+    | WebhookSubscriptionDetail
+    | Array<WebhookSubscriptionDetail | WebhookSubscription>;
+  /**
+   * Expansion scopes for the events of this request that do not carry `expands` of
+   *
+   * @remarks
+   * their own. Each one has to be prefixed with the snake-cased model of the event it
+   * ends up applying to.
+   */
+  expand?: Array<string> | undefined;
+  /**
+   * Which consumers receive the events of this endpoint, treated as a union (an OR over
+   *
+   * @remarks
+   * the values that are set). Only the consumers your own account reaches are accepted:
+   * a facility user may name their own facility, a system user their own system or one of
+   * its facilities, a company manager their own company, a vendor their own user, and a
+   * marketplace app anything its installations cover. Omit the object entirely and the
+   * endpoint is scoped to your own entity, or, for administrators and site-wide app
+   * installations, to every event of the site.
+   *
+   * On update the consumers are replaced as a whole: name one and the others are cleared.
+   */
+  consumers?: WebhookConsumers | undefined;
+};
+
+/** @internal */
+export type Subscriptions1$Outbound =
+  | WebhookSubscriptionDetail$Outbound
+  | string;
+
+/** @internal */
+export const Subscriptions1$outboundSchema: z.ZodType<
+  Subscriptions1$Outbound,
+  z.ZodTypeDef,
+  Subscriptions1
+> = smartUnion([
+  WebhookSubscriptionDetail$outboundSchema,
+  WebhookSubscription$outboundSchema,
+]);
+
+export function subscriptions1ToJSON(subscriptions1: Subscriptions1): string {
+  return JSON.stringify(Subscriptions1$outboundSchema.parse(subscriptions1));
+}
+
+/** @internal */
+export type Subscriptions$Outbound =
+  | WebhookSubscriptionDetail$Outbound
+  | Array<WebhookSubscriptionDetail$Outbound | string>;
+
+/** @internal */
+export const Subscriptions$outboundSchema: z.ZodType<
+  Subscriptions$Outbound,
+  z.ZodTypeDef,
+  Subscriptions
+> = smartUnion([
+  WebhookSubscriptionDetail$outboundSchema,
+  z.array(
+    smartUnion([
+      WebhookSubscriptionDetail$outboundSchema,
+      WebhookSubscription$outboundSchema,
+    ]),
+  ),
+]);
+
+export function subscriptionsToJSON(subscriptions: Subscriptions): string {
+  return JSON.stringify(Subscriptions$outboundSchema.parse(subscriptions));
+}
+
+/** @internal */
+export type WebhookEndpointCreate$Outbound = {
+  webhook_url: string;
+  subscriptions:
+    | WebhookSubscriptionDetail$Outbound
+    | Array<WebhookSubscriptionDetail$Outbound | string>;
+  expand?: Array<string> | undefined;
+  consumers?: WebhookConsumers$Outbound | undefined;
+};
+
+/** @internal */
+export const WebhookEndpointCreate$outboundSchema: z.ZodType<
+  WebhookEndpointCreate$Outbound,
+  z.ZodTypeDef,
+  WebhookEndpointCreate
+> = z.object({
+  webhookUrl: z.string(),
+  subscriptions: smartUnion([
+    WebhookSubscriptionDetail$outboundSchema,
+    z.array(
+      smartUnion([
+        WebhookSubscriptionDetail$outboundSchema,
+        WebhookSubscription$outboundSchema,
+      ]),
+    ),
+  ]),
+  expand: z.array(z.string()).optional(),
+  consumers: WebhookConsumers$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    webhookUrl: "webhook_url",
+  });
+});
+
+export function webhookEndpointCreateToJSON(
+  webhookEndpointCreate: WebhookEndpointCreate,
+): string {
+  return JSON.stringify(
+    WebhookEndpointCreate$outboundSchema.parse(webhookEndpointCreate),
+  );
+}

package/src/models/components/webhookendpointupdate.ts

@@ -0,0 +1,177 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import {
+  WebhookConsumers,
+  WebhookConsumers$Outbound,
+  WebhookConsumers$outboundSchema,
+} from "./webhookconsumers.js";
+import {
+  WebhookSubscription,
+  WebhookSubscription$outboundSchema,
+} from "./webhooksubscription.js";
+import {
+  WebhookSubscriptionDetail,
+  WebhookSubscriptionDetail$Outbound,
+  WebhookSubscriptionDetail$outboundSchema,
+} from "./webhooksubscriptiondetail.js";
+
+export type WebhookEndpointUpdateSubscriptions1 =
+  | WebhookSubscriptionDetail
+  | WebhookSubscription;
+
+/**
+ * Replaces every event this endpoint receives, in the same forms `POST /webhooks`
+ *
+ * @remarks
+ * accepts. Events that are not listed again are dropped, together with their
+ * scopes.
+ */
+export type WebhookEndpointUpdateSubscriptions =
+  | WebhookSubscriptionDetail
+  | Array<WebhookSubscriptionDetail | WebhookSubscription>;
+
+/**
+ * The properties of the webhook endpoint to change. Anything omitted is left as it is.
+ */
+export type WebhookEndpointUpdate = {
+  /**
+   * The absolute HTTPS URL that receives the deliveries, including a host. It may already receive other events, but not this one.
+   */
+  webhookUrl?: string | undefined;
+  /**
+   * Replaces every event this endpoint receives, in the same forms `POST /webhooks`
+   *
+   * @remarks
+   * accepts. Events that are not listed again are dropped, together with their
+   * scopes.
+   */
+  subscriptions?:
+    | WebhookSubscriptionDetail
+    | Array<WebhookSubscriptionDetail | WebhookSubscription>
+    | undefined;
+  /**
+   * Expansion scopes for the events of this request that do not carry `expands` of
+   *
+   * @remarks
+   * their own. On its own, without `subscriptions`, it re-scopes every event the
+   * endpoint already receives; an empty array clears their scopes.
+   */
+  expand?: Array<string> | undefined;
+  /**
+   * Which consumers receive the events of this endpoint, treated as a union (an OR over
+   *
+   * @remarks
+   * the values that are set). Only the consumers your own account reaches are accepted:
+   * a facility user may name their own facility, a system user their own system or one of
+   * its facilities, a company manager their own company, a vendor their own user, and a
+   * marketplace app anything its installations cover. Omit the object entirely and the
+   * endpoint is scoped to your own entity, or, for administrators and site-wide app
+   * installations, to every event of the site.
+   *
+   * On update the consumers are replaced as a whole: name one and the others are cleared.
+   */
+  consumers?: WebhookConsumers | undefined;
+};
+
+/** @internal */
+export type WebhookEndpointUpdateSubscriptions1$Outbound =
+  | WebhookSubscriptionDetail$Outbound
+  | string;
+
+/** @internal */
+export const WebhookEndpointUpdateSubscriptions1$outboundSchema: z.ZodType<
+  WebhookEndpointUpdateSubscriptions1$Outbound,
+  z.ZodTypeDef,
+  WebhookEndpointUpdateSubscriptions1
+> = smartUnion([
+  WebhookSubscriptionDetail$outboundSchema,
+  WebhookSubscription$outboundSchema,
+]);
+
+export function webhookEndpointUpdateSubscriptions1ToJSON(
+  webhookEndpointUpdateSubscriptions1: WebhookEndpointUpdateSubscriptions1,
+): string {
+  return JSON.stringify(
+    WebhookEndpointUpdateSubscriptions1$outboundSchema.parse(
+      webhookEndpointUpdateSubscriptions1,
+    ),
+  );
+}
+
+/** @internal */
+export type WebhookEndpointUpdateSubscriptions$Outbound =
+  | WebhookSubscriptionDetail$Outbound
+  | Array<WebhookSubscriptionDetail$Outbound | string>;
+
+/** @internal */
+export const WebhookEndpointUpdateSubscriptions$outboundSchema: z.ZodType<
+  WebhookEndpointUpdateSubscriptions$Outbound,
+  z.ZodTypeDef,
+  WebhookEndpointUpdateSubscriptions
+> = smartUnion([
+  WebhookSubscriptionDetail$outboundSchema,
+  z.array(
+    smartUnion([
+      WebhookSubscriptionDetail$outboundSchema,
+      WebhookSubscription$outboundSchema,
+    ]),
+  ),
+]);
+
+export function webhookEndpointUpdateSubscriptionsToJSON(
+  webhookEndpointUpdateSubscriptions: WebhookEndpointUpdateSubscriptions,
+): string {
+  return JSON.stringify(
+    WebhookEndpointUpdateSubscriptions$outboundSchema.parse(
+      webhookEndpointUpdateSubscriptions,
+    ),
+  );
+}
+
+/** @internal */
+export type WebhookEndpointUpdate$Outbound = {
+  webhook_url?: string | undefined;
+  subscriptions?:
+    | WebhookSubscriptionDetail$Outbound
+    | Array<WebhookSubscriptionDetail$Outbound | string>
+    | undefined;
+  expand?: Array<string> | undefined;
+  consumers?: WebhookConsumers$Outbound | undefined;
+};
+
+/** @internal */
+export const WebhookEndpointUpdate$outboundSchema: z.ZodType<
+  WebhookEndpointUpdate$Outbound,
+  z.ZodTypeDef,
+  WebhookEndpointUpdate
+> = z.object({
+  webhookUrl: z.string().optional(),
+  subscriptions: smartUnion([
+    WebhookSubscriptionDetail$outboundSchema,
+    z.array(
+      smartUnion([
+        WebhookSubscriptionDetail$outboundSchema,
+        WebhookSubscription$outboundSchema,
+      ]),
+    ),
+  ]).optional(),
+  expand: z.array(z.string()).optional(),
+  consumers: WebhookConsumers$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    webhookUrl: "webhook_url",
+  });
+});
+
+export function webhookEndpointUpdateToJSON(
+  webhookEndpointUpdate: WebhookEndpointUpdate,
+): string {
+  return JSON.stringify(
+    WebhookEndpointUpdate$outboundSchema.parse(webhookEndpointUpdate),
+  );
+}

package/src/models/components/webhooksubscription.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * An event, named `<Entity>.<action>`. Green Security delivers the `created`, `updated`
+ *
+ * @remarks
+ * and `destroyed` lifecycle of every entity that supports webhooks.
+ */
+export const WebhookSubscription = {
+  TargetFacilityStatusChangeCreated: "TargetFacilityStatusChange.created",
+  TargetFacilityStatusChangeUpdated: "TargetFacilityStatusChange.updated",
+  TargetFacilityStatusChangeDestroyed: "TargetFacilityStatusChange.destroyed",
+  VendorCreated: "Vendor.created",
+  VendorUpdated: "Vendor.updated",
+  VendorDestroyed: "Vendor.destroyed",
+  VendorScanCreated: "VendorScan.created",
+  VendorScanUpdated: "VendorScan.updated",
+  VendorScanDestroyed: "VendorScan.destroyed",
+  VisitorCheckinCreated: "VisitorCheckin.created",
+  VisitorCheckinUpdated: "VisitorCheckin.updated",
+  VisitorCheckinDestroyed: "VisitorCheckin.destroyed",
+} as const;
+/**
+ * An event, named `<Entity>.<action>`. Green Security delivers the `created`, `updated`
+ *
+ * @remarks
+ * and `destroyed` lifecycle of every entity that supports webhooks.
+ */
+export type WebhookSubscription = ClosedEnum<typeof WebhookSubscription>;
+
+/** @internal */
+export const WebhookSubscription$outboundSchema: z.ZodNativeEnum<
+  typeof WebhookSubscription
+> = z.nativeEnum(WebhookSubscription);

package/src/models/components/webhooksubscriptiondetail.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } 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";
+
+/**
+ * The entity the event is about.
+ */
+export const Model = {
+  TargetFacilityStatusChange: "TargetFacilityStatusChange",
+  Vendor: "Vendor",
+  VendorScan: "VendorScan",
+  VisitorCheckin: "VisitorCheckin",
+} as const;
+/**
+ * The entity the event is about.
+ */
+export type Model = OpenEnum<typeof Model>;
+
+/**
+ * The lifecycle action.
+ */
+export const Action = {
+  Created: "created",
+  Updated: "updated",
+  Destroyed: "destroyed",
+} as const;
+/**
+ * The lifecycle action.
+ */
+export type Action = OpenEnum<typeof Action>;
+
+/**
+ * One event and the expansion scopes that shape its payload. Sending subscriptions in
+ *
+ * @remarks
+ * this form is what lets each event carry its own scopes.
+ */
+export type WebhookSubscriptionDetail = {
+  /**
+   * The entity the event is about.
+   */
+  model: Model;
+  /**
+   * The lifecycle action.
+   */
+  action: Action;
+  /**
+   * The expansion scopes for this event, as a comma separated list, exactly as the
+   *
+   * @remarks
+   * `expand` query parameter works on the REST endpoints. Without them the payload
+   * carries the default representation of the entity, where related objects appear as
+   * ids rather than as objects.
+   *
+   * Every scope has to be prefixed with the snake-cased model of its own event
+   * (`vendor.` for `Vendor.*`, `target_facility_status_change.` for
+   * `TargetFacilityStatusChange.*`); a scope naming any other entity is rejected. See
+   * the `expand` query parameter for the scopes each entity supports. A well-formed
+   * scope the entity does not support is ignored.
+   *
+   * An empty string means no scopes, and overrides the request wide `expand`.
+   */
+  expands?: string | undefined;
+};
+
+/** @internal */
+export const Model$inboundSchema: z.ZodType<Model, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Model);
+/** @internal */
+export const Model$outboundSchema: z.ZodType<string, z.ZodTypeDef, Model> =
+  openEnums.outboundSchema(Model);
+
+/** @internal */
+export const Action$inboundSchema: z.ZodType<Action, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Action);
+/** @internal */
+export const Action$outboundSchema: z.ZodType<string, z.ZodTypeDef, Action> =
+  openEnums.outboundSchema(Action);
+
+/** @internal */
+export const WebhookSubscriptionDetail$inboundSchema: z.ZodType<
+  WebhookSubscriptionDetail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: Model$inboundSchema,
+  action: Action$inboundSchema,
+  expands: types.optional(types.string()),
+});
+/** @internal */
+export type WebhookSubscriptionDetail$Outbound = {
+  model: string;
+  action: string;
+  expands?: string | undefined;
+};
+
+/** @internal */
+export const WebhookSubscriptionDetail$outboundSchema: z.ZodType<
+  WebhookSubscriptionDetail$Outbound,
+  z.ZodTypeDef,
+  WebhookSubscriptionDetail
+> = z.object({
+  model: Model$outboundSchema,
+  action: Action$outboundSchema,
+  expands: z.string().optional(),
+});
+
+export function webhookSubscriptionDetailToJSON(
+  webhookSubscriptionDetail: WebhookSubscriptionDetail,
+): string {
+  return JSON.stringify(
+    WebhookSubscriptionDetail$outboundSchema.parse(webhookSubscriptionDetail),
+  );
+}
+export function webhookSubscriptionDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookSubscriptionDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookSubscriptionDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookSubscriptionDetail' from JSON`,
+  );
+}