mollie-api-typescript 1.2.2 → 1.2.4

package/src/models/sessionlineitem.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  PaymentLineTypeResponse,
+  PaymentLineTypeResponse$inboundSchema,
+  PaymentLineTypeResponse$outboundSchema,
+} from "./paymentlinetyperesponse.js";
+
+export type SessionLineItem = {
+  /**
+   * The type of product purchased. For example, a physical or a digital product.
+   *
+   * @remarks
+   *
+   * The `tip` payment line type is not available when creating a payment.
+   */
+  type?: PaymentLineTypeResponse | undefined;
+  /**
+   * A description of the line item. For example *LEGO 4440 Forest Police Station*.
+   */
+  description: string;
+  /**
+   * The number of items.
+   */
+  quantity: number;
+  /**
+   * The unit for the quantity. For example *pcs*, *kg*, or *cm*.
+   */
+  quantityUnit?: string | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  unitPrice: Amount;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  discountAmount?: Amount | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  totalAmount: Amount;
+  /**
+   * The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and
+   *
+   * @remarks
+   * not as a float, to ensure the correct number of decimals are passed.
+   */
+  vatRate?: string | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  vatAmount?: Amount | undefined;
+  /**
+   * The SKU, EAN, ISBN or UPC of the product sold.
+   */
+  sku?: string | undefined;
+  /**
+   * A link pointing to an image of the product sold.
+   */
+  imageUrl?: string | undefined;
+  /**
+   * A link pointing to the product page in your web shop of the product sold.
+   */
+  productUrl?: string | undefined;
+};
+
+/** @internal */
+export const SessionLineItem$inboundSchema: z.ZodType<
+  SessionLineItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PaymentLineTypeResponse$inboundSchema.optional(),
+  description: z.string(),
+  quantity: z.number().int(),
+  quantityUnit: z.string().optional(),
+  unitPrice: Amount$inboundSchema,
+  discountAmount: Amount$inboundSchema.optional(),
+  totalAmount: Amount$inboundSchema,
+  vatRate: z.string().optional(),
+  vatAmount: Amount$inboundSchema.optional(),
+  sku: z.string().optional(),
+  imageUrl: z.string().optional(),
+  productUrl: z.string().optional(),
+});
+/** @internal */
+export type SessionLineItem$Outbound = {
+  type?: string | undefined;
+  description: string;
+  quantity: number;
+  quantityUnit?: string | undefined;
+  unitPrice: Amount$Outbound;
+  discountAmount?: Amount$Outbound | undefined;
+  totalAmount: Amount$Outbound;
+  vatRate?: string | undefined;
+  vatAmount?: Amount$Outbound | undefined;
+  sku?: string | undefined;
+  imageUrl?: string | undefined;
+  productUrl?: string | undefined;
+};
+
+/** @internal */
+export const SessionLineItem$outboundSchema: z.ZodType<
+  SessionLineItem$Outbound,
+  z.ZodTypeDef,
+  SessionLineItem
+> = z.object({
+  type: PaymentLineTypeResponse$outboundSchema.optional(),
+  description: z.string(),
+  quantity: z.number().int(),
+  quantityUnit: z.string().optional(),
+  unitPrice: Amount$outboundSchema,
+  discountAmount: Amount$outboundSchema.optional(),
+  totalAmount: Amount$outboundSchema,
+  vatRate: z.string().optional(),
+  vatAmount: Amount$outboundSchema.optional(),
+  sku: z.string().optional(),
+  imageUrl: z.string().optional(),
+  productUrl: z.string().optional(),
+});
+
+export function sessionLineItemToJSON(
+  sessionLineItem: SessionLineItem,
+): string {
+  return JSON.stringify(SessionLineItem$outboundSchema.parse(sessionLineItem));
+}
+export function sessionLineItemFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionLineItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionLineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionLineItem' from JSON`,
+  );
+}

package/src/models/sessionlineitemresponse.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  PaymentLineTypeResponse,
+  PaymentLineTypeResponse$inboundSchema,
+  PaymentLineTypeResponse$outboundSchema,
+} from "./paymentlinetyperesponse.js";
+
+export type SessionLineItemResponse = {
+  /**
+   * The type of product purchased. For example, a physical or a digital product.
+   *
+   * @remarks
+   *
+   * The `tip` payment line type is not available when creating a payment.
+   */
+  type?: PaymentLineTypeResponse | undefined;
+  /**
+   * A description of the line item. For example *LEGO 4440 Forest Police Station*.
+   */
+  description: string;
+  /**
+   * The number of items.
+   */
+  quantity: number;
+  /**
+   * The unit for the quantity. For example *pcs*, *kg*, or *cm*.
+   */
+  quantityUnit?: string | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  unitPrice: Amount;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  discountAmount?: Amount | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  totalAmount: Amount;
+  /**
+   * The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and
+   *
+   * @remarks
+   * not as a float, to ensure the correct number of decimals are passed.
+   */
+  vatRate?: string | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  vatAmount?: Amount | undefined;
+  /**
+   * The SKU, EAN, ISBN or UPC of the product sold.
+   */
+  sku?: string | undefined;
+  /**
+   * A link pointing to an image of the product sold.
+   */
+  imageUrl?: string | undefined;
+  /**
+   * A link pointing to the product page in your web shop of the product sold.
+   */
+  productUrl?: string | undefined;
+};
+
+/** @internal */
+export const SessionLineItemResponse$inboundSchema: z.ZodType<
+  SessionLineItemResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PaymentLineTypeResponse$inboundSchema.optional(),
+  description: z.string(),
+  quantity: z.number().int(),
+  quantityUnit: z.string().optional(),
+  unitPrice: Amount$inboundSchema,
+  discountAmount: Amount$inboundSchema.optional(),
+  totalAmount: Amount$inboundSchema,
+  vatRate: z.string().optional(),
+  vatAmount: Amount$inboundSchema.optional(),
+  sku: z.string().optional(),
+  imageUrl: z.string().optional(),
+  productUrl: z.string().optional(),
+});
+/** @internal */
+export type SessionLineItemResponse$Outbound = {
+  type?: string | undefined;
+  description: string;
+  quantity: number;
+  quantityUnit?: string | undefined;
+  unitPrice: Amount$Outbound;
+  discountAmount?: Amount$Outbound | undefined;
+  totalAmount: Amount$Outbound;
+  vatRate?: string | undefined;
+  vatAmount?: Amount$Outbound | undefined;
+  sku?: string | undefined;
+  imageUrl?: string | undefined;
+  productUrl?: string | undefined;
+};
+
+/** @internal */
+export const SessionLineItemResponse$outboundSchema: z.ZodType<
+  SessionLineItemResponse$Outbound,
+  z.ZodTypeDef,
+  SessionLineItemResponse
+> = z.object({
+  type: PaymentLineTypeResponse$outboundSchema.optional(),
+  description: z.string(),
+  quantity: z.number().int(),
+  quantityUnit: z.string().optional(),
+  unitPrice: Amount$outboundSchema,
+  discountAmount: Amount$outboundSchema.optional(),
+  totalAmount: Amount$outboundSchema,
+  vatRate: z.string().optional(),
+  vatAmount: Amount$outboundSchema.optional(),
+  sku: z.string().optional(),
+  imageUrl: z.string().optional(),
+  productUrl: z.string().optional(),
+});
+
+export function sessionLineItemResponseToJSON(
+  sessionLineItemResponse: SessionLineItemResponse,
+): string {
+  return JSON.stringify(
+    SessionLineItemResponse$outboundSchema.parse(sessionLineItemResponse),
+  );
+}
+export function sessionLineItemResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionLineItemResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionLineItemResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionLineItemResponse' from JSON`,
+  );
+}

package/src/models/sessionrequest.ts

@@ -0,0 +1,216 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  PaymentAddress,
+  PaymentAddress$inboundSchema,
+  PaymentAddress$Outbound,
+  PaymentAddress$outboundSchema,
+} from "./paymentaddress.js";
+import {
+  SessionLineItem,
+  SessionLineItem$inboundSchema,
+  SessionLineItem$Outbound,
+  SessionLineItem$outboundSchema,
+} from "./sessionlineitem.js";
+import {
+  SessionSequenceType,
+  SessionSequenceType$inboundSchema,
+  SessionSequenceType$outboundSchema,
+} from "./sessionsequencetype.js";
+
+export type SessionRequestPayment = {
+  /**
+   * The webhook URL where we will send payment status updates to.
+   *
+   * @remarks
+   *
+   * This URL will be automatically set as the webhook URL for all payments created for this session.
+   */
+  webhookUrl?: string | undefined;
+};
+
+export type SessionRequest = {
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * A user-friendly description of the session that may be shown to the customer during the checkout process.
+   *
+   * @remarks
+   *
+   * Any payment created for the session will use the same description.
+   */
+  description: string;
+  /**
+   * List of items the customer will pay for in this session. The sum of all line items must equal the
+   *
+   * @remarks
+   * session's amount.
+   *
+   * All lines must have the same currency as the session.
+   */
+  lines: Array<SessionLineItem>;
+  /**
+   * The URL your customer will be redirected to after the payment process.
+   *
+   * @remarks
+   *
+   * It could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the
+   * right page referencing the order when your customer returns.
+   */
+  redirectUrl: string;
+  billingAddress?: PaymentAddress | undefined;
+  shippingAddress?: PaymentAddress | undefined;
+  customerId?: string | undefined;
+  sequenceType?: SessionSequenceType | undefined;
+  /**
+   * Provide any data you like in 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.
+   *
+   * Any payment created for the session will use the same metadata.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  payment?: SessionRequestPayment | undefined;
+  /**
+   * The identifier referring to the [profile](get-profile) this entity belongs to.
+   *
+   * @remarks
+   *
+   * Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
+   * request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
+   * required.
+   */
+  profileId?: string | undefined;
+  /**
+   * Whether to create the entity in test mode or live mode.
+   *
+   * @remarks
+   *
+   * Most API credentials are specifically created for either live mode or test mode, in which case this parameter must
+   * not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+   * `testmode` to `true`.
+   */
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const SessionRequestPayment$inboundSchema: z.ZodType<
+  SessionRequestPayment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  webhookUrl: z.string().optional(),
+});
+/** @internal */
+export type SessionRequestPayment$Outbound = {
+  webhookUrl?: string | undefined;
+};
+
+/** @internal */
+export const SessionRequestPayment$outboundSchema: z.ZodType<
+  SessionRequestPayment$Outbound,
+  z.ZodTypeDef,
+  SessionRequestPayment
+> = z.object({
+  webhookUrl: z.string().optional(),
+});
+
+export function sessionRequestPaymentToJSON(
+  sessionRequestPayment: SessionRequestPayment,
+): string {
+  return JSON.stringify(
+    SessionRequestPayment$outboundSchema.parse(sessionRequestPayment),
+  );
+}
+export function sessionRequestPaymentFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionRequestPayment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionRequestPayment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionRequestPayment' from JSON`,
+  );
+}
+
+/** @internal */
+export const SessionRequest$inboundSchema: z.ZodType<
+  SessionRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: Amount$inboundSchema,
+  description: z.string(),
+  lines: z.array(SessionLineItem$inboundSchema),
+  redirectUrl: z.string(),
+  billingAddress: PaymentAddress$inboundSchema.optional(),
+  shippingAddress: PaymentAddress$inboundSchema.optional(),
+  customerId: z.string().optional(),
+  sequenceType: SessionSequenceType$inboundSchema.optional(),
+  metadata: z.record(z.any()).optional(),
+  payment: z.lazy(() => SessionRequestPayment$inboundSchema).optional(),
+  profileId: z.string().optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+});
+/** @internal */
+export type SessionRequest$Outbound = {
+  amount: Amount$Outbound;
+  description: string;
+  lines: Array<SessionLineItem$Outbound>;
+  redirectUrl: string;
+  billingAddress?: PaymentAddress$Outbound | undefined;
+  shippingAddress?: PaymentAddress$Outbound | undefined;
+  customerId?: string | undefined;
+  sequenceType?: string | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  payment?: SessionRequestPayment$Outbound | undefined;
+  profileId?: string | undefined;
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const SessionRequest$outboundSchema: z.ZodType<
+  SessionRequest$Outbound,
+  z.ZodTypeDef,
+  SessionRequest
+> = z.object({
+  amount: Amount$outboundSchema,
+  description: z.string(),
+  lines: z.array(SessionLineItem$outboundSchema),
+  redirectUrl: z.string(),
+  billingAddress: PaymentAddress$outboundSchema.optional(),
+  shippingAddress: PaymentAddress$outboundSchema.optional(),
+  customerId: z.string().optional(),
+  sequenceType: SessionSequenceType$outboundSchema.optional(),
+  metadata: z.record(z.any()).optional(),
+  payment: z.lazy(() => SessionRequestPayment$outboundSchema).optional(),
+  profileId: z.string().optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+});
+
+export function sessionRequestToJSON(sessionRequest: SessionRequest): string {
+  return JSON.stringify(SessionRequest$outboundSchema.parse(sessionRequest));
+}
+export function sessionRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionRequest' from JSON`,
+  );
+}