mollie-api-typescript 0.2.9 → 0.3.1

package/src/models/operations/createconnectbalancetransfer.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 * as models from "../index.js";
+
+export type CreateConnectBalanceTransferRequest = {
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+  entityBalanceTransfer?: models.EntityBalanceTransfer | undefined;
+};
+
+/** @internal */
+export const CreateConnectBalanceTransferRequest$inboundSchema: z.ZodType<
+  CreateConnectBalanceTransferRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "idempotency-key": z.string().optional(),
+  "entity-balance-transfer": models.EntityBalanceTransfer$inboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+    "entity-balance-transfer": "entityBalanceTransfer",
+  });
+});
+
+/** @internal */
+export type CreateConnectBalanceTransferRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  "entity-balance-transfer"?: models.EntityBalanceTransfer$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateConnectBalanceTransferRequest$outboundSchema: z.ZodType<
+  CreateConnectBalanceTransferRequest$Outbound,
+  z.ZodTypeDef,
+  CreateConnectBalanceTransferRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  entityBalanceTransfer: models.EntityBalanceTransfer$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    entityBalanceTransfer: "entity-balance-transfer",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateConnectBalanceTransferRequest$ {
+  /** @deprecated use `CreateConnectBalanceTransferRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    CreateConnectBalanceTransferRequest$inboundSchema;
+  /** @deprecated use `CreateConnectBalanceTransferRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateConnectBalanceTransferRequest$outboundSchema;
+  /** @deprecated use `CreateConnectBalanceTransferRequest$Outbound` instead. */
+  export type Outbound = CreateConnectBalanceTransferRequest$Outbound;
+}
+
+export function createConnectBalanceTransferRequestToJSON(
+  createConnectBalanceTransferRequest: CreateConnectBalanceTransferRequest,
+): string {
+  return JSON.stringify(
+    CreateConnectBalanceTransferRequest$outboundSchema.parse(
+      createConnectBalanceTransferRequest,
+    ),
+  );
+}
+
+export function createConnectBalanceTransferRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateConnectBalanceTransferRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateConnectBalanceTransferRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateConnectBalanceTransferRequest' from JSON`,
+  );
+}

package/src/models/operations/getconnectbalancetransfer.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+export type GetConnectBalanceTransferRequest = {
+  /**
+   * Provide the ID of the item you want to perform this operation on.
+   */
+  id: string;
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | null | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export const GetConnectBalanceTransferRequest$inboundSchema: z.ZodType<
+  GetConnectBalanceTransferRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  testmode: z.nullable(z.boolean()).optional(),
+  "idempotency-key": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+  });
+});
+
+/** @internal */
+export type GetConnectBalanceTransferRequest$Outbound = {
+  id: string;
+  testmode?: boolean | null | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const GetConnectBalanceTransferRequest$outboundSchema: z.ZodType<
+  GetConnectBalanceTransferRequest$Outbound,
+  z.ZodTypeDef,
+  GetConnectBalanceTransferRequest
+> = z.object({
+  id: z.string(),
+  testmode: z.nullable(z.boolean()).optional(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetConnectBalanceTransferRequest$ {
+  /** @deprecated use `GetConnectBalanceTransferRequest$inboundSchema` instead. */
+  export const inboundSchema = GetConnectBalanceTransferRequest$inboundSchema;
+  /** @deprecated use `GetConnectBalanceTransferRequest$outboundSchema` instead. */
+  export const outboundSchema = GetConnectBalanceTransferRequest$outboundSchema;
+  /** @deprecated use `GetConnectBalanceTransferRequest$Outbound` instead. */
+  export type Outbound = GetConnectBalanceTransferRequest$Outbound;
+}
+
+export function getConnectBalanceTransferRequestToJSON(
+  getConnectBalanceTransferRequest: GetConnectBalanceTransferRequest,
+): string {
+  return JSON.stringify(
+    GetConnectBalanceTransferRequest$outboundSchema.parse(
+      getConnectBalanceTransferRequest,
+    ),
+  );
+}
+
+export function getConnectBalanceTransferRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetConnectBalanceTransferRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetConnectBalanceTransferRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetConnectBalanceTransferRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -7,6 +7,7 @@ export * from "./cancelrefund.js";
 export * from "./cancelsubscription.js";
 export * from "./createcapture.js";
 export * from "./createclientlink.js";
+export * from "./createconnectbalancetransfer.js";
 export * from "./createcustomer.js";
 export * from "./createcustomerpayment.js";
 export * from "./createmandate.js";
@@ -27,6 +28,7 @@ export * from "./getbalancereport.js";
 export * from "./getcapture.js";
 export * from "./getchargeback.js";
 export * from "./getclient.js";
+export * from "./getconnectbalancetransfer.js";
 export * from "./getcurrentorganization.js";
 export * from "./getcurrentprofile.js";
 export * from "./getcustomer.js";
@@ -61,6 +63,7 @@ export * from "./listcapabilities.js";
 export * from "./listcaptures.js";
 export * from "./listchargebacks.js";
 export * from "./listclients.js";
+export * from "./listconnectbalancetransfers.js";
 export * from "./listcustomerpayments.js";
 export * from "./listcustomers.js";
 export * from "./listinvoices.js";

package/src/models/operations/listconnectbalancetransfers.ts

@@ -0,0 +1,302 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 * as models from "../index.js";
+
+export type ListConnectBalanceTransfersRequest = {
+  /**
+   * Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+   *
+   * @remarks
+   * result set.
+   */
+  from?: string | null | undefined;
+  /**
+   * The maximum number of items to return. Defaults to 50 items.
+   */
+  limit?: number | null | undefined;
+  /**
+   * Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
+   *
+   * @remarks
+   * newest to oldest.
+   */
+  sort?: models.ListSort | null | undefined;
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | null | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type ListConnectBalanceTransfersEmbedded = {
+  /**
+   * A list of Connect balance transfers.
+   */
+  connectBalanceTransfers: Array<models.EntityBalanceTransferResponse>;
+};
+
+/**
+ * A list of Connect balance transfers. For a complete reference of the Connect balance transfer
+ *
+ * @remarks
+ * object, refer to the [Get balance transfer endpoint](get-balance-transfer) documentation.
+ */
+export type ListConnectBalanceTransfersResponse = {
+  /**
+   * The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
+   *
+   * @remarks
+   * as well.
+   *
+   * The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
+   * limit is 50 items.
+   */
+  count: number;
+  embedded: ListConnectBalanceTransfersEmbedded;
+  /**
+   * Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
+   */
+  links: models.ListLinks;
+};
+
+/** @internal */
+export const ListConnectBalanceTransfersRequest$inboundSchema: z.ZodType<
+  ListConnectBalanceTransfersRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  from: z.nullable(z.string()).optional(),
+  limit: z.nullable(z.number().int()).optional(),
+  sort: z.nullable(models.ListSort$inboundSchema).optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+  "idempotency-key": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+  });
+});
+
+/** @internal */
+export type ListConnectBalanceTransfersRequest$Outbound = {
+  from?: string | null | undefined;
+  limit?: number | null | undefined;
+  sort?: string | null | undefined;
+  testmode?: boolean | null | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const ListConnectBalanceTransfersRequest$outboundSchema: z.ZodType<
+  ListConnectBalanceTransfersRequest$Outbound,
+  z.ZodTypeDef,
+  ListConnectBalanceTransfersRequest
+> = z.object({
+  from: z.nullable(z.string()).optional(),
+  limit: z.nullable(z.number().int()).optional(),
+  sort: z.nullable(models.ListSort$outboundSchema).optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListConnectBalanceTransfersRequest$ {
+  /** @deprecated use `ListConnectBalanceTransfersRequest$inboundSchema` instead. */
+  export const inboundSchema = ListConnectBalanceTransfersRequest$inboundSchema;
+  /** @deprecated use `ListConnectBalanceTransfersRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    ListConnectBalanceTransfersRequest$outboundSchema;
+  /** @deprecated use `ListConnectBalanceTransfersRequest$Outbound` instead. */
+  export type Outbound = ListConnectBalanceTransfersRequest$Outbound;
+}
+
+export function listConnectBalanceTransfersRequestToJSON(
+  listConnectBalanceTransfersRequest: ListConnectBalanceTransfersRequest,
+): string {
+  return JSON.stringify(
+    ListConnectBalanceTransfersRequest$outboundSchema.parse(
+      listConnectBalanceTransfersRequest,
+    ),
+  );
+}
+
+export function listConnectBalanceTransfersRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListConnectBalanceTransfersRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListConnectBalanceTransfersRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListConnectBalanceTransfersRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListConnectBalanceTransfersEmbedded$inboundSchema: z.ZodType<
+  ListConnectBalanceTransfersEmbedded,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connect_balance_transfers: z.array(
+    models.EntityBalanceTransferResponse$inboundSchema,
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "connect_balance_transfers": "connectBalanceTransfers",
+  });
+});
+
+/** @internal */
+export type ListConnectBalanceTransfersEmbedded$Outbound = {
+  connect_balance_transfers: Array<
+    models.EntityBalanceTransferResponse$Outbound
+  >;
+};
+
+/** @internal */
+export const ListConnectBalanceTransfersEmbedded$outboundSchema: z.ZodType<
+  ListConnectBalanceTransfersEmbedded$Outbound,
+  z.ZodTypeDef,
+  ListConnectBalanceTransfersEmbedded
+> = z.object({
+  connectBalanceTransfers: z.array(
+    models.EntityBalanceTransferResponse$outboundSchema,
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    connectBalanceTransfers: "connect_balance_transfers",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListConnectBalanceTransfersEmbedded$ {
+  /** @deprecated use `ListConnectBalanceTransfersEmbedded$inboundSchema` instead. */
+  export const inboundSchema =
+    ListConnectBalanceTransfersEmbedded$inboundSchema;
+  /** @deprecated use `ListConnectBalanceTransfersEmbedded$outboundSchema` instead. */
+  export const outboundSchema =
+    ListConnectBalanceTransfersEmbedded$outboundSchema;
+  /** @deprecated use `ListConnectBalanceTransfersEmbedded$Outbound` instead. */
+  export type Outbound = ListConnectBalanceTransfersEmbedded$Outbound;
+}
+
+export function listConnectBalanceTransfersEmbeddedToJSON(
+  listConnectBalanceTransfersEmbedded: ListConnectBalanceTransfersEmbedded,
+): string {
+  return JSON.stringify(
+    ListConnectBalanceTransfersEmbedded$outboundSchema.parse(
+      listConnectBalanceTransfersEmbedded,
+    ),
+  );
+}
+
+export function listConnectBalanceTransfersEmbeddedFromJSON(
+  jsonString: string,
+): SafeParseResult<ListConnectBalanceTransfersEmbedded, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListConnectBalanceTransfersEmbedded$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListConnectBalanceTransfersEmbedded' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListConnectBalanceTransfersResponse$inboundSchema: z.ZodType<
+  ListConnectBalanceTransfersResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  _embedded: z.lazy(() => ListConnectBalanceTransfersEmbedded$inboundSchema),
+  _links: models.ListLinks$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "_embedded": "embedded",
+    "_links": "links",
+  });
+});
+
+/** @internal */
+export type ListConnectBalanceTransfersResponse$Outbound = {
+  count: number;
+  _embedded: ListConnectBalanceTransfersEmbedded$Outbound;
+  _links: models.ListLinks$Outbound;
+};
+
+/** @internal */
+export const ListConnectBalanceTransfersResponse$outboundSchema: z.ZodType<
+  ListConnectBalanceTransfersResponse$Outbound,
+  z.ZodTypeDef,
+  ListConnectBalanceTransfersResponse
+> = z.object({
+  count: z.number().int(),
+  embedded: z.lazy(() => ListConnectBalanceTransfersEmbedded$outboundSchema),
+  links: models.ListLinks$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    embedded: "_embedded",
+    links: "_links",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListConnectBalanceTransfersResponse$ {
+  /** @deprecated use `ListConnectBalanceTransfersResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    ListConnectBalanceTransfersResponse$inboundSchema;
+  /** @deprecated use `ListConnectBalanceTransfersResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    ListConnectBalanceTransfersResponse$outboundSchema;
+  /** @deprecated use `ListConnectBalanceTransfersResponse$Outbound` instead. */
+  export type Outbound = ListConnectBalanceTransfersResponse$Outbound;
+}
+
+export function listConnectBalanceTransfersResponseToJSON(
+  listConnectBalanceTransfersResponse: ListConnectBalanceTransfersResponse,
+): string {
+  return JSON.stringify(
+    ListConnectBalanceTransfersResponse$outboundSchema.parse(
+      listConnectBalanceTransfersResponse,
+    ),
+  );
+}
+
+export function listConnectBalanceTransfersResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListConnectBalanceTransfersResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListConnectBalanceTransfersResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListConnectBalanceTransfersResponse' from JSON`,
+  );
+}

package/src/sdk/balancetransfers.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { balanceTransfersCreate } from "../funcs/balanceTransfersCreate.js";
+import { balanceTransfersGet } from "../funcs/balanceTransfersGet.js";
+import { balanceTransfersList } from "../funcs/balanceTransfersList.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";
+
+export class BalanceTransfers extends ClientSDK {
+  /**
+   * Create a Connect balance transfer
+   *
+   * @remarks
+   * This API endpoint allows you to create a balance transfer from your organization's balance to a connected organization's balance, or vice versa.
+   * You can also create a balance transfer between two connected organizations.
+   * To create a balance transfer, you must be authenticated as the source organization, and the destination organization must be a connected organization
+   * that has authorized the `balance-transfers.write` scope for your organization.
+   */
+  async create(
+    request?: operations.CreateConnectBalanceTransferRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.EntityBalanceTransferResponse> {
+    return unwrapAsync(balanceTransfersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all Connect balance transfers
+   *
+   * @remarks
+   * Returns a paginated list of balance transfers associated with your organization. These may be a balance transfer that was received or sent from your balance, or a balance transfer that you initiated on behalf of your clients. If no balance transfers are available, the resulting array will be empty. This request should never throw an error.
+   */
+  async list(
+    request?: operations.ListConnectBalanceTransfersRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListConnectBalanceTransfersResponse> {
+    return unwrapAsync(balanceTransfersList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a Connect balance transfer
+   *
+   * @remarks
+   * Retrieve a single Connect balance transfer object by its ID.
+   */
+  async get(
+    request: operations.GetConnectBalanceTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.EntityBalanceTransferResponse> {
+    return unwrapAsync(balanceTransfersGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -4,6 +4,7 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Balances } from "./balances.js";
+import { BalanceTransfers } from "./balancetransfers.js";
 import { Capabilities } from "./capabilities.js";
 import { Captures } from "./captures.js";
 import { Chargebacks } from "./chargebacks.js";
@@ -90,6 +91,11 @@ export class Client extends ClientSDK {
     return (this._webhookEvents ??= new WebhookEvents(this._options));
   }
 
+  private _balanceTransfers?: BalanceTransfers;
+  get balanceTransfers(): BalanceTransfers {
+    return (this._balanceTransfers ??= new BalanceTransfers(this._options));
+  }
+
   private _payments?: Payments;
   get payments(): Payments {
     return (this._payments ??= new Payments(this._options));

package/docs/sdks/client/README.md

@@ -1,5 +0,0 @@
-# Client SDK
-
-## Overview
-
-### Available Operations