mollie-api-typescript 1.3.5 → 1.3.7

package/src/models/transactionresponse.ts

@@ -0,0 +1,172 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f293b6ef2c8f
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  AfterBalance,
+  AfterBalance$inboundSchema,
+  AfterBalance$Outbound,
+  AfterBalance$outboundSchema,
+} from "./afterbalance.js";
+import {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import {
+  Counterparty,
+  Counterparty$inboundSchema,
+  Counterparty$Outbound,
+  Counterparty$outboundSchema,
+} from "./counterparty.js";
+import {
+  CreditDebitIndicator,
+  CreditDebitIndicator$inboundSchema,
+  CreditDebitIndicator$outboundSchema,
+} from "./creditdebitindicator.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  TransactionType,
+  TransactionType$inboundSchema,
+  TransactionType$outboundSchema,
+} from "./transactiontype.js";
+
+export type TransactionResponse = {
+  /**
+   * Indicates the response contains a business account transaction object. Will always contain the string
+   *
+   * @remarks
+   * `business-account-transaction` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this transaction. Mollie assigns this identifier at transaction creation
+   *
+   * @remarks
+   * time.
+   */
+  id: string;
+  /**
+   * The identifier of the business account this transaction belongs to.
+   */
+  businessAccountId: string;
+  /**
+   * Indicates whether the entry is a credit or debit from the perspective of the account holder.
+   */
+  creditDebitIndicator: CreditDebitIndicator;
+  /**
+   * Indicates what kind of transaction this is.
+   *
+   * @remarks
+   *
+   * We may introduce new transaction types as we expand the product. We recommend building your integration
+   * to handle unexpected values gracefully, so nothing breaks when that happens.
+   */
+  type: TransactionType;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * A short description of the transaction.
+   */
+  description?: string | null | undefined;
+  /**
+   * The counterparty involved in the transaction, including their name and account identifier.
+   */
+  counterparty?: Counterparty | undefined;
+  /**
+   * The balance of the business account after this transaction was processed.
+   */
+  afterBalance?: AfterBalance | undefined;
+  /**
+   * The date and time when the transaction was processed, in ISO 8601 format.
+   */
+  processedAt?: string | null | undefined;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+};
+
+/** @internal */
+export const TransactionResponse$inboundSchema: z.ZodType<
+  TransactionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  businessAccountId: z.string(),
+  creditDebitIndicator: CreditDebitIndicator$inboundSchema,
+  type: TransactionType$inboundSchema,
+  amount: Amount$inboundSchema,
+  description: z.nullable(z.string()).optional(),
+  counterparty: Counterparty$inboundSchema.optional(),
+  afterBalance: AfterBalance$inboundSchema.optional(),
+  processedAt: z.nullable(z.string()).optional(),
+  mode: Mode$inboundSchema,
+  createdAt: z.string(),
+});
+/** @internal */
+export type TransactionResponse$Outbound = {
+  resource: string;
+  id: string;
+  businessAccountId: string;
+  creditDebitIndicator: string;
+  type: string;
+  amount: Amount$Outbound;
+  description?: string | null | undefined;
+  counterparty?: Counterparty$Outbound | undefined;
+  afterBalance?: AfterBalance$Outbound | undefined;
+  processedAt?: string | null | undefined;
+  mode: string;
+  createdAt: string;
+};
+
+/** @internal */
+export const TransactionResponse$outboundSchema: z.ZodType<
+  TransactionResponse$Outbound,
+  z.ZodTypeDef,
+  TransactionResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  businessAccountId: z.string(),
+  creditDebitIndicator: CreditDebitIndicator$outboundSchema,
+  type: TransactionType$outboundSchema,
+  amount: Amount$outboundSchema,
+  description: z.nullable(z.string()).optional(),
+  counterparty: Counterparty$outboundSchema.optional(),
+  afterBalance: AfterBalance$outboundSchema.optional(),
+  processedAt: z.nullable(z.string()).optional(),
+  mode: Mode$outboundSchema,
+  createdAt: z.string(),
+});
+
+export function transactionResponseToJSON(
+  transactionResponse: TransactionResponse,
+): string {
+  return JSON.stringify(
+    TransactionResponse$outboundSchema.parse(transactionResponse),
+  );
+}
+export function transactionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionResponse' from JSON`,
+  );
+}

package/src/models/transactiontype.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 50b0e691d718
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * Indicates what kind of transaction this is.
+ *
+ * @remarks
+ *
+ * We may introduce new transaction types as we expand the product. We recommend building your integration
+ * to handle unexpected values gracefully, so nothing breaks when that happens.
+ */
+export const TransactionType = {
+  CardPayment: "card-payment",
+  BankTransfer: "bank-transfer",
+  PspTransfer: "psp-transfer",
+  InternalTransfer: "internal-transfer",
+  IdealPayment: "ideal-payment",
+  Fee: "fee",
+  Correction: "correction",
+  DirectDebit: "direct-debit",
+  DirectDebitRefund: "direct-debit-refund",
+} as const;
+/**
+ * Indicates what kind of transaction this is.
+ *
+ * @remarks
+ *
+ * We may introduce new transaction types as we expand the product. We recommend building your integration
+ * to handle unexpected values gracefully, so nothing breaks when that happens.
+ */
+export type TransactionType = OpenEnum<typeof TransactionType>;
+
+/** @internal */
+export const TransactionType$inboundSchema: z.ZodType<
+  TransactionType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TransactionType);
+/** @internal */
+export const TransactionType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  TransactionType
+> = openEnums.outboundSchema(TransactionType);

package/src/models/transferresponse.ts

@@ -132,7 +132,7 @@ export type TransferResponse = {
    */
   transferScheme: TransferSchemeResponse;
   /**
-   * Indicates whether the transfer is a credit or debit transaction from the perspective of the account holder.
+   * Indicates whether the entry is a credit or debit from the perspective of the account holder.
    */
   creditDebitIndicator: CreditDebitIndicator;
   /**

package/src/sdk/accounts.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a4031260e046
+ */
+
+import { accountsGet } from "../funcs/accountsGet.js";
+import { accountsGetAccount } from "../funcs/accountsGetAccount.js";
+import { accountsList } from "../funcs/accountsList.js";
+import { accountsListAccounts } from "../funcs/accountsListAccounts.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Accounts extends ClientSDK {
+  /**
+   * List business accounts
+   *
+   * @remarks
+   * Retrieve all business accounts for the authenticated organization.
+   *
+   * The results are paginated.
+   */
+  async listAccounts(
+    request?: operations.ListBusinessAccountsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListBusinessAccountsResponse, { url: string }>
+  > {
+    return unwrapResultIterator(accountsListAccounts(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get business account
+   *
+   * @remarks
+   * Retrieve a single business account object by its account ID. This allows you to check the current status,
+   * balance, and account details.
+   */
+  async getAccount(
+    request: operations.GetBusinessAccountRequest,
+    options?: RequestOptions,
+  ): Promise<models.BusinessAccountResponse> {
+    return unwrapAsync(accountsGetAccount(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List transactions
+   *
+   * @remarks
+   * Retrieve all transactions for a specific business account.
+   *
+   * The results are paginated.
+   */
+  async list(
+    request: operations.ListBusinessAccountTransactionsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListBusinessAccountTransactionsResponse,
+      { url: string }
+    >
+  > {
+    return unwrapResultIterator(accountsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get transaction
+   *
+   * @remarks
+   * Retrieve a single transaction object by its transaction ID. This allows you to check the details,
+   * amount, counterparty, and balance impact of a specific transaction.
+   */
+  async get(
+    request: operations.GetBusinessAccountTransactionRequest,
+    options?: RequestOptions,
+  ): Promise<models.TransactionResponse> {
+    return unwrapAsync(accountsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -4,6 +4,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Accounts } from "./accounts.js";
 import { Balances } from "./balances.js";
 import { BalanceTransfers } from "./balancetransfers.js";
 import { Capabilities } from "./capabilities.js";
@@ -170,6 +171,11 @@ export class Client extends ClientSDK {
     return (this._salesInvoices ??= new SalesInvoices(this._options));
   }
 
+  private _accounts?: Accounts;
+  get accounts(): Accounts {
+    return (this._accounts ??= new Accounts(this._options));
+  }
+
   private _transfers?: Transfers;
   get transfers(): Transfers {
     return (this._transfers ??= new Transfers(this._options));