@beyond-pci/sdk 1.0.0

package/src/models/operations/getv1scansmerchantsidscans.ts

@@ -0,0 +1,566 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetV1ScansMerchantsIdScansRequest = {
+  page?: number | undefined;
+  limit?: number | undefined;
+  id: string;
+};
+
+export const GetV1ScansMerchantsIdScansStatus = {
+  Pending: "PENDING",
+  ScanInProgress: "SCAN_IN_PROGRESS",
+  RemediationRequired: "REMEDIATION_REQUIRED",
+  FinalizingReport: "FINALIZING_REPORT",
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Cancelled: "CANCELLED",
+} as const;
+export type GetV1ScansMerchantsIdScansStatus = ClosedEnum<
+  typeof GetV1ScansMerchantsIdScansStatus
+>;
+
+export const GetV1ScansMerchantsIdScansResult = {
+  Passed: "PASSED",
+  Failed: "FAILED",
+} as const;
+export type GetV1ScansMerchantsIdScansResult = ClosedEnum<
+  typeof GetV1ScansMerchantsIdScansResult
+>;
+
+export const GetV1ScansMerchantsIdScansScansResult = {
+  Passed: "PASSED",
+  Failed: "FAILED",
+} as const;
+export type GetV1ScansMerchantsIdScansScansResult = ClosedEnum<
+  typeof GetV1ScansMerchantsIdScansScansResult
+>;
+
+export type GetV1ScansMerchantsIdScansScanTargets = {
+  id: string;
+  assetConfigId: string;
+  target: string;
+  result: GetV1ScansMerchantsIdScansScansResult | null;
+};
+
+export type GetV1ScansMerchantsIdScansData = {
+  id: string;
+  merchantId: string;
+  status: GetV1ScansMerchantsIdScansStatus;
+  result: GetV1ScansMerchantsIdScansResult | null;
+  reportUrlAdmin: string | null;
+  reportUrlTech: string | null;
+  startedAt: Date | null;
+  scanCompletedAt: Date | null;
+  completedAt: Date | null;
+  scanTargets?: Array<GetV1ScansMerchantsIdScansScanTargets> | undefined;
+};
+
+export type GetV1ScansMerchantsIdScansPagination = {
+  page: number;
+  limit: number;
+  total: number;
+  hasMore: boolean;
+};
+
+export type GetV1ScansMerchantsIdScansMeta = {
+  timestamp: Date;
+  pagination: GetV1ScansMerchantsIdScansPagination;
+};
+
+/**
+ * Default Response
+ */
+export type GetV1ScansMerchantsIdScansResponseBody = {
+  data: Array<GetV1ScansMerchantsIdScansData>;
+  meta: GetV1ScansMerchantsIdScansMeta;
+};
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansRequest$inboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  page: z.number().int().default(1),
+  limit: z.number().int().default(20),
+  id: z.string(),
+});
+
+/** @internal */
+export type GetV1ScansMerchantsIdScansRequest$Outbound = {
+  page: number;
+  limit: number;
+  id: string;
+};
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansRequest$outboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansRequest$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansMerchantsIdScansRequest
+> = z.object({
+  page: z.number().int().default(1),
+  limit: z.number().int().default(20),
+  id: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansRequest$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansRequest$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansMerchantsIdScansRequest$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    GetV1ScansMerchantsIdScansRequest$outboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansRequest$Outbound` instead. */
+  export type Outbound = GetV1ScansMerchantsIdScansRequest$Outbound;
+}
+
+export function getV1ScansMerchantsIdScansRequestToJSON(
+  getV1ScansMerchantsIdScansRequest: GetV1ScansMerchantsIdScansRequest,
+): string {
+  return JSON.stringify(
+    GetV1ScansMerchantsIdScansRequest$outboundSchema.parse(
+      getV1ScansMerchantsIdScansRequest,
+    ),
+  );
+}
+
+export function getV1ScansMerchantsIdScansRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansMerchantsIdScansRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansMerchantsIdScansRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansMerchantsIdScansRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansStatus$inboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansMerchantsIdScansStatus
+> = z.nativeEnum(GetV1ScansMerchantsIdScansStatus);
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansStatus$outboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansMerchantsIdScansStatus
+> = GetV1ScansMerchantsIdScansStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansStatus$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansStatus$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansMerchantsIdScansStatus$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansStatus$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansMerchantsIdScansStatus$outboundSchema;
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansResult$inboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansMerchantsIdScansResult
+> = z.nativeEnum(GetV1ScansMerchantsIdScansResult);
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansResult$outboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansMerchantsIdScansResult
+> = GetV1ScansMerchantsIdScansResult$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansResult$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansResult$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansMerchantsIdScansResult$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansResult$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansMerchantsIdScansResult$outboundSchema;
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansScansResult$inboundSchema:
+  z.ZodNativeEnum<typeof GetV1ScansMerchantsIdScansScansResult> = z.nativeEnum(
+    GetV1ScansMerchantsIdScansScansResult,
+  );
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansScansResult$outboundSchema:
+  z.ZodNativeEnum<typeof GetV1ScansMerchantsIdScansScansResult> =
+    GetV1ScansMerchantsIdScansScansResult$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansScansResult$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansScansResult$inboundSchema` instead. */
+  export const inboundSchema =
+    GetV1ScansMerchantsIdScansScansResult$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansScansResult$outboundSchema` instead. */
+  export const outboundSchema =
+    GetV1ScansMerchantsIdScansScansResult$outboundSchema;
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansScanTargets$inboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansScanTargets,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  assetConfigId: z.string(),
+  target: z.string(),
+  result: z.nullable(GetV1ScansMerchantsIdScansScansResult$inboundSchema),
+});
+
+/** @internal */
+export type GetV1ScansMerchantsIdScansScanTargets$Outbound = {
+  id: string;
+  assetConfigId: string;
+  target: string;
+  result: string | null;
+};
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansScanTargets$outboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansScanTargets$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansMerchantsIdScansScanTargets
+> = z.object({
+  id: z.string(),
+  assetConfigId: z.string(),
+  target: z.string(),
+  result: z.nullable(GetV1ScansMerchantsIdScansScansResult$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansScanTargets$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansScanTargets$inboundSchema` instead. */
+  export const inboundSchema =
+    GetV1ScansMerchantsIdScansScanTargets$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansScanTargets$outboundSchema` instead. */
+  export const outboundSchema =
+    GetV1ScansMerchantsIdScansScanTargets$outboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansScanTargets$Outbound` instead. */
+  export type Outbound = GetV1ScansMerchantsIdScansScanTargets$Outbound;
+}
+
+export function getV1ScansMerchantsIdScansScanTargetsToJSON(
+  getV1ScansMerchantsIdScansScanTargets: GetV1ScansMerchantsIdScansScanTargets,
+): string {
+  return JSON.stringify(
+    GetV1ScansMerchantsIdScansScanTargets$outboundSchema.parse(
+      getV1ScansMerchantsIdScansScanTargets,
+    ),
+  );
+}
+
+export function getV1ScansMerchantsIdScansScanTargetsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansMerchantsIdScansScanTargets, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1ScansMerchantsIdScansScanTargets$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansMerchantsIdScansScanTargets' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansData$inboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  merchantId: z.string(),
+  status: GetV1ScansMerchantsIdScansStatus$inboundSchema,
+  result: z.nullable(GetV1ScansMerchantsIdScansResult$inboundSchema),
+  reportUrlAdmin: z.nullable(z.string()),
+  reportUrlTech: z.nullable(z.string()),
+  startedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  scanCompletedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  completedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  scanTargets: z.array(
+    z.lazy(() => GetV1ScansMerchantsIdScansScanTargets$inboundSchema),
+  ).optional(),
+});
+
+/** @internal */
+export type GetV1ScansMerchantsIdScansData$Outbound = {
+  id: string;
+  merchantId: string;
+  status: string;
+  result: string | null;
+  reportUrlAdmin: string | null;
+  reportUrlTech: string | null;
+  startedAt: string | null;
+  scanCompletedAt: string | null;
+  completedAt: string | null;
+  scanTargets?:
+    | Array<GetV1ScansMerchantsIdScansScanTargets$Outbound>
+    | undefined;
+};
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansData$outboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansData$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansMerchantsIdScansData
+> = z.object({
+  id: z.string(),
+  merchantId: z.string(),
+  status: GetV1ScansMerchantsIdScansStatus$outboundSchema,
+  result: z.nullable(GetV1ScansMerchantsIdScansResult$outboundSchema),
+  reportUrlAdmin: z.nullable(z.string()),
+  reportUrlTech: z.nullable(z.string()),
+  startedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  scanCompletedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  completedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  scanTargets: z.array(
+    z.lazy(() => GetV1ScansMerchantsIdScansScanTargets$outboundSchema),
+  ).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansData$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansData$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansMerchantsIdScansData$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansData$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansMerchantsIdScansData$outboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansData$Outbound` instead. */
+  export type Outbound = GetV1ScansMerchantsIdScansData$Outbound;
+}
+
+export function getV1ScansMerchantsIdScansDataToJSON(
+  getV1ScansMerchantsIdScansData: GetV1ScansMerchantsIdScansData,
+): string {
+  return JSON.stringify(
+    GetV1ScansMerchantsIdScansData$outboundSchema.parse(
+      getV1ScansMerchantsIdScansData,
+    ),
+  );
+}
+
+export function getV1ScansMerchantsIdScansDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansMerchantsIdScansData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansMerchantsIdScansData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansMerchantsIdScansData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansPagination$inboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansPagination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  page: z.number(),
+  limit: z.number(),
+  total: z.number(),
+  hasMore: z.boolean(),
+});
+
+/** @internal */
+export type GetV1ScansMerchantsIdScansPagination$Outbound = {
+  page: number;
+  limit: number;
+  total: number;
+  hasMore: boolean;
+};
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansPagination$outboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansPagination$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansMerchantsIdScansPagination
+> = z.object({
+  page: z.number(),
+  limit: z.number(),
+  total: z.number(),
+  hasMore: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansPagination$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansPagination$inboundSchema` instead. */
+  export const inboundSchema =
+    GetV1ScansMerchantsIdScansPagination$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansPagination$outboundSchema` instead. */
+  export const outboundSchema =
+    GetV1ScansMerchantsIdScansPagination$outboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansPagination$Outbound` instead. */
+  export type Outbound = GetV1ScansMerchantsIdScansPagination$Outbound;
+}
+
+export function getV1ScansMerchantsIdScansPaginationToJSON(
+  getV1ScansMerchantsIdScansPagination: GetV1ScansMerchantsIdScansPagination,
+): string {
+  return JSON.stringify(
+    GetV1ScansMerchantsIdScansPagination$outboundSchema.parse(
+      getV1ScansMerchantsIdScansPagination,
+    ),
+  );
+}
+
+export function getV1ScansMerchantsIdScansPaginationFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansMerchantsIdScansPagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1ScansMerchantsIdScansPagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansMerchantsIdScansPagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansMeta$inboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  pagination: z.lazy(() => GetV1ScansMerchantsIdScansPagination$inboundSchema),
+});
+
+/** @internal */
+export type GetV1ScansMerchantsIdScansMeta$Outbound = {
+  timestamp: string;
+  pagination: GetV1ScansMerchantsIdScansPagination$Outbound;
+};
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansMeta$outboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansMeta$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansMerchantsIdScansMeta
+> = z.object({
+  timestamp: z.date().transform(v => v.toISOString()),
+  pagination: z.lazy(() => GetV1ScansMerchantsIdScansPagination$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansMeta$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansMeta$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansMerchantsIdScansMeta$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansMeta$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansMerchantsIdScansMeta$outboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansMeta$Outbound` instead. */
+  export type Outbound = GetV1ScansMerchantsIdScansMeta$Outbound;
+}
+
+export function getV1ScansMerchantsIdScansMetaToJSON(
+  getV1ScansMerchantsIdScansMeta: GetV1ScansMerchantsIdScansMeta,
+): string {
+  return JSON.stringify(
+    GetV1ScansMerchantsIdScansMeta$outboundSchema.parse(
+      getV1ScansMerchantsIdScansMeta,
+    ),
+  );
+}
+
+export function getV1ScansMerchantsIdScansMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansMerchantsIdScansMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansMerchantsIdScansMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansMerchantsIdScansMeta' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansResponseBody$inboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => GetV1ScansMerchantsIdScansData$inboundSchema)),
+  meta: z.lazy(() => GetV1ScansMerchantsIdScansMeta$inboundSchema),
+});
+
+/** @internal */
+export type GetV1ScansMerchantsIdScansResponseBody$Outbound = {
+  data: Array<GetV1ScansMerchantsIdScansData$Outbound>;
+  meta: GetV1ScansMerchantsIdScansMeta$Outbound;
+};
+
+/** @internal */
+export const GetV1ScansMerchantsIdScansResponseBody$outboundSchema: z.ZodType<
+  GetV1ScansMerchantsIdScansResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansMerchantsIdScansResponseBody
+> = z.object({
+  data: z.array(z.lazy(() => GetV1ScansMerchantsIdScansData$outboundSchema)),
+  meta: z.lazy(() => GetV1ScansMerchantsIdScansMeta$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMerchantsIdScansResponseBody$ {
+  /** @deprecated use `GetV1ScansMerchantsIdScansResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetV1ScansMerchantsIdScansResponseBody$inboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetV1ScansMerchantsIdScansResponseBody$outboundSchema;
+  /** @deprecated use `GetV1ScansMerchantsIdScansResponseBody$Outbound` instead. */
+  export type Outbound = GetV1ScansMerchantsIdScansResponseBody$Outbound;
+}
+
+export function getV1ScansMerchantsIdScansResponseBodyToJSON(
+  getV1ScansMerchantsIdScansResponseBody:
+    GetV1ScansMerchantsIdScansResponseBody,
+): string {
+  return JSON.stringify(
+    GetV1ScansMerchantsIdScansResponseBody$outboundSchema.parse(
+      getV1ScansMerchantsIdScansResponseBody,
+    ),
+  );
+}
+
+export function getV1ScansMerchantsIdScansResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansMerchantsIdScansResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1ScansMerchantsIdScansResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansMerchantsIdScansResponseBody' from JSON`,
+  );
+}