@afriex/sdk 5.1.0 → 6.1.0

package/dist/cjs/generated/openapi.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/index.d.ts

@@ -0,0 +1,21 @@
+export { Afriex, Afriex as AfriexSDK, API_VERSION, ENVIRONMENTS } from './client.js';
+export type { APIRequestInit, ClientOptions, Environment, SignableRequest } from './client.js';
+export { APIPromise } from './core/api-promise.js';
+export { AfriexError, APIConnectionError, APIConnectionTimeoutError, APIError, APIUserAbortError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, WebhookVerificationError, } from './core/errors.js';
+export { Page, PagePromise } from './core/pagination.js';
+export type { RequestOptions } from './core/types.js';
+export type * from './resources/balance.js';
+export type * from './resources/checkout.js';
+export type * from './resources/customers.js';
+export type * from './resources/media.js';
+export type * from './resources/payment-batches.js';
+export type * from './resources/payment-methods.js';
+export type * from './resources/rates.js';
+export type * from './resources/sme-registration.js';
+export type * from './resources/transactions.js';
+export type * from './resources/webhooks.js';
+export { WEBHOOK_SIGNATURE_HEADER } from './resources/webhooks.js';
+export { VERSION } from './version.js';
+/** Every type the spec defines, as generated from `api-reference/openapi.json`. */
+export type * as OpenAPI from './generated/openapi.js';
+export { Afriex as default } from './client.js';

package/dist/cjs/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = exports.VERSION = exports.WEBHOOK_SIGNATURE_HEADER = exports.PagePromise = exports.Page = exports.WebhookVerificationError = exports.UnprocessableEntityError = exports.RateLimitError = exports.PermissionDeniedError = exports.NotFoundError = exports.InternalServerError = exports.ConflictError = exports.BadRequestError = exports.AuthenticationError = exports.APIUserAbortError = exports.APIError = exports.APIConnectionTimeoutError = exports.APIConnectionError = exports.AfriexError = exports.APIPromise = exports.ENVIRONMENTS = exports.API_VERSION = exports.AfriexSDK = exports.Afriex = void 0;
+var client_js_1 = require("./client.js");
+Object.defineProperty(exports, "Afriex", { enumerable: true, get: function () { return client_js_1.Afriex; } });
+Object.defineProperty(exports, "AfriexSDK", { enumerable: true, get: function () { return client_js_1.Afriex; } });
+Object.defineProperty(exports, "API_VERSION", { enumerable: true, get: function () { return client_js_1.API_VERSION; } });
+Object.defineProperty(exports, "ENVIRONMENTS", { enumerable: true, get: function () { return client_js_1.ENVIRONMENTS; } });
+var api_promise_js_1 = require("./core/api-promise.js");
+Object.defineProperty(exports, "APIPromise", { enumerable: true, get: function () { return api_promise_js_1.APIPromise; } });
+var errors_js_1 = require("./core/errors.js");
+Object.defineProperty(exports, "AfriexError", { enumerable: true, get: function () { return errors_js_1.AfriexError; } });
+Object.defineProperty(exports, "APIConnectionError", { enumerable: true, get: function () { return errors_js_1.APIConnectionError; } });
+Object.defineProperty(exports, "APIConnectionTimeoutError", { enumerable: true, get: function () { return errors_js_1.APIConnectionTimeoutError; } });
+Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return errors_js_1.APIError; } });
+Object.defineProperty(exports, "APIUserAbortError", { enumerable: true, get: function () { return errors_js_1.APIUserAbortError; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return errors_js_1.AuthenticationError; } });
+Object.defineProperty(exports, "BadRequestError", { enumerable: true, get: function () { return errors_js_1.BadRequestError; } });
+Object.defineProperty(exports, "ConflictError", { enumerable: true, get: function () { return errors_js_1.ConflictError; } });
+Object.defineProperty(exports, "InternalServerError", { enumerable: true, get: function () { return errors_js_1.InternalServerError; } });
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return errors_js_1.NotFoundError; } });
+Object.defineProperty(exports, "PermissionDeniedError", { enumerable: true, get: function () { return errors_js_1.PermissionDeniedError; } });
+Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: function () { return errors_js_1.RateLimitError; } });
+Object.defineProperty(exports, "UnprocessableEntityError", { enumerable: true, get: function () { return errors_js_1.UnprocessableEntityError; } });
+Object.defineProperty(exports, "WebhookVerificationError", { enumerable: true, get: function () { return errors_js_1.WebhookVerificationError; } });
+var pagination_js_1 = require("./core/pagination.js");
+Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return pagination_js_1.Page; } });
+Object.defineProperty(exports, "PagePromise", { enumerable: true, get: function () { return pagination_js_1.PagePromise; } });
+var webhooks_js_1 = require("./resources/webhooks.js");
+Object.defineProperty(exports, "WEBHOOK_SIGNATURE_HEADER", { enumerable: true, get: function () { return webhooks_js_1.WEBHOOK_SIGNATURE_HEADER; } });
+var version_js_1 = require("./version.js");
+Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () { return version_js_1.VERSION; } });
+var client_js_2 = require("./client.js");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return client_js_2.Afriex; } });

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/cjs/resources/balance.d.ts

@@ -0,0 +1,16 @@
+import type { APIPromise } from '../core/api-promise.js';
+import { APIResource } from '../core/resource.js';
+import type { Body, Data, Query, RequestOptions } from '../core/types.js';
+export type BalanceParams = Omit<Query<'getBalance'>, 'currencies'> & {
+    /** The currencies to return, as a list or a comma-separated string. Omit for all of them. */
+    currencies?: string | string[];
+};
+/** Each currency's balance, keyed by currency code. */
+export type Balances = Data<'getBalance'>;
+export type TopUpParams = Body<'topupBalance'>;
+export declare class Balance extends APIResource {
+    /** Retrieves your wallet balances, keyed by currency code. */
+    getBalance(params?: BalanceParams, options?: RequestOptions): APIPromise<Balances>;
+    /** Sandbox only: adds test funds to a wallet. */
+    topUpSandbox(params: TopUpParams, options?: RequestOptions): APIPromise<Data<'topupBalance'>>;
+}

package/dist/cjs/resources/balance.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Balance = void 0;
+const resource_js_1 = require("../core/resource.js");
+class Balance extends resource_js_1.APIResource {
+    /** Retrieves your wallet balances, keyed by currency code. */
+    getBalance(params = {}, options) {
+        return this._client
+            .request('get', '/api/v1/org/balance', { query: params, options })
+            ._thenUnwrap((r) => r.data ?? {});
+    }
+    /** Sandbox only: adds test funds to a wallet. */
+    topUpSandbox(params, options) {
+        return this._client
+            .request('post', '/api/v1/org/balance/topup', { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+}
+exports.Balance = Balance;

package/dist/cjs/resources/checkout.d.ts

@@ -0,0 +1,12 @@
+import type { APIPromise } from '../core/api-promise.js';
+import { APIResource } from '../core/resource.js';
+import type { Body, Data, RequestOptions } from '../core/types.js';
+export type CheckoutSessionCreateParams = Body<'createCheckoutSession'>;
+export type CheckoutSession = Data<'createCheckoutSession'>;
+export declare class Checkout extends APIResource {
+    /**
+     * Creates a hosted checkout session. Redirect the payer to its
+     * `checkoutUrl`. Amounts are in minor units, such as kobo or cents.
+     */
+    createSession(params: CheckoutSessionCreateParams, options?: RequestOptions): APIPromise<CheckoutSession>;
+}

package/dist/cjs/resources/checkout.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Checkout = void 0;
+const resource_js_1 = require("../core/resource.js");
+class Checkout extends resource_js_1.APIResource {
+    /**
+     * Creates a hosted checkout session. Redirect the payer to its
+     * `checkoutUrl`. Amounts are in minor units, such as kobo or cents.
+     */
+    createSession(params, options) {
+        return this._client
+            .request('post', '/api/v1/checkout-session', { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+}
+exports.Checkout = Checkout;

package/dist/cjs/resources/customers.d.ts

@@ -0,0 +1,27 @@
+import type { APIPromise } from '../core/api-promise.js';
+import type { PagePromise } from '../core/pagination.js';
+import { APIResource } from '../core/resource.js';
+import type { Body, Data, Item, Query, RequestOptions } from '../core/types.js';
+import type { Customer } from '../generated/openapi.js';
+export type { Customer };
+export type CustomerCreateParams = Body<'createCustomer'>;
+export type CustomerListParams = Query<'listCustomers'>;
+export type CustomerUpdateParams = Body<'updateCustomer'>;
+export type CustomerUpdateKycParams = Body<'updateCustomerKyc'>;
+export type CustomerVerifyParams = Body<'verifyCustomer'>;
+export declare class Customers extends APIResource {
+    /** Creates a customer. */
+    create(params: CustomerCreateParams, options?: RequestOptions): APIPromise<Data<'createCustomer'>>;
+    /** Lists customers, alphabetically by full name. Iterate the result with `for await` to walk every page. */
+    list(params?: CustomerListParams, options?: RequestOptions): PagePromise<Item<'listCustomers'>>;
+    /** Retrieves a customer. */
+    get(customerId: string, options?: RequestOptions): APIPromise<Data<'getCustomer'>>;
+    /** Updates a customer's details. */
+    update(customerId: string, params: CustomerUpdateParams, options?: RequestOptions): APIPromise<Data<'updateCustomer'>>;
+    /** Deletes a customer. */
+    delete(customerId: string, options?: RequestOptions): APIPromise<Data<'deleteCustomer'>>;
+    /** Adds or replaces a customer's KYC documents. */
+    updateKyc(customerId: string, params: CustomerUpdateKycParams, options?: RequestOptions): APIPromise<Data<'updateCustomerKyc'>>;
+    /** Verifies a customer's identity document. */
+    verify(customerId: string, params: CustomerVerifyParams, options?: RequestOptions): APIPromise<Data<'verifyCustomer'>>;
+}

package/dist/cjs/resources/customers.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Customers = void 0;
+const resource_js_1 = require("../core/resource.js");
+class Customers extends resource_js_1.APIResource {
+    /** Creates a customer. */
+    create(params, options) {
+        return this._client
+            .request('post', '/api/v1/customer', { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Lists customers, alphabetically by full name. Iterate the result with `for await` to walk every page. */
+    list(params = {}, options) {
+        return this._client.getPage('/api/v1/customer', params, options);
+    }
+    /** Retrieves a customer. */
+    get(customerId, options) {
+        return this._client
+            .request('get', (0, resource_js_1.path) `/api/v1/customer/${customerId}`, { options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Updates a customer's details. */
+    update(customerId, params, options) {
+        return this._client
+            .request('patch', (0, resource_js_1.path) `/api/v1/customer/${customerId}`, {
+            body: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Deletes a customer. */
+    delete(customerId, options) {
+        return this._client
+            .request('delete', (0, resource_js_1.path) `/api/v1/customer/${customerId}`, { options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Adds or replaces a customer's KYC documents. */
+    updateKyc(customerId, params, options) {
+        return this._client
+            .request('patch', (0, resource_js_1.path) `/api/v1/customer/${customerId}/kyc`, {
+            body: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Verifies a customer's identity document. */
+    verify(customerId, params, options) {
+        return this._client
+            .request('post', (0, resource_js_1.path) `/api/v1/customer/${customerId}/verify`, {
+            body: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+}
+exports.Customers = Customers;

package/dist/cjs/resources/media.d.ts

@@ -0,0 +1,24 @@
+import type { APIPromise } from '../core/api-promise.js';
+import { APIResource } from '../core/resource.js';
+import type { Data, RequestOptions } from '../core/types.js';
+import type { MediaUrlRequest } from '../generated/openapi.js';
+export type UploadUrlParams = MediaUrlRequest;
+export type UploadUrl = Data<'generatePresignedURL'>;
+export interface UploadParams extends UploadUrlParams {
+    /** The file's contents. */
+    file: Blob | ArrayBuffer | Uint8Array;
+    /** Sent as the upload's `Content-Type`. */
+    contentType?: string;
+}
+export declare class Media extends APIResource {
+    /**
+     * Creates a presigned URL for a file upload. PUT the file to `url`, then
+     * attach `key` to the request that needs the file. `upload()` does both.
+     */
+    createUploadUrl(params: UploadUrlParams, options?: RequestOptions): APIPromise<UploadUrl>;
+    /**
+     * Gets an upload URL and uploads the file to it. Returns the upload URL's
+     * details: attach its `key` to the request that needs the file.
+     */
+    upload(params: UploadParams, options?: RequestOptions): Promise<UploadUrl>;
+}

package/dist/cjs/resources/media.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Media = void 0;
+const errors_js_1 = require("../core/errors.js");
+const resource_js_1 = require("../core/resource.js");
+class Media extends resource_js_1.APIResource {
+    /**
+     * Creates a presigned URL for a file upload. PUT the file to `url`, then
+     * attach `key` to the request that needs the file. `upload()` does both.
+     */
+    createUploadUrl(params, options) {
+        return this._client
+            .request('post', '/api/v1/media/url', { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /**
+     * Gets an upload URL and uploads the file to it. Returns the upload URL's
+     * details: attach its `key` to the request that needs the file.
+     */
+    async upload(params, options) {
+        const { file, contentType, ...urlParams } = params;
+        const upload = await this.createUploadUrl(urlParams, options);
+        if (!upload.url) {
+            throw new errors_js_1.AfriexError('The API returned no upload URL.');
+        }
+        // The presigned URL carries its own authorization, and goes to the storage
+        // host, so it must not carry the API key.
+        const response = await this._client.fetchUnauthenticated(upload.url, {
+            method: 'PUT',
+            body: file,
+            headers: contentType ? { 'Content-Type': contentType } : {},
+        });
+        if (!response.ok) {
+            throw new errors_js_1.AfriexError(`Uploading the file failed with status ${response.status}.`);
+        }
+        return upload;
+    }
+}
+exports.Media = Media;

package/dist/cjs/resources/payment-batches.d.ts

@@ -0,0 +1,41 @@
+import type { APIPromise } from '../core/api-promise.js';
+import type { PagePromise } from '../core/pagination.js';
+import { APIResource } from '../core/resource.js';
+import type { Body, Data, Item, Query, RequestOptions } from '../core/types.js';
+import type { PaymentBatch } from '../generated/openapi.js';
+export type { PaymentBatch };
+export type PaymentBatchListParams = Query<'listPaymentBatches'>;
+export type PaymentBatchCreateParams = Body<'createPaymentBatch'>;
+export type PaymentBatchUpdateParams = Body<'updatePaymentBatch'>;
+export type PaymentBatchRecipientListParams = Query<'listPaymentBatchRecipients'>;
+export type PaymentBatchRecipientAddParams = Body<'addPaymentBatchRecipient'>;
+export type PaymentBatchRecipientsAddParams = Body<'addPaymentBatchRecipients'>;
+export type PaymentBatchRecipientUpdateParams = Body<'updatePaymentBatchRecipient'>;
+export type PaymentBatchWithdrawParams = Query<'withdrawPaymentBatch'>;
+export type PaymentBatchSessionListParams = Query<'listPaymentBatchSessions'>;
+export declare class PaymentBatches extends APIResource {
+    /** Lists payment batches, newest first. Iterate the result with `for await` to walk every page. */
+    list(params?: PaymentBatchListParams, options?: RequestOptions): PagePromise<Item<'listPaymentBatches'>>;
+    /** Creates a payment batch. */
+    create(params: PaymentBatchCreateParams, options?: RequestOptions): APIPromise<Data<'createPaymentBatch'>>;
+    /** Retrieves a payment batch. */
+    get(batchId: string, options?: RequestOptions): APIPromise<Data<'getPaymentBatch'>>;
+    /** Updates a payment batch. */
+    update(batchId: string, params: PaymentBatchUpdateParams, options?: RequestOptions): APIPromise<Data<'updatePaymentBatch'>>;
+    /** Deletes a payment batch. */
+    delete(batchId: string, options?: RequestOptions): APIPromise<Data<'deletePaymentBatch'>>;
+    /** Lists a batch's recipients. Iterate the result with `for await` to walk every page. */
+    listRecipients(batchId: string, params?: PaymentBatchRecipientListParams, options?: RequestOptions): PagePromise<Item<'listPaymentBatchRecipients'>>;
+    /** Adds one recipient to a batch. */
+    addRecipient(batchId: string, params: PaymentBatchRecipientAddParams, options?: RequestOptions): APIPromise<Data<'addPaymentBatchRecipient'>>;
+    /** Adds several recipients to a batch in one request. */
+    addRecipients(batchId: string, params: PaymentBatchRecipientsAddParams, options?: RequestOptions): APIPromise<Data<'addPaymentBatchRecipients'>>;
+    /** Updates a recipient in a batch. */
+    updateRecipient(batchId: string, recipientId: string, params: PaymentBatchRecipientUpdateParams, options?: RequestOptions): APIPromise<Data<'updatePaymentBatchRecipient'>>;
+    /** Removes a recipient from a batch. */
+    removeRecipient(batchId: string, recipientId: string, options?: RequestOptions): APIPromise<Data<'removePaymentBatchRecipient'>>;
+    /** Pays out every recipient in a batch. */
+    withdraw(batchId: string, params?: PaymentBatchWithdrawParams, options?: RequestOptions): APIPromise<Data<'withdrawPaymentBatch'>>;
+    /** Lists a batch's payout sessions. Iterate the result with `for await` to walk every page. */
+    listSessions(batchId: string, params?: PaymentBatchSessionListParams, options?: RequestOptions): PagePromise<Item<'listPaymentBatchSessions'>>;
+}

package/dist/cjs/resources/payment-batches.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentBatches = void 0;
+const resource_js_1 = require("../core/resource.js");
+class PaymentBatches extends resource_js_1.APIResource {
+    /** Lists payment batches, newest first. Iterate the result with `for await` to walk every page. */
+    list(params = {}, options) {
+        return this._client.getPage('/api/v1/payment-batch', params, options);
+    }
+    /** Creates a payment batch. */
+    create(params, options) {
+        return this._client
+            .request('post', '/api/v1/payment-batch', { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Retrieves a payment batch. */
+    get(batchId, options) {
+        return this._client
+            .request('get', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}`, { options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Updates a payment batch. */
+    update(batchId, params, options) {
+        return this._client
+            .request('patch', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}`, {
+            body: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Deletes a payment batch. */
+    delete(batchId, options) {
+        return this._client
+            .request('delete', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}`, { options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Lists a batch's recipients. Iterate the result with `for await` to walk every page. */
+    listRecipients(batchId, params = {}, options) {
+        return this._client.getPage((0, resource_js_1.path) `/api/v1/payment-batch/${batchId}/recipients`, params, options);
+    }
+    /** Adds one recipient to a batch. */
+    addRecipient(batchId, params, options) {
+        return this._client
+            .request('post', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}/recipients`, { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Adds several recipients to a batch in one request. */
+    addRecipients(batchId, params, options) {
+        return this._client
+            .request('post', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}/recipients/bulk`, { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Updates a recipient in a batch. */
+    updateRecipient(batchId, recipientId, params, options) {
+        return this._client
+            .request('patch', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}/recipients/${recipientId}`, { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Removes a recipient from a batch. */
+    removeRecipient(batchId, recipientId, options) {
+        return this._client
+            .request('delete', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}/recipients/${recipientId}`, { options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Pays out every recipient in a batch. */
+    withdraw(batchId, params = {}, options) {
+        return this._client
+            .request('post', (0, resource_js_1.path) `/api/v1/payment-batch/${batchId}/withdraw`, { query: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Lists a batch's payout sessions. Iterate the result with `for await` to walk every page. */
+    listSessions(batchId, params = {}, options) {
+        return this._client.getPage((0, resource_js_1.path) `/api/v1/payment-batch/${batchId}/sessions`, params, options);
+    }
+}
+exports.PaymentBatches = PaymentBatches;

package/dist/cjs/resources/payment-methods.d.ts

@@ -0,0 +1,49 @@
+import type { APIPromise } from '../core/api-promise.js';
+import type { PagePromise } from '../core/pagination.js';
+import { APIResource } from '../core/resource.js';
+import type { Body, Data, Item, Query, RequestOptions, Response } from '../core/types.js';
+import type { PaymentMethod } from '../generated/openapi.js';
+export type { PaymentMethod };
+export type PaymentMethodCreateParams = Body<'createPaymentMethod'>;
+export type PaymentMethodListParams = Query<'listPaymentMethods'>;
+export type InstitutionListParams = Query<'listInstitutions'>;
+export type InstitutionList = Response<'listInstitutions'>;
+export type InstitutionCodeParams = Query<'resolveInstitutionCode'>;
+export type InstitutionCodes = Data<'resolveInstitutionCode'>;
+export type ResolveAccountParams = Query<'resolveRecipient'>;
+export type ResolvedAccount = Data<'resolveRecipient'>;
+export type CryptoWalletParams = Query<'getCryptoWallet'>;
+export type CryptoWallet = Data<'getCryptoWallet'>;
+export type VirtualAccountListParams = Query<'listVirtualAccounts'>;
+export type VirtualAccountList = Response<'listVirtualAccounts'>;
+export type VirtualAccountCreateParams = Body<'createVirtualAccount'>;
+export type SimulateTransferParams = Body<'simulateVirtualAccountTransfer'>;
+export type PoolAccountParams = Query<'getPoolAccount'>;
+export declare class PaymentMethods extends APIResource {
+    /** Saves a payout destination, such as a bank account or mobile money wallet. */
+    create(params: PaymentMethodCreateParams, options?: RequestOptions): APIPromise<Data<'createPaymentMethod'>>;
+    /** Lists payment methods, most recently updated first. Iterate the result with `for await` to walk every page. */
+    list(params?: PaymentMethodListParams, options?: RequestOptions): PagePromise<Item<'listPaymentMethods'>>;
+    /** Retrieves a payment method. */
+    get(paymentMethodId: string, options?: RequestOptions): APIPromise<Data<'getPaymentMethod'>>;
+    /** Deletes a payment method. */
+    delete(paymentMethodId: string, options?: RequestOptions): APIPromise<Response<'deletePaymentMethod'>>;
+    /** Lists the banks or mobile money providers for a channel and country. The list is on `data`. */
+    getInstitutions(params: InstitutionListParams, options?: RequestOptions): APIPromise<InstitutionList>;
+    /** Looks up a SWIFT code or routing number. */
+    resolveInstitutionCode(params: InstitutionCodeParams, options?: RequestOptions): APIPromise<InstitutionCodes>;
+    /** Looks up the name on an account before you pay it. */
+    resolveAccount(params: ResolveAccountParams, options?: RequestOptions): APIPromise<ResolvedAccount>;
+    /** Retrieves the crypto deposit addresses for an asset. */
+    getCryptoWallet(params: CryptoWalletParams, options?: RequestOptions): APIPromise<CryptoWallet>;
+    /** Lists virtual bank accounts. The list is on `data`. */
+    listVirtualAccounts(params: VirtualAccountListParams, options?: RequestOptions): APIPromise<VirtualAccountList>;
+    /** Opens a virtual bank account. */
+    createVirtualAccount(params: VirtualAccountCreateParams, options?: RequestOptions): APIPromise<Data<'createVirtualAccount'>>;
+    /** Sandbox only: simulates a transfer into a virtual account. */
+    simulateTransfer(params: SimulateTransferParams, options?: RequestOptions): APIPromise<Data<'simulateVirtualAccountTransfer'>>;
+    /** Retrieves the pool account to pay into for a country. */
+    getPoolAccount(params: PoolAccountParams, options?: RequestOptions): APIPromise<Data<'getPoolAccount'>>;
+    /** @deprecated Use `getPoolAccount()`. Despite the name, it returns one account. */
+    listPoolAccounts(params: PoolAccountParams, options?: RequestOptions): APIPromise<Data<'getPoolAccount'>>;
+}

package/dist/cjs/resources/payment-methods.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentMethods = void 0;
+const resource_js_1 = require("../core/resource.js");
+class PaymentMethods extends resource_js_1.APIResource {
+    /** Saves a payout destination, such as a bank account or mobile money wallet. */
+    create(params, options) {
+        return this._client
+            .request('post', '/api/v1/payment-method', { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Lists payment methods, most recently updated first. Iterate the result with `for await` to walk every page. */
+    list(params = {}, options) {
+        return this._client.getPage('/api/v1/payment-method', params, options);
+    }
+    /** Retrieves a payment method. */
+    get(paymentMethodId, options) {
+        return this._client
+            .request('get', (0, resource_js_1.path) `/api/v1/payment-method/${paymentMethodId}`, {
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Deletes a payment method. */
+    delete(paymentMethodId, options) {
+        return this._client.request('delete', (0, resource_js_1.path) `/api/v1/payment-method/${paymentMethodId}`, { options });
+    }
+    /** Lists the banks or mobile money providers for a channel and country. The list is on `data`. */
+    getInstitutions(params, options) {
+        return this._client.request('get', '/api/v1/payment-method/institution', {
+            query: params,
+            options,
+        });
+    }
+    /** Looks up a SWIFT code or routing number. */
+    resolveInstitutionCode(params, options) {
+        return this._client
+            .request('get', '/api/v1/payment-method/institution/codes', {
+            query: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Looks up the name on an account before you pay it. */
+    resolveAccount(params, options) {
+        return this._client
+            .request('get', '/api/v1/payment-method/resolve', { query: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Retrieves the crypto deposit addresses for an asset. */
+    getCryptoWallet(params, options) {
+        return this._client
+            .request('get', '/api/v1/payment-method/crypto-wallet', {
+            query: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Lists virtual bank accounts. The list is on `data`. */
+    listVirtualAccounts(params, options) {
+        return this._client.request('get', '/api/v1/payment-method/virtual-account', {
+            query: params,
+            options,
+        });
+    }
+    /** Opens a virtual bank account. */
+    createVirtualAccount(params, options) {
+        return this._client
+            .request('post', '/api/v1/payment-method/virtual-account', {
+            body: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Sandbox only: simulates a transfer into a virtual account. */
+    simulateTransfer(params, options) {
+        return this._client
+            .request('post', '/api/v1/payment-method/virtual-account/simulate-transfer', { body: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** Retrieves the pool account to pay into for a country. */
+    getPoolAccount(params, options) {
+        return this._client
+            .request('get', '/api/v1/payment-method/pool-account', {
+            query: params,
+            options,
+        })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    /** @deprecated Use `getPoolAccount()`. Despite the name, it returns one account. */
+    listPoolAccounts(params, options) {
+        return this.getPoolAccount(params, options);
+    }
+}
+exports.PaymentMethods = PaymentMethods;

package/dist/cjs/resources/rates.d.ts

@@ -0,0 +1,9 @@
+import type { APIPromise } from '../core/api-promise.js';
+import { APIResource } from '../core/resource.js';
+import type { Data, Query, RequestOptions } from '../core/types.js';
+export type RatesParams = Query<'getRates'>;
+export type ExchangeRates = Data<'getRates'>;
+export declare class Rates extends APIResource {
+    /** Retrieves exchange rates between the currencies you name. */
+    getRates(params?: RatesParams, options?: RequestOptions): APIPromise<ExchangeRates>;
+}

package/dist/cjs/resources/rates.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rates = void 0;
+const resource_js_1 = require("../core/resource.js");
+class Rates extends resource_js_1.APIResource {
+    /** Retrieves exchange rates between the currencies you name. */
+    getRates(params = {}, options) {
+        return this._client
+            .request('get', '/api/v1/org/rates', { query: params, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+}
+exports.Rates = Rates;

package/dist/cjs/resources/sme-registration.d.ts

@@ -0,0 +1,24 @@
+import type { APIPromise } from '../core/api-promise.js';
+import { APIResource } from '../core/resource.js';
+import type { Body, Data, RequestOptions } from '../core/types.js';
+type Step<S> = Extract<Body<'smeRegistration'>, {
+    step: S;
+}>['data'];
+export type SmeRegistrationInitiateParams = Step<'INITIATE'>;
+export type SmeRegistrationConfirmOtpParams = Step<'CONFIRM_OTP'>;
+export type SmeRegistrationSubmitParams = Step<'SUBMIT'>;
+export type SmeRegistrationResult = Data<'smeRegistration'>;
+export type SmeRegistrationStatus = Data<'smeRegistrationStatus'>;
+/** Registers your business for its own dedicated KES virtual accounts, in three steps. */
+export declare class SmeRegistration extends APIResource {
+    #private;
+    /** Step 1: starts a registration and sends an OTP to the mobile number. */
+    initiate(data: SmeRegistrationInitiateParams, options?: RequestOptions): APIPromise<SmeRegistrationResult>;
+    /** Step 2: confirms the OTP. */
+    confirmOtp(data: SmeRegistrationConfirmOtpParams, options?: RequestOptions): APIPromise<SmeRegistrationResult>;
+    /** Step 3: submits the business details for review. */
+    submit(data: SmeRegistrationSubmitParams, options?: RequestOptions): APIPromise<SmeRegistrationResult>;
+    /** Retrieves where your registration stands. */
+    getStatus(options?: RequestOptions): APIPromise<SmeRegistrationStatus>;
+}
+export {};

package/dist/cjs/resources/sme-registration.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmeRegistration = void 0;
+const resource_js_1 = require("../core/resource.js");
+/** Registers your business for its own dedicated KES virtual accounts, in three steps. */
+class SmeRegistration extends resource_js_1.APIResource {
+    /** Step 1: starts a registration and sends an OTP to the mobile number. */
+    initiate(data, options) {
+        return this.#send({ step: 'INITIATE', data }, options);
+    }
+    /** Step 2: confirms the OTP. */
+    confirmOtp(data, options) {
+        return this.#send({ step: 'CONFIRM_OTP', data }, options);
+    }
+    /** Step 3: submits the business details for review. */
+    submit(data, options) {
+        return this.#send({ step: 'SUBMIT', data }, options);
+    }
+    /** Retrieves where your registration stands. */
+    getStatus(options) {
+        return this._client
+            .request('get', '/api/v1/sme-registration/status', { options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+    #send(body, options) {
+        return this._client
+            .request('post', '/api/v1/sme-registration', { body, options })
+            ._thenUnwrap(resource_js_1.data);
+    }
+}
+exports.SmeRegistration = SmeRegistration;