@beyond-pci/sdk 1.0.0

package/src/models/operations/getv1scans.ts

@@ -0,0 +1,550 @@
+/*
+ * 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 const QueryParamStatus = {
+  Pending: "PENDING",
+  ScanInProgress: "SCAN_IN_PROGRESS",
+  RemediationRequired: "REMEDIATION_REQUIRED",
+  FinalizingReport: "FINALIZING_REPORT",
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Cancelled: "CANCELLED",
+} as const;
+export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+
+export type GetV1ScansRequest = {
+  page?: number | undefined;
+  limit?: number | undefined;
+  status?: QueryParamStatus | undefined;
+  merchantId?: string | undefined;
+};
+
+export const GetV1ScansStatus = {
+  Pending: "PENDING",
+  ScanInProgress: "SCAN_IN_PROGRESS",
+  RemediationRequired: "REMEDIATION_REQUIRED",
+  FinalizingReport: "FINALIZING_REPORT",
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Cancelled: "CANCELLED",
+} as const;
+export type GetV1ScansStatus = ClosedEnum<typeof GetV1ScansStatus>;
+
+export const Result = {
+  Passed: "PASSED",
+  Failed: "FAILED",
+} as const;
+export type Result = ClosedEnum<typeof Result>;
+
+export const GetV1ScansResult = {
+  Passed: "PASSED",
+  Failed: "FAILED",
+} as const;
+export type GetV1ScansResult = ClosedEnum<typeof GetV1ScansResult>;
+
+export type ScanTargets = {
+  id: string;
+  assetConfigId: string;
+  target: string;
+  result: GetV1ScansResult | null;
+};
+
+export type GetV1ScansData = {
+  id: string;
+  merchantId: string;
+  status: GetV1ScansStatus;
+  result: Result | null;
+  reportUrlAdmin: string | null;
+  reportUrlTech: string | null;
+  startedAt: Date | null;
+  scanCompletedAt: Date | null;
+  completedAt: Date | null;
+  scanTargets?: Array<ScanTargets> | undefined;
+};
+
+export type GetV1ScansPagination = {
+  page: number;
+  limit: number;
+  total: number;
+  hasMore: boolean;
+};
+
+export type GetV1ScansMeta = {
+  timestamp: Date;
+  pagination: GetV1ScansPagination;
+};
+
+/**
+ * Default Response
+ */
+export type GetV1ScansResponseBody = {
+  data: Array<GetV1ScansData>;
+  meta: GetV1ScansMeta;
+};
+
+/** @internal */
+export const QueryParamStatus$inboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = z.nativeEnum(QueryParamStatus);
+
+/** @internal */
+export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = QueryParamStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace QueryParamStatus$ {
+  /** @deprecated use `QueryParamStatus$inboundSchema` instead. */
+  export const inboundSchema = QueryParamStatus$inboundSchema;
+  /** @deprecated use `QueryParamStatus$outboundSchema` instead. */
+  export const outboundSchema = QueryParamStatus$outboundSchema;
+}
+
+/** @internal */
+export const GetV1ScansRequest$inboundSchema: z.ZodType<
+  GetV1ScansRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  page: z.number().int().default(1),
+  limit: z.number().int().default(20),
+  status: QueryParamStatus$inboundSchema.optional(),
+  merchantId: z.string().optional(),
+});
+
+/** @internal */
+export type GetV1ScansRequest$Outbound = {
+  page: number;
+  limit: number;
+  status?: string | undefined;
+  merchantId?: string | undefined;
+};
+
+/** @internal */
+export const GetV1ScansRequest$outboundSchema: z.ZodType<
+  GetV1ScansRequest$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansRequest
+> = z.object({
+  page: z.number().int().default(1),
+  limit: z.number().int().default(20),
+  status: QueryParamStatus$outboundSchema.optional(),
+  merchantId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansRequest$ {
+  /** @deprecated use `GetV1ScansRequest$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansRequest$inboundSchema;
+  /** @deprecated use `GetV1ScansRequest$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansRequest$outboundSchema;
+  /** @deprecated use `GetV1ScansRequest$Outbound` instead. */
+  export type Outbound = GetV1ScansRequest$Outbound;
+}
+
+export function getV1ScansRequestToJSON(
+  getV1ScansRequest: GetV1ScansRequest,
+): string {
+  return JSON.stringify(
+    GetV1ScansRequest$outboundSchema.parse(getV1ScansRequest),
+  );
+}
+
+export function getV1ScansRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansStatus$inboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansStatus
+> = z.nativeEnum(GetV1ScansStatus);
+
+/** @internal */
+export const GetV1ScansStatus$outboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansStatus
+> = GetV1ScansStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansStatus$ {
+  /** @deprecated use `GetV1ScansStatus$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansStatus$inboundSchema;
+  /** @deprecated use `GetV1ScansStatus$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansStatus$outboundSchema;
+}
+
+/** @internal */
+export const Result$inboundSchema: z.ZodNativeEnum<typeof Result> = z
+  .nativeEnum(Result);
+
+/** @internal */
+export const Result$outboundSchema: z.ZodNativeEnum<typeof Result> =
+  Result$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Result$ {
+  /** @deprecated use `Result$inboundSchema` instead. */
+  export const inboundSchema = Result$inboundSchema;
+  /** @deprecated use `Result$outboundSchema` instead. */
+  export const outboundSchema = Result$outboundSchema;
+}
+
+/** @internal */
+export const GetV1ScansResult$inboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansResult
+> = z.nativeEnum(GetV1ScansResult);
+
+/** @internal */
+export const GetV1ScansResult$outboundSchema: z.ZodNativeEnum<
+  typeof GetV1ScansResult
+> = GetV1ScansResult$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansResult$ {
+  /** @deprecated use `GetV1ScansResult$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansResult$inboundSchema;
+  /** @deprecated use `GetV1ScansResult$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansResult$outboundSchema;
+}
+
+/** @internal */
+export const ScanTargets$inboundSchema: z.ZodType<
+  ScanTargets,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  assetConfigId: z.string(),
+  target: z.string(),
+  result: z.nullable(GetV1ScansResult$inboundSchema),
+});
+
+/** @internal */
+export type ScanTargets$Outbound = {
+  id: string;
+  assetConfigId: string;
+  target: string;
+  result: string | null;
+};
+
+/** @internal */
+export const ScanTargets$outboundSchema: z.ZodType<
+  ScanTargets$Outbound,
+  z.ZodTypeDef,
+  ScanTargets
+> = z.object({
+  id: z.string(),
+  assetConfigId: z.string(),
+  target: z.string(),
+  result: z.nullable(GetV1ScansResult$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ScanTargets$ {
+  /** @deprecated use `ScanTargets$inboundSchema` instead. */
+  export const inboundSchema = ScanTargets$inboundSchema;
+  /** @deprecated use `ScanTargets$outboundSchema` instead. */
+  export const outboundSchema = ScanTargets$outboundSchema;
+  /** @deprecated use `ScanTargets$Outbound` instead. */
+  export type Outbound = ScanTargets$Outbound;
+}
+
+export function scanTargetsToJSON(scanTargets: ScanTargets): string {
+  return JSON.stringify(ScanTargets$outboundSchema.parse(scanTargets));
+}
+
+export function scanTargetsFromJSON(
+  jsonString: string,
+): SafeParseResult<ScanTargets, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScanTargets$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScanTargets' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansData$inboundSchema: z.ZodType<
+  GetV1ScansData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  merchantId: z.string(),
+  status: GetV1ScansStatus$inboundSchema,
+  result: z.nullable(Result$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(() => ScanTargets$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type GetV1ScansData$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<ScanTargets$Outbound> | undefined;
+};
+
+/** @internal */
+export const GetV1ScansData$outboundSchema: z.ZodType<
+  GetV1ScansData$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansData
+> = z.object({
+  id: z.string(),
+  merchantId: z.string(),
+  status: GetV1ScansStatus$outboundSchema,
+  result: z.nullable(Result$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(() => ScanTargets$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 GetV1ScansData$ {
+  /** @deprecated use `GetV1ScansData$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansData$inboundSchema;
+  /** @deprecated use `GetV1ScansData$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansData$outboundSchema;
+  /** @deprecated use `GetV1ScansData$Outbound` instead. */
+  export type Outbound = GetV1ScansData$Outbound;
+}
+
+export function getV1ScansDataToJSON(getV1ScansData: GetV1ScansData): string {
+  return JSON.stringify(GetV1ScansData$outboundSchema.parse(getV1ScansData));
+}
+
+export function getV1ScansDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansPagination$inboundSchema: z.ZodType<
+  GetV1ScansPagination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  page: z.number(),
+  limit: z.number(),
+  total: z.number(),
+  hasMore: z.boolean(),
+});
+
+/** @internal */
+export type GetV1ScansPagination$Outbound = {
+  page: number;
+  limit: number;
+  total: number;
+  hasMore: boolean;
+};
+
+/** @internal */
+export const GetV1ScansPagination$outboundSchema: z.ZodType<
+  GetV1ScansPagination$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansPagination
+> = 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 GetV1ScansPagination$ {
+  /** @deprecated use `GetV1ScansPagination$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansPagination$inboundSchema;
+  /** @deprecated use `GetV1ScansPagination$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansPagination$outboundSchema;
+  /** @deprecated use `GetV1ScansPagination$Outbound` instead. */
+  export type Outbound = GetV1ScansPagination$Outbound;
+}
+
+export function getV1ScansPaginationToJSON(
+  getV1ScansPagination: GetV1ScansPagination,
+): string {
+  return JSON.stringify(
+    GetV1ScansPagination$outboundSchema.parse(getV1ScansPagination),
+  );
+}
+
+export function getV1ScansPaginationFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansPagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansPagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansPagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansMeta$inboundSchema: z.ZodType<
+  GetV1ScansMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  pagination: z.lazy(() => GetV1ScansPagination$inboundSchema),
+});
+
+/** @internal */
+export type GetV1ScansMeta$Outbound = {
+  timestamp: string;
+  pagination: GetV1ScansPagination$Outbound;
+};
+
+/** @internal */
+export const GetV1ScansMeta$outboundSchema: z.ZodType<
+  GetV1ScansMeta$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansMeta
+> = z.object({
+  timestamp: z.date().transform(v => v.toISOString()),
+  pagination: z.lazy(() => GetV1ScansPagination$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansMeta$ {
+  /** @deprecated use `GetV1ScansMeta$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansMeta$inboundSchema;
+  /** @deprecated use `GetV1ScansMeta$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansMeta$outboundSchema;
+  /** @deprecated use `GetV1ScansMeta$Outbound` instead. */
+  export type Outbound = GetV1ScansMeta$Outbound;
+}
+
+export function getV1ScansMetaToJSON(getV1ScansMeta: GetV1ScansMeta): string {
+  return JSON.stringify(GetV1ScansMeta$outboundSchema.parse(getV1ScansMeta));
+}
+
+export function getV1ScansMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansMeta' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1ScansResponseBody$inboundSchema: z.ZodType<
+  GetV1ScansResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => GetV1ScansData$inboundSchema)),
+  meta: z.lazy(() => GetV1ScansMeta$inboundSchema),
+});
+
+/** @internal */
+export type GetV1ScansResponseBody$Outbound = {
+  data: Array<GetV1ScansData$Outbound>;
+  meta: GetV1ScansMeta$Outbound;
+};
+
+/** @internal */
+export const GetV1ScansResponseBody$outboundSchema: z.ZodType<
+  GetV1ScansResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetV1ScansResponseBody
+> = z.object({
+  data: z.array(z.lazy(() => GetV1ScansData$outboundSchema)),
+  meta: z.lazy(() => GetV1ScansMeta$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetV1ScansResponseBody$ {
+  /** @deprecated use `GetV1ScansResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetV1ScansResponseBody$inboundSchema;
+  /** @deprecated use `GetV1ScansResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetV1ScansResponseBody$outboundSchema;
+  /** @deprecated use `GetV1ScansResponseBody$Outbound` instead. */
+  export type Outbound = GetV1ScansResponseBody$Outbound;
+}
+
+export function getV1ScansResponseBodyToJSON(
+  getV1ScansResponseBody: GetV1ScansResponseBody,
+): string {
+  return JSON.stringify(
+    GetV1ScansResponseBody$outboundSchema.parse(getV1ScansResponseBody),
+  );
+}
+
+export function getV1ScansResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV1ScansResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV1ScansResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV1ScansResponseBody' from JSON`,
+  );
+}