@beyond-pci/sdk 1.0.0

package/src/sdk/assetconfigs.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { assetConfigsDeleteV1MerchantsMerchantIdAssetConfigsAssetConfigId } from "../funcs/assetConfigsDeleteV1MerchantsMerchantIdAssetConfigsAssetConfigId.js";
+import { assetConfigsGetV1MerchantsMerchantIdAssetConfigs } from "../funcs/assetConfigsGetV1MerchantsMerchantIdAssetConfigs.js";
+import { assetConfigsPostV1MerchantsMerchantIdAssetConfigs } from "../funcs/assetConfigsPostV1MerchantsMerchantIdAssetConfigs.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class AssetConfigs extends ClientSDK {
+  /**
+   * List asset configs
+   *
+   * @remarks
+   * Returns all asset configs configured for a merchant
+   */
+  async getV1MerchantsMerchantIdAssetConfigs(
+    request: operations.GetV1MerchantsMerchantIdAssetConfigsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1MerchantsMerchantIdAssetConfigsResponseBody> {
+    return unwrapAsync(assetConfigsGetV1MerchantsMerchantIdAssetConfigs(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Add asset config
+   *
+   * @remarks
+   * Adds a new URL or IP to scan for a merchant
+   */
+  async postV1MerchantsMerchantIdAssetConfigs(
+    request: operations.PostV1MerchantsMerchantIdAssetConfigsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1MerchantsMerchantIdAssetConfigsResponseBody> {
+    return unwrapAsync(assetConfigsPostV1MerchantsMerchantIdAssetConfigs(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove asset config
+   *
+   * @remarks
+   * Removes an asset config from a merchant
+   */
+  async deleteV1MerchantsMerchantIdAssetConfigsAssetConfigId(
+    request:
+      operations.DeleteV1MerchantsMerchantIdAssetConfigsAssetConfigIdRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.DeleteV1MerchantsMerchantIdAssetConfigsAssetConfigIdResponseBody
+  > {
+    return unwrapAsync(
+      assetConfigsDeleteV1MerchantsMerchantIdAssetConfigsAssetConfigId(
+        this,
+        request,
+        options,
+      ),
+    );
+  }
+}

package/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/src/sdk/merchants.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { merchantsGetV1Merchants } from "../funcs/merchantsGetV1Merchants.js";
+import { merchantsGetV1MerchantsId } from "../funcs/merchantsGetV1MerchantsId.js";
+import { merchantsGetV1MerchantsIdCompliance } from "../funcs/merchantsGetV1MerchantsIdCompliance.js";
+import { merchantsGetV1MerchantsRegistrationId } from "../funcs/merchantsGetV1MerchantsRegistrationId.js";
+import { merchantsPatchV1MerchantsId } from "../funcs/merchantsPatchV1MerchantsId.js";
+import { merchantsPostV1MerchantsIdActivate } from "../funcs/merchantsPostV1MerchantsIdActivate.js";
+import { merchantsPostV1MerchantsIdCancel } from "../funcs/merchantsPostV1MerchantsIdCancel.js";
+import { merchantsPostV1MerchantsRegister } from "../funcs/merchantsPostV1MerchantsRegister.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Merchants extends ClientSDK {
+  /**
+   * List all merchants
+   *
+   * @remarks
+   * Returns a paginated list of merchants for the authenticated tenant
+   */
+  async getV1Merchants(
+    request: operations.GetV1MerchantsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1MerchantsResponseBody> {
+    return unwrapAsync(merchantsGetV1Merchants(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get merchant details
+   *
+   * @remarks
+   * Returns details for a specific merchant
+   */
+  async getV1MerchantsId(
+    request: operations.GetV1MerchantsIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1MerchantsIdResponseBody> {
+    return unwrapAsync(merchantsGetV1MerchantsId(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update merchant
+   *
+   * @remarks
+   * Updates merchant details (scan target, frequency, contact info)
+   */
+  async patchV1MerchantsId(
+    request: operations.PatchV1MerchantsIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PatchV1MerchantsIdResponseBody> {
+    return unwrapAsync(merchantsPatchV1MerchantsId(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Register a new merchant
+   *
+   * @remarks
+   * Creates a new merchant account for PCI scanning services
+   */
+  async postV1MerchantsRegister(
+    request: operations.PostV1MerchantsRegisterRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1MerchantsRegisterResponseBody> {
+    return unwrapAsync(merchantsPostV1MerchantsRegister(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get merchant registration status
+   *
+   * @remarks
+   * Returns the current status of a merchant registration
+   */
+  async getV1MerchantsRegistrationId(
+    request: operations.GetV1MerchantsRegistrationIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1MerchantsRegistrationIdResponseBody> {
+    return unwrapAsync(merchantsGetV1MerchantsRegistrationId(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Activate merchant
+   *
+   * @remarks
+   * Activates a merchant for scanning
+   */
+  async postV1MerchantsIdActivate(
+    request: operations.PostV1MerchantsIdActivateRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1MerchantsIdActivateResponseBody> {
+    return unwrapAsync(merchantsPostV1MerchantsIdActivate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Cancel merchant
+   *
+   * @remarks
+   * Cancels a merchant subscription
+   */
+  async postV1MerchantsIdCancel(
+    request: operations.PostV1MerchantsIdCancelRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1MerchantsIdCancelResponseBody> {
+    return unwrapAsync(merchantsPostV1MerchantsIdCancel(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get merchant compliance status
+   *
+   * @remarks
+   * Returns the current SAQ and scan compliance status for a merchant
+   */
+  async getV1MerchantsIdCompliance(
+    request: operations.GetV1MerchantsIdComplianceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1MerchantsIdComplianceResponseBody> {
+    return unwrapAsync(merchantsGetV1MerchantsIdCompliance(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/saq.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { saqGetV1MerchantsMerchantIdSAQSubmissionIdPdf } from "../funcs/saqGetV1MerchantsMerchantIdSAQSubmissionIdPdf.js";
+import { saqPostV1MerchantsMerchantIdSAQLink } from "../funcs/saqPostV1MerchantsMerchantIdSAQLink.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Saq extends ClientSDK {
+  /**
+   * Download SAQ PDF
+   *
+   * @remarks
+   * Returns a signed URL to download the generated SAQ PDF. Returns 404 if the PDF has not been generated yet.
+   */
+  async getV1MerchantsMerchantIdSaqSubmissionIdPdf(
+    request: operations.GetV1MerchantsMerchantIdSaqSubmissionIdPdfRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.GetV1MerchantsMerchantIdSaqSubmissionIdPdfResponseBody
+  > {
+    return unwrapAsync(saqGetV1MerchantsMerchantIdSAQSubmissionIdPdf(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Generate SAQ access link
+   *
+   * @remarks
+   * Generates a secure, time-limited link for a merchant to access their SAQ form. If an existing pending/in-progress SAQ exists, a new token is generated for it. If no SAQ exists for the current period, a new one is created. Optionally specify returnUrl and completionAction to control post-submission behavior.
+   */
+  async postV1MerchantsMerchantIdSaqLink(
+    request: operations.PostV1MerchantsMerchantIdSaqLinkRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1MerchantsMerchantIdSaqLinkResponseBody> {
+    return unwrapAsync(saqPostV1MerchantsMerchantIdSAQLink(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/scans.ts

@@ -0,0 +1,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { scansGetV1Scans } from "../funcs/scansGetV1Scans.js";
+import { scansGetV1ScansMerchantsIdScans } from "../funcs/scansGetV1ScansMerchantsIdScans.js";
+import { scansGetV1ScansMerchantsIdScansNext } from "../funcs/scansGetV1ScansMerchantsIdScansNext.js";
+import { scansGetV1ScansScanId } from "../funcs/scansGetV1ScansScanId.js";
+import { scansGetV1ScansScanIdReport } from "../funcs/scansGetV1ScansScanIdReport.js";
+import { scansPostV1ScansMerchantsIdScans } from "../funcs/scansPostV1ScansMerchantsIdScans.js";
+import { scansPostV1ScansMerchantsIdScansCancel } from "../funcs/scansPostV1ScansMerchantsIdScansCancel.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Scans extends ClientSDK {
+  /**
+   * List all scans
+   *
+   * @remarks
+   * Returns a paginated list of scans for the authenticated tenant
+   */
+  async getV1Scans(
+    request: operations.GetV1ScansRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1ScansResponseBody> {
+    return unwrapAsync(scansGetV1Scans(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get scan details
+   *
+   * @remarks
+   * Returns details for a specific scan including targets and findings
+   */
+  async getV1ScansScanId(
+    request: operations.GetV1ScansScanIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1ScansScanIdResponseBody> {
+    return unwrapAsync(scansGetV1ScansScanId(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Download scan report
+   *
+   * @remarks
+   * Returns a signed URL to download the scan report (PDF)
+   */
+  async getV1ScansScanIdReport(
+    request: operations.GetV1ScansScanIdReportRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1ScansScanIdReportResponseBody> {
+    return unwrapAsync(scansGetV1ScansScanIdReport(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List scans for merchant
+   *
+   * @remarks
+   * Returns scan history for a specific merchant
+   */
+  async getV1ScansMerchantsIdScans(
+    request: operations.GetV1ScansMerchantsIdScansRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1ScansMerchantsIdScansResponseBody> {
+    return unwrapAsync(scansGetV1ScansMerchantsIdScans(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Trigger on-demand scan
+   *
+   * @remarks
+   * Triggers an on-demand rescan for a merchant
+   */
+  async postV1ScansMerchantsIdScans(
+    request: operations.PostV1ScansMerchantsIdScansRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1ScansMerchantsIdScansResponseBody> {
+    return unwrapAsync(scansPostV1ScansMerchantsIdScans(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get next scheduled scan
+   *
+   * @remarks
+   * Returns details about the next scheduled scan for a merchant
+   */
+  async getV1ScansMerchantsIdScansNext(
+    request: operations.GetV1ScansMerchantsIdScansNextRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1ScansMerchantsIdScansNextResponseBody> {
+    return unwrapAsync(scansGetV1ScansMerchantsIdScansNext(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Cancel running scan
+   *
+   * @remarks
+   * Cancels an in-progress scan for a merchant
+   */
+  async postV1ScansMerchantsIdScansCancel(
+    request: operations.PostV1ScansMerchantsIdScansCancelRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1ScansMerchantsIdScansCancelResponseBody> {
+    return unwrapAsync(scansPostV1ScansMerchantsIdScansCancel(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { AssetConfigs } from "./assetconfigs.js";
+import { Merchants } from "./merchants.js";
+import { Saq } from "./saq.js";
+import { Scans } from "./scans.js";
+import { Webhooks } from "./webhooks.js";
+
+export class BeyondPCI extends ClientSDK {
+  private _merchants?: Merchants;
+  get merchants(): Merchants {
+    return (this._merchants ??= new Merchants(this._options));
+  }
+
+  private _saq?: Saq;
+  get saq(): Saq {
+    return (this._saq ??= new Saq(this._options));
+  }
+
+  private _assetConfigs?: AssetConfigs;
+  get assetConfigs(): AssetConfigs {
+    return (this._assetConfigs ??= new AssetConfigs(this._options));
+  }
+
+  private _scans?: Scans;
+  get scans(): Scans {
+    return (this._scans ??= new Scans(this._options));
+  }
+
+  private _webhooks?: Webhooks;
+  get webhooks(): Webhooks {
+    return (this._webhooks ??= new Webhooks(this._options));
+  }
+}

package/src/sdk/webhooks.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { webhooksDeleteV1WebhooksId } from "../funcs/webhooksDeleteV1WebhooksId.js";
+import { webhooksGetV1Webhooks } from "../funcs/webhooksGetV1Webhooks.js";
+import { webhooksPatchV1WebhooksId } from "../funcs/webhooksPatchV1WebhooksId.js";
+import { webhooksPostV1Webhooks } from "../funcs/webhooksPostV1Webhooks.js";
+import { webhooksPostV1WebhooksIdTest } from "../funcs/webhooksPostV1WebhooksIdTest.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Webhooks extends ClientSDK {
+  /**
+   * List webhooks
+   *
+   * @remarks
+   * Returns all configured webhooks for the authenticated tenant
+   */
+  async getV1Webhooks(
+    request: operations.GetV1WebhooksRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1WebhooksResponseBody> {
+    return unwrapAsync(webhooksGetV1Webhooks(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create webhook
+   *
+   * @remarks
+   * Creates a new webhook configuration. The signing secret is returned only on creation - store it securely.
+   */
+  async postV1Webhooks(
+    request: operations.PostV1WebhooksRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1WebhooksResponseBody> {
+    return unwrapAsync(webhooksPostV1Webhooks(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update webhook
+   *
+   * @remarks
+   * Updates webhook configuration (URL, event types, active status)
+   */
+  async patchV1WebhooksId(
+    request: operations.PatchV1WebhooksIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PatchV1WebhooksIdResponseBody> {
+    return unwrapAsync(webhooksPatchV1WebhooksId(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete webhook
+   *
+   * @remarks
+   * Deletes a webhook configuration
+   */
+  async deleteV1WebhooksId(
+    request: operations.DeleteV1WebhooksIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteV1WebhooksIdResponseBody> {
+    return unwrapAsync(webhooksDeleteV1WebhooksId(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Send test webhook
+   *
+   * @remarks
+   * Sends a test webhook delivery to verify your endpoint is configured correctly using the same payload signature as production webhook events.
+   */
+  async postV1WebhooksIdTest(
+    request: operations.PostV1WebhooksIdTestRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1WebhooksIdTestResponseBody> {
+    return unwrapAsync(webhooksPostV1WebhooksIdTest(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/src/types/blobs.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
+  z.custom<Blob>(isBlobLike, {
+    message: "expected a Blob, File or Blob-like object",
+    fatal: true,
+  });
+
+export function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const name = val[Symbol.toStringTag];
+  if (typeof name !== "string") {
+    return false;
+  }
+  if (name !== "Blob" && name !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}

package/src/types/constdatetime.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function constDateTime(
+  val: string,
+): z.ZodType<string, z.ZodTypeDef, unknown> {
+  return z.custom<string>((v) => {
+    return (
+      typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
+    );
+  }, `Value must be equivalent to ${val}`);
+}

package/src/types/enums.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+declare const __brand: unique symbol;
+export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+
+export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+  return value as Unrecognized<T>;
+}
+
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+export type ClosedEnum<T> = T[keyof T];
+export type OpenEnum<T> =
+  | Prettify<T[keyof T]>
+  | Unrecognized<T[keyof T] extends number ? number : string>;