mollie-api-typescript 0.9.5 → 0.9.7

package/src/models/listentitypermission.ts

@@ -0,0 +1,149 @@
+/*
+ * 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 {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityPermissionLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self?: Url | undefined;
+};
+
+export type ListEntityPermission = {
+  /**
+   * Indicates the response contains a permission object. Will always contain the string `permission` for this
+   *
+   * @remarks
+   * endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this permission. Example: `payments.read`.
+   */
+  id: string;
+  /**
+   * A short description of what kind of access the permission enables.
+   */
+  description: string;
+  /**
+   * Whether this permission is granted to the app by the organization.
+   */
+  granted: boolean;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListEntityPermissionLinks;
+};
+
+/** @internal */
+export const ListEntityPermissionLinks$inboundSchema: z.ZodType<
+  ListEntityPermissionLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema.optional(),
+});
+/** @internal */
+export type ListEntityPermissionLinks$Outbound = {
+  self?: Url$Outbound | undefined;
+};
+
+/** @internal */
+export const ListEntityPermissionLinks$outboundSchema: z.ZodType<
+  ListEntityPermissionLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityPermissionLinks
+> = z.object({
+  self: Url$outboundSchema.optional(),
+});
+
+export function listEntityPermissionLinksToJSON(
+  listEntityPermissionLinks: ListEntityPermissionLinks,
+): string {
+  return JSON.stringify(
+    ListEntityPermissionLinks$outboundSchema.parse(listEntityPermissionLinks),
+  );
+}
+export function listEntityPermissionLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityPermissionLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityPermissionLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityPermissionLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityPermission$inboundSchema: z.ZodType<
+  ListEntityPermission,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  description: z.string(),
+  granted: z.boolean(),
+  _links: z.lazy(() => ListEntityPermissionLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityPermission$Outbound = {
+  resource: string;
+  id: string;
+  description: string;
+  granted: boolean;
+  _links: ListEntityPermissionLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityPermission$outboundSchema: z.ZodType<
+  ListEntityPermission$Outbound,
+  z.ZodTypeDef,
+  ListEntityPermission
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  description: z.string(),
+  granted: z.boolean(),
+  links: z.lazy(() => ListEntityPermissionLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityPermissionToJSON(
+  listEntityPermission: ListEntityPermission,
+): string {
+  return JSON.stringify(
+    ListEntityPermission$outboundSchema.parse(listEntityPermission),
+  );
+}
+export function listEntityPermissionFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityPermission, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityPermission$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityPermission' from JSON`,
+  );
+}

package/src/models/listentityrefund.ts

@@ -0,0 +1,544 @@
+/*
+ * 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 {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.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 {
+  RefundExternalReferenceTypeResponse,
+  RefundExternalReferenceTypeResponse$inboundSchema,
+  RefundExternalReferenceTypeResponse$outboundSchema,
+} from "./refundexternalreferencetyperesponse.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.
+ *
+ * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
+ * zero.
+ *
+ * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
+ * the refund is queued the settlement amount is likely not yet available.
+ *
+ * To retrieve accurate settlement amounts we recommend using the
+ * [List balance transactions endpoint](list-balance-transactions) instead.
+ */
+export type ListEntityRefundSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+export const ListEntityRefundStatus = {
+  Queued: "queued",
+  Pending: "pending",
+  Processing: "processing",
+  Refunded: "refunded",
+  Failed: "failed",
+  Canceled: "canceled",
+} as const;
+export type ListEntityRefundStatus = OpenEnum<typeof ListEntityRefundStatus>;
+
+export type ListEntityRefundExternalReference = {
+  /**
+   * Specifies the reference type
+   */
+  type?: RefundExternalReferenceTypeResponse | undefined;
+  /**
+   * Unique reference from the payment provider
+   */
+  id?: string | undefined;
+};
+
+/**
+ * Where the funds will be pulled back from.
+ */
+export type ListEntityRefundSource = {
+  organizationId?: string | undefined;
+};
+
+export type ListEntityRefundRoutingReversal = {
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount?: Amount | undefined;
+  /**
+   * Where the funds will be pulled back from.
+   */
+  source?: ListEntityRefundSource | undefined;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityRefundLinks = {
+  /**
+   * 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 ListEntityRefund = {
+  /**
+   * Indicates the response contains a refund object. Will always contain the string `refund` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this refund. Mollie assigns this identifier at refund creation time. Mollie
+   *
+   * @remarks
+   * will always refer to the refund by this ID. Example: `re_4qqhO89gsT`.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The description of the refund that may be shown to your customer, depending on the payment method used.
+   */
+  description: 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.
+   *
+   * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
+   * zero.
+   *
+   * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
+   * the refund is queued the settlement amount is likely not yet available.
+   *
+   * To retrieve accurate settlement amounts we recommend using the
+   * [List balance transactions endpoint](list-balance-transactions) instead.
+   */
+  settlementAmount?: ListEntityRefundSettlementAmount | null | undefined;
+  /**
+   * 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 unique identifier of the payment this refund was created for.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
+  paymentId?: string | undefined;
+  /**
+   * The identifier referring to the settlement this refund was settled with. This field is omitted if the refund is not settled (yet).
+   */
+  settlementId?: string | null | undefined;
+  status: ListEntityRefundStatus;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  externalReference?: ListEntityRefundExternalReference | undefined;
+  /**
+   * *This feature is only available to marketplace operators.*
+   *
+   * @remarks
+   *
+   * When creating refunds for *routed* payments, by default the full amount is deducted from your balance.
+   *
+   * If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount
+   * needs to be reversed from which merchant(s).
+   *
+   * If you simply want to fully reverse the routed funds, you can also use the `reverseRouting` parameter instead.
+   */
+  routingReversals?: Array<ListEntityRefundRoutingReversal> | null | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListEntityRefundLinks;
+};
+
+/** @internal */
+export const ListEntityRefundSettlementAmount$inboundSchema: z.ZodType<
+  ListEntityRefundSettlementAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityRefundSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityRefundSettlementAmount$outboundSchema: z.ZodType<
+  ListEntityRefundSettlementAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundSettlementAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityRefundSettlementAmountToJSON(
+  listEntityRefundSettlementAmount: ListEntityRefundSettlementAmount,
+): string {
+  return JSON.stringify(
+    ListEntityRefundSettlementAmount$outboundSchema.parse(
+      listEntityRefundSettlementAmount,
+    ),
+  );
+}
+export function listEntityRefundSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundSettlementAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundSettlementAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundStatus$inboundSchema: z.ZodType<
+  ListEntityRefundStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListEntityRefundStatus);
+/** @internal */
+export const ListEntityRefundStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListEntityRefundStatus
+> = openEnums.outboundSchema(ListEntityRefundStatus);
+
+/** @internal */
+export const ListEntityRefundExternalReference$inboundSchema: z.ZodType<
+  ListEntityRefundExternalReference,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: RefundExternalReferenceTypeResponse$inboundSchema.optional(),
+  id: z.string().optional(),
+});
+/** @internal */
+export type ListEntityRefundExternalReference$Outbound = {
+  type?: string | undefined;
+  id?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundExternalReference$outboundSchema: z.ZodType<
+  ListEntityRefundExternalReference$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundExternalReference
+> = z.object({
+  type: RefundExternalReferenceTypeResponse$outboundSchema.optional(),
+  id: z.string().optional(),
+});
+
+export function listEntityRefundExternalReferenceToJSON(
+  listEntityRefundExternalReference: ListEntityRefundExternalReference,
+): string {
+  return JSON.stringify(
+    ListEntityRefundExternalReference$outboundSchema.parse(
+      listEntityRefundExternalReference,
+    ),
+  );
+}
+export function listEntityRefundExternalReferenceFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundExternalReference, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundExternalReference$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundExternalReference' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundSource$inboundSchema: z.ZodType<
+  ListEntityRefundSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organizationId: z.string().optional(),
+});
+/** @internal */
+export type ListEntityRefundSource$Outbound = {
+  organizationId?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundSource$outboundSchema: z.ZodType<
+  ListEntityRefundSource$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundSource
+> = z.object({
+  organizationId: z.string().optional(),
+});
+
+export function listEntityRefundSourceToJSON(
+  listEntityRefundSource: ListEntityRefundSource,
+): string {
+  return JSON.stringify(
+    ListEntityRefundSource$outboundSchema.parse(listEntityRefundSource),
+  );
+}
+export function listEntityRefundSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundSource' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundRoutingReversal$inboundSchema: z.ZodType<
+  ListEntityRefundRoutingReversal,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: Amount$inboundSchema.optional(),
+  source: z.lazy(() => ListEntityRefundSource$inboundSchema).optional(),
+});
+/** @internal */
+export type ListEntityRefundRoutingReversal$Outbound = {
+  amount?: Amount$Outbound | undefined;
+  source?: ListEntityRefundSource$Outbound | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundRoutingReversal$outboundSchema: z.ZodType<
+  ListEntityRefundRoutingReversal$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundRoutingReversal
+> = z.object({
+  amount: Amount$outboundSchema.optional(),
+  source: z.lazy(() => ListEntityRefundSource$outboundSchema).optional(),
+});
+
+export function listEntityRefundRoutingReversalToJSON(
+  listEntityRefundRoutingReversal: ListEntityRefundRoutingReversal,
+): string {
+  return JSON.stringify(
+    ListEntityRefundRoutingReversal$outboundSchema.parse(
+      listEntityRefundRoutingReversal,
+    ),
+  );
+}
+export function listEntityRefundRoutingReversalFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundRoutingReversal, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundRoutingReversal$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundRoutingReversal' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundLinks$inboundSchema: z.ZodType<
+  ListEntityRefundLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  payment: Url$inboundSchema,
+  settlement: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListEntityRefundLinks$Outbound = {
+  self: Url$Outbound;
+  payment: Url$Outbound;
+  settlement?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundLinks$outboundSchema: z.ZodType<
+  ListEntityRefundLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundLinks
+> = z.object({
+  self: Url$outboundSchema,
+  payment: Url$outboundSchema,
+  settlement: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listEntityRefundLinksToJSON(
+  listEntityRefundLinks: ListEntityRefundLinks,
+): string {
+  return JSON.stringify(
+    ListEntityRefundLinks$outboundSchema.parse(listEntityRefundLinks),
+  );
+}
+export function listEntityRefundLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefund$inboundSchema: z.ZodType<
+  ListEntityRefund,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  description: z.string(),
+  amount: Amount$inboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListEntityRefundSettlementAmount$inboundSchema),
+  ).optional(),
+  metadata: z.nullable(Metadata$inboundSchema),
+  paymentId: z.string().optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  status: ListEntityRefundStatus$inboundSchema,
+  createdAt: z.string(),
+  externalReference: z.lazy(() =>
+    ListEntityRefundExternalReference$inboundSchema
+  ).optional(),
+  routingReversals: z.nullable(
+    z.array(z.lazy(() => ListEntityRefundRoutingReversal$inboundSchema)),
+  ).optional(),
+  _links: z.lazy(() => ListEntityRefundLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityRefund$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  description: string;
+  amount: Amount$Outbound;
+  settlementAmount?:
+    | ListEntityRefundSettlementAmount$Outbound
+    | null
+    | undefined;
+  metadata: Metadata$Outbound | null;
+  paymentId?: string | undefined;
+  settlementId?: string | null | undefined;
+  status: string;
+  createdAt: string;
+  externalReference?: ListEntityRefundExternalReference$Outbound | undefined;
+  routingReversals?:
+    | Array<ListEntityRefundRoutingReversal$Outbound>
+    | null
+    | undefined;
+  _links: ListEntityRefundLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityRefund$outboundSchema: z.ZodType<
+  ListEntityRefund$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefund
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  description: z.string(),
+  amount: Amount$outboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListEntityRefundSettlementAmount$outboundSchema),
+  ).optional(),
+  metadata: z.nullable(Metadata$outboundSchema),
+  paymentId: z.string().optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  status: ListEntityRefundStatus$outboundSchema,
+  createdAt: z.string(),
+  externalReference: z.lazy(() =>
+    ListEntityRefundExternalReference$outboundSchema
+  ).optional(),
+  routingReversals: z.nullable(
+    z.array(z.lazy(() => ListEntityRefundRoutingReversal$outboundSchema)),
+  ).optional(),
+  links: z.lazy(() => ListEntityRefundLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityRefundToJSON(
+  listEntityRefund: ListEntityRefund,
+): string {
+  return JSON.stringify(
+    ListEntityRefund$outboundSchema.parse(listEntityRefund),
+  );
+}
+export function listEntityRefundFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefund, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefund$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefund' from JSON`,
+  );
+}