@greensecurity/javascript-sdk 0.45.0-beta.14 → 0.45.0-beta.16

package/src/models/webhooks/sendfullreportcreated.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SendFullReportCreatedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportCreatedRequest$inboundSchema: z.ZodType<
+  SendFullReportCreatedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportCreatedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportCreatedRequest$outboundSchema: z.ZodType<
+  SendFullReportCreatedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportCreatedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportCreatedRequestToJSON(
+  sendFullReportCreatedRequest: SendFullReportCreatedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportCreatedRequest$outboundSchema.parse(
+      sendFullReportCreatedRequest,
+    ),
+  );
+}
+export function sendFullReportCreatedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportCreatedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportCreatedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportCreatedRequest' from JSON`,
+  );
+}

package/src/models/webhooks/sendfullreportdestroyed.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SendFullReportDestroyedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportDestroyedRequest$inboundSchema: z.ZodType<
+  SendFullReportDestroyedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportDestroyedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportDestroyedRequest$outboundSchema: z.ZodType<
+  SendFullReportDestroyedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportDestroyedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportDestroyedRequestToJSON(
+  sendFullReportDestroyedRequest: SendFullReportDestroyedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportDestroyedRequest$outboundSchema.parse(
+      sendFullReportDestroyedRequest,
+    ),
+  );
+}
+export function sendFullReportDestroyedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportDestroyedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportDestroyedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportDestroyedRequest' from JSON`,
+  );
+}

package/src/models/webhooks/sendfullreportupdated.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SendFullReportUpdatedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportUpdatedRequest$inboundSchema: z.ZodType<
+  SendFullReportUpdatedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportUpdatedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportUpdatedRequest$outboundSchema: z.ZodType<
+  SendFullReportUpdatedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportUpdatedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportUpdatedRequestToJSON(
+  sendFullReportUpdatedRequest: SendFullReportUpdatedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportUpdatedRequest$outboundSchema.parse(
+      sendFullReportUpdatedRequest,
+    ),
+  );
+}
+export function sendFullReportUpdatedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportUpdatedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportUpdatedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportUpdatedRequest' from JSON`,
+  );
+}

package/src/react-query/reportsGetFullReport.ts

@@ -72,9 +72,9 @@ export type ReportsGetFullReportQueryError =
  * | `404` | No such run, or it is outside your access scope. | Stop. |
  * | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
  *
- * **Bound your polling.** A `409` is not a promise that the run will finish. Report
- * generation has no terminal failure state today, so a run whose generation crashed part way
- * through stays in `processing` and keeps answering `409` indefinitely. Apply your own
+ * **Bound your polling.** A `409` is not a promise that the run will finish. A run that fails
+ * while generating is now recorded as `failed` and answers `422`, but a run whose worker died
+ * outright still stays in `processing` and keeps answering `409` indefinitely. Apply your own
  * timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
  *
  * Access control: the URL's `full_report_id` must be in the caller's read scope for
@@ -122,9 +122,9 @@ export function useReportsGetFullReport(
  * | `404` | No such run, or it is outside your access scope. | Stop. |
  * | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
  *
- * **Bound your polling.** A `409` is not a promise that the run will finish. Report
- * generation has no terminal failure state today, so a run whose generation crashed part way
- * through stays in `processing` and keeps answering `409` indefinitely. Apply your own
+ * **Bound your polling.** A `409` is not a promise that the run will finish. A run that fails
+ * while generating is now recorded as `failed` and answers `422`, but a run whose worker died
+ * outright still stays in `processing` and keeps answering `409` indefinitely. Apply your own
  * timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
  *
  * Access control: the URL's `full_report_id` must be in the caller's read scope for

package/src/sdk/reports.ts

@@ -62,9 +62,9 @@ export class Reports extends ClientSDK {
    * | `404` | No such run, or it is outside your access scope. | Stop. |
    * | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
    *
-   * **Bound your polling.** A `409` is not a promise that the run will finish. Report
-   * generation has no terminal failure state today, so a run whose generation crashed part way
-   * through stays in `processing` and keeps answering `409` indefinitely. Apply your own
+   * **Bound your polling.** A `409` is not a promise that the run will finish. A run that fails
+   * while generating is now recorded as `failed` and answers `422`, but a run whose worker died
+   * outright still stays in `processing` and keeps answering `409` indefinitely. Apply your own
    * timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
    *
    * Access control: the URL's `full_report_id` must be in the caller's read scope for

package/src/sdk/sdk.ts

@@ -140,6 +140,9 @@ export class GreenSecurity extends ClientSDK {
     } | Request;
     secret: string;
   }): Promise<
+    | webhooks.SendFullReportCreatedRequest
+    | webhooks.SendFullReportUpdatedRequest
+    | webhooks.SendFullReportDestroyedRequest
     | webhooks.SendVendorCreatedRequest
     | webhooks.SendVendorUpdatedRequest
     | webhooks.SendVendorDestroyedRequest