mollie-api-typescript 0.9.5 → 0.9.6

package/src/models/listcustomerresponse.ts

@@ -0,0 +1,223 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  LocaleResponse,
+  LocaleResponse$inboundSchema,
+  LocaleResponse$outboundSchema,
+} from "./localeresponse.js";
+import {
+  Metadata,
+  Metadata$inboundSchema,
+  Metadata$Outbound,
+  Metadata$outboundSchema,
+} from "./metadata.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+import {
+  UrlNullable,
+  UrlNullable$inboundSchema,
+  UrlNullable$Outbound,
+  UrlNullable$outboundSchema,
+} from "./urlnullable.js";
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListCustomerResponseLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  dashboard: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  payments?: UrlNullable | null | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  mandates?: UrlNullable | null | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  subscriptions?: UrlNullable | null | undefined;
+};
+
+export type ListCustomerResponse = {
+  /**
+   * Indicates the response contains a customer object. Will always contain the string `customer` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this customer. Example: `cst_vsKJpSsabw`.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The full name of the customer.
+   */
+  name: string | null;
+  /**
+   * The email address of the customer.
+   */
+  email: string | null;
+  /**
+   * Allows you to preset the language to be used.
+   */
+  locale: LocaleResponse | null;
+  /**
+   * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+   *
+   * @remarks
+   * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+   */
+  metadata: Metadata | null;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListCustomerResponseLinks;
+};
+
+/** @internal */
+export const ListCustomerResponseLinks$inboundSchema: z.ZodType<
+  ListCustomerResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  dashboard: Url$inboundSchema,
+  payments: z.nullable(UrlNullable$inboundSchema).optional(),
+  mandates: z.nullable(UrlNullable$inboundSchema).optional(),
+  subscriptions: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListCustomerResponseLinks$Outbound = {
+  self: Url$Outbound;
+  dashboard: Url$Outbound;
+  payments?: UrlNullable$Outbound | null | undefined;
+  mandates?: UrlNullable$Outbound | null | undefined;
+  subscriptions?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListCustomerResponseLinks$outboundSchema: z.ZodType<
+  ListCustomerResponseLinks$Outbound,
+  z.ZodTypeDef,
+  ListCustomerResponseLinks
+> = z.object({
+  self: Url$outboundSchema,
+  dashboard: Url$outboundSchema,
+  payments: z.nullable(UrlNullable$outboundSchema).optional(),
+  mandates: z.nullable(UrlNullable$outboundSchema).optional(),
+  subscriptions: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listCustomerResponseLinksToJSON(
+  listCustomerResponseLinks: ListCustomerResponseLinks,
+): string {
+  return JSON.stringify(
+    ListCustomerResponseLinks$outboundSchema.parse(listCustomerResponseLinks),
+  );
+}
+export function listCustomerResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCustomerResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCustomerResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCustomerResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCustomerResponse$inboundSchema: z.ZodType<
+  ListCustomerResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  name: z.nullable(z.string()),
+  email: z.nullable(z.string()),
+  locale: z.nullable(LocaleResponse$inboundSchema),
+  metadata: z.nullable(Metadata$inboundSchema),
+  createdAt: z.string(),
+  _links: z.lazy(() => ListCustomerResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListCustomerResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  name: string | null;
+  email: string | null;
+  locale: string | null;
+  metadata: Metadata$Outbound | null;
+  createdAt: string;
+  _links: ListCustomerResponseLinks$Outbound;
+};
+
+/** @internal */
+export const ListCustomerResponse$outboundSchema: z.ZodType<
+  ListCustomerResponse$Outbound,
+  z.ZodTypeDef,
+  ListCustomerResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  name: z.nullable(z.string()),
+  email: z.nullable(z.string()),
+  locale: z.nullable(LocaleResponse$outboundSchema),
+  metadata: z.nullable(Metadata$outboundSchema),
+  createdAt: z.string(),
+  links: z.lazy(() => ListCustomerResponseLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listCustomerResponseToJSON(
+  listCustomerResponse: ListCustomerResponse,
+): string {
+  return JSON.stringify(
+    ListCustomerResponse$outboundSchema.parse(listCustomerResponse),
+  );
+}
+export function listCustomerResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCustomerResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCustomerResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCustomerResponse' from JSON`,
+  );
+}