mollie-api-typescript 0.8.6 → 0.9.0

package/src/models/listcaptureresponse.ts

@@ -0,0 +1,361 @@
+/*
+ * 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 * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  AmountNullable,
+  AmountNullable$inboundSchema,
+  AmountNullable$Outbound,
+  AmountNullable$outboundSchema,
+} from "./amountnullable.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.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";
+
+/**
+ * This optional field will contain the approximate amount that will be settled to your account, converted to the
+ *
+ * @remarks
+ * currency your account is settled in.
+ *
+ * Since the field contains an estimated amount during capture processing, it may change over time. To retrieve
+ * accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions)
+ * instead.
+ */
+export type ListCaptureResponseSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The capture's status.
+ */
+export const ListCaptureResponseStatus = {
+  Pending: "pending",
+  Succeeded: "succeeded",
+  Failed: "failed",
+} as const;
+/**
+ * The capture's status.
+ */
+export type ListCaptureResponseStatus = OpenEnum<
+  typeof ListCaptureResponseStatus
+>;
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListCaptureResponseLinks = {
+  /**
+   * 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.
+   */
+  payment: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  settlement?: UrlNullable | null | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  shipment?: UrlNullable | null | undefined;
+};
+
+export type ListCaptureResponse = {
+  /**
+   * Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this capture. Example: `cpt_mNepDkEtco6ah3QNPUGYH`.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The description of the capture.
+   */
+  description?: string | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: AmountNullable | null;
+  /**
+   * This optional field will contain the approximate amount that will be settled to your account, converted to the
+   *
+   * @remarks
+   * currency your account is settled in.
+   *
+   * Since the field contains an estimated amount during capture processing, it may change over time. To retrieve
+   * accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions)
+   * instead.
+   */
+  settlementAmount?: ListCaptureResponseSettlementAmount | null | undefined;
+  status: ListCaptureResponseStatus;
+  /**
+   * 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 | undefined;
+  /**
+   * The unique identifier of the payment this capture was created for. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
+  paymentId: string;
+  /**
+   * The unique identifier of the shipment that triggered the creation of this capture, if applicable. For example:
+   *
+   * @remarks
+   * `shp_gNapNy9qQTUFZYnCrCF7J`.
+   */
+  shipmentId?: string | null | undefined;
+  /**
+   * The identifier referring to the settlement this capture was settled with. For example, `stl_BkEjN2eBb`. This field
+   *
+   * @remarks
+   * is omitted if the capture is not settled (yet).
+   */
+  settlementId?: string | null | undefined;
+  /**
+   * 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: ListCaptureResponseLinks;
+};
+
+/** @internal */
+export const ListCaptureResponseSettlementAmount$inboundSchema: z.ZodType<
+  ListCaptureResponseSettlementAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListCaptureResponseSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListCaptureResponseSettlementAmount$outboundSchema: z.ZodType<
+  ListCaptureResponseSettlementAmount$Outbound,
+  z.ZodTypeDef,
+  ListCaptureResponseSettlementAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listCaptureResponseSettlementAmountToJSON(
+  listCaptureResponseSettlementAmount: ListCaptureResponseSettlementAmount,
+): string {
+  return JSON.stringify(
+    ListCaptureResponseSettlementAmount$outboundSchema.parse(
+      listCaptureResponseSettlementAmount,
+    ),
+  );
+}
+export function listCaptureResponseSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCaptureResponseSettlementAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCaptureResponseSettlementAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCaptureResponseSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCaptureResponseStatus$inboundSchema: z.ZodType<
+  ListCaptureResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListCaptureResponseStatus);
+/** @internal */
+export const ListCaptureResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListCaptureResponseStatus
+> = openEnums.outboundSchema(ListCaptureResponseStatus);
+
+/** @internal */
+export const ListCaptureResponseLinks$inboundSchema: z.ZodType<
+  ListCaptureResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  payment: Url$inboundSchema,
+  settlement: z.nullable(UrlNullable$inboundSchema).optional(),
+  shipment: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListCaptureResponseLinks$Outbound = {
+  self: Url$Outbound;
+  payment: Url$Outbound;
+  settlement?: UrlNullable$Outbound | null | undefined;
+  shipment?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListCaptureResponseLinks$outboundSchema: z.ZodType<
+  ListCaptureResponseLinks$Outbound,
+  z.ZodTypeDef,
+  ListCaptureResponseLinks
+> = z.object({
+  self: Url$outboundSchema,
+  payment: Url$outboundSchema,
+  settlement: z.nullable(UrlNullable$outboundSchema).optional(),
+  shipment: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listCaptureResponseLinksToJSON(
+  listCaptureResponseLinks: ListCaptureResponseLinks,
+): string {
+  return JSON.stringify(
+    ListCaptureResponseLinks$outboundSchema.parse(listCaptureResponseLinks),
+  );
+}
+export function listCaptureResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCaptureResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCaptureResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCaptureResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCaptureResponse$inboundSchema: z.ZodType<
+  ListCaptureResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  description: z.string().optional(),
+  amount: z.nullable(AmountNullable$inboundSchema),
+  settlementAmount: z.nullable(
+    z.lazy(() => ListCaptureResponseSettlementAmount$inboundSchema),
+  ).optional(),
+  status: ListCaptureResponseStatus$inboundSchema,
+  metadata: z.nullable(Metadata$inboundSchema).optional(),
+  paymentId: z.string(),
+  shipmentId: z.nullable(z.string()).optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  _links: z.lazy(() => ListCaptureResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListCaptureResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  description?: string | undefined;
+  amount: AmountNullable$Outbound | null;
+  settlementAmount?:
+    | ListCaptureResponseSettlementAmount$Outbound
+    | null
+    | undefined;
+  status: string;
+  metadata?: Metadata$Outbound | null | undefined;
+  paymentId: string;
+  shipmentId?: string | null | undefined;
+  settlementId?: string | null | undefined;
+  createdAt: string;
+  _links: ListCaptureResponseLinks$Outbound;
+};
+
+/** @internal */
+export const ListCaptureResponse$outboundSchema: z.ZodType<
+  ListCaptureResponse$Outbound,
+  z.ZodTypeDef,
+  ListCaptureResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  description: z.string().optional(),
+  amount: z.nullable(AmountNullable$outboundSchema),
+  settlementAmount: z.nullable(
+    z.lazy(() => ListCaptureResponseSettlementAmount$outboundSchema),
+  ).optional(),
+  status: ListCaptureResponseStatus$outboundSchema,
+  metadata: z.nullable(Metadata$outboundSchema).optional(),
+  paymentId: z.string(),
+  shipmentId: z.nullable(z.string()).optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  links: z.lazy(() => ListCaptureResponseLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listCaptureResponseToJSON(
+  listCaptureResponse: ListCaptureResponse,
+): string {
+  return JSON.stringify(
+    ListCaptureResponse$outboundSchema.parse(listCaptureResponse),
+  );
+}
+export function listCaptureResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCaptureResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCaptureResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCaptureResponse' from JSON`,
+  );
+}

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`,
+  );
+}