mollie-api-typescript 0.9.5 → 0.9.6

package/src/models/listentitychargeback.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 { Result as SafeParseResult } from "../types/fp.js";
+import {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.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 deducted from your account balance, converted
+ *
+ * @remarks
+ * to the currency your account is settled in.
+ *
+ * The amount is a **negative** amount.
+ *
+ * Since the field contains an estimated amount during chargeback 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 ListEntityChargebackSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * Reason for the chargeback as given by the bank. Only available for chargebacks of SEPA Direct Debit payments.
+ */
+export type ListEntityChargebackReason = {
+  /**
+   * Technical code provided by the bank.
+   */
+  code: string;
+  /**
+   * A more detailed human-friendly description.
+   */
+  description: string;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityChargebackLinks = {
+  /**
+   * 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;
+};
+
+export type ListEntityChargeback = {
+  /**
+   * Indicates the response contains a chargeback object. Will always contain the string `chargeback` for this
+   *
+   * @remarks
+   * endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this chargeback. Example: `chb_n9z0tp`.
+   */
+  id: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+   *
+   * @remarks
+   * to the currency your account is settled in.
+   *
+   * The amount is a **negative** amount.
+   *
+   * Since the field contains an estimated amount during chargeback processing, it may change over time. To retrieve
+   * accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions)
+   * instead.
+   */
+  settlementAmount?: ListEntityChargebackSettlementAmount | null | undefined;
+  /**
+   * Reason for the chargeback as given by the bank. Only available for chargebacks of SEPA Direct Debit payments.
+   */
+  reason?: ListEntityChargebackReason | null | undefined;
+  /**
+   * The unique identifier of the payment this chargeback 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 identifier referring to the settlement this payment was settled with. For example, `stl_BkEjN2eBb`. This field
+   *
+   * @remarks
+   * is omitted if the refund 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;
+  /**
+   * The date and time the chargeback was reversed if applicable, in
+   *
+   * @remarks
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  reversedAt?: string | null | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListEntityChargebackLinks;
+};
+
+/** @internal */
+export const ListEntityChargebackSettlementAmount$inboundSchema: z.ZodType<
+  ListEntityChargebackSettlementAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityChargebackSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityChargebackSettlementAmount$outboundSchema: z.ZodType<
+  ListEntityChargebackSettlementAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityChargebackSettlementAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityChargebackSettlementAmountToJSON(
+  listEntityChargebackSettlementAmount: ListEntityChargebackSettlementAmount,
+): string {
+  return JSON.stringify(
+    ListEntityChargebackSettlementAmount$outboundSchema.parse(
+      listEntityChargebackSettlementAmount,
+    ),
+  );
+}
+export function listEntityChargebackSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityChargebackSettlementAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityChargebackSettlementAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityChargebackSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityChargebackReason$inboundSchema: z.ZodType<
+  ListEntityChargebackReason,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  description: z.string(),
+});
+/** @internal */
+export type ListEntityChargebackReason$Outbound = {
+  code: string;
+  description: string;
+};
+
+/** @internal */
+export const ListEntityChargebackReason$outboundSchema: z.ZodType<
+  ListEntityChargebackReason$Outbound,
+  z.ZodTypeDef,
+  ListEntityChargebackReason
+> = z.object({
+  code: z.string(),
+  description: z.string(),
+});
+
+export function listEntityChargebackReasonToJSON(
+  listEntityChargebackReason: ListEntityChargebackReason,
+): string {
+  return JSON.stringify(
+    ListEntityChargebackReason$outboundSchema.parse(listEntityChargebackReason),
+  );
+}
+export function listEntityChargebackReasonFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityChargebackReason, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityChargebackReason$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityChargebackReason' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityChargebackLinks$inboundSchema: z.ZodType<
+  ListEntityChargebackLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  payment: Url$inboundSchema,
+  settlement: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListEntityChargebackLinks$Outbound = {
+  self: Url$Outbound;
+  payment: Url$Outbound;
+  settlement?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListEntityChargebackLinks$outboundSchema: z.ZodType<
+  ListEntityChargebackLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityChargebackLinks
+> = z.object({
+  self: Url$outboundSchema,
+  payment: Url$outboundSchema,
+  settlement: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listEntityChargebackLinksToJSON(
+  listEntityChargebackLinks: ListEntityChargebackLinks,
+): string {
+  return JSON.stringify(
+    ListEntityChargebackLinks$outboundSchema.parse(listEntityChargebackLinks),
+  );
+}
+export function listEntityChargebackLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityChargebackLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityChargebackLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityChargebackLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityChargeback$inboundSchema: z.ZodType<
+  ListEntityChargeback,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  amount: Amount$inboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListEntityChargebackSettlementAmount$inboundSchema),
+  ).optional(),
+  reason: z.nullable(z.lazy(() => ListEntityChargebackReason$inboundSchema))
+    .optional(),
+  paymentId: z.string(),
+  settlementId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  reversedAt: z.nullable(z.string()).optional(),
+  _links: z.lazy(() => ListEntityChargebackLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityChargeback$Outbound = {
+  resource: string;
+  id: string;
+  amount: Amount$Outbound;
+  settlementAmount?:
+    | ListEntityChargebackSettlementAmount$Outbound
+    | null
+    | undefined;
+  reason?: ListEntityChargebackReason$Outbound | null | undefined;
+  paymentId: string;
+  settlementId?: string | null | undefined;
+  createdAt: string;
+  reversedAt?: string | null | undefined;
+  _links: ListEntityChargebackLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityChargeback$outboundSchema: z.ZodType<
+  ListEntityChargeback$Outbound,
+  z.ZodTypeDef,
+  ListEntityChargeback
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  amount: Amount$outboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListEntityChargebackSettlementAmount$outboundSchema),
+  ).optional(),
+  reason: z.nullable(z.lazy(() => ListEntityChargebackReason$outboundSchema))
+    .optional(),
+  paymentId: z.string(),
+  settlementId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  reversedAt: z.nullable(z.string()).optional(),
+  links: z.lazy(() => ListEntityChargebackLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityChargebackToJSON(
+  listEntityChargeback: ListEntityChargeback,
+): string {
+  return JSON.stringify(
+    ListEntityChargeback$outboundSchema.parse(listEntityChargeback),
+  );
+}
+export function listEntityChargebackFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityChargeback, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityChargeback$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityChargeback' from JSON`,
+  );
+}