Skip to content

Monnify docs #1569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hunterachieng merged 8 commits into from
Mar 5, 2026
Merged

Monnify docs #1569

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d0adafd
feat: add date range parameters to list function example
PiusKariuki Feb 26, 2026
68b2075
feat: update example caption for list function to clarify date range …
PiusKariuki Feb 26, 2026
6d30424
feat: add startDate and endDate properties to ListQueryOptions typedef
PiusKariuki Feb 26, 2026
e822118
changeset file
PiusKariuki Mar 5, 2026
aabdfe1
feat: update version to 1.1.0 and document startDate and endDate in c…
PiusKariuki Mar 5, 2026
8e8471b
Revert "feat: update version to 1.1.0 and document startDate and endD…
PiusKariuki Mar 5, 2026
e01ffbf
Revert "changeset file"
PiusKariuki Mar 5, 2026
dce5242
feat: update version to 1.0.3 and document startDate and endDate in c…
PiusKariuki Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/monnify/ast.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@
"tags": [
{
"title": "example",
"description": "list('/api/v2/disbursements/search-transactions', {\n sourceAccountNumber: 4864192954\n});",
"caption": "Get all transactions"
"description": "list('/api/v2/disbursements/search-transactions', {\n sourceAccountNumber: 4864192954,\n startDate: new Date('2025-11-15'),\n endDate: Date.now()\n});",
"caption": "Get transactions within a date range. (Default range is the current date)"
},
{
"title": "example",
Expand Down
12 changes: 8 additions & 4 deletions packages/monnify/src/Adaptor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import * as util from './Utils.js';
* @typedef {Object} ListQueryOptions
* @property {Number} pageNo - The page number. Please note that Monnify pagination starts at 0 not 1. (Default: 0)
* @property {Number} pageSize - The page size. (Default: 100)
* @property {Date} startDate - The lower date range
* @property {Date} endDate - The higher date range
* @property {Record<string, any>} [otherOptions] - Additional options.
**/

Expand Down Expand Up @@ -56,9 +58,11 @@ export function get(path, options = {}) {

/**
* Fetch a list of items.
* @example <caption>Get all transactions</caption>
* @example <caption>Get transactions within a date range. (Default range is the current date)</caption>
* list('/api/v2/disbursements/search-transactions', {
* sourceAccountNumber: 4864192954
* sourceAccountNumber: 4864192954,
* startDate: new Date('2025-11-15'),
* endDate: Date.now()
* });
*
* @example <caption>Get all transactions for a specific page and page number.</caption>
Expand Down Expand Up @@ -108,9 +112,9 @@ export function list(path, query = {}) {
* @returns {Operation}
* @state {HttpState}
*/
export function post(path, body,options = {}) {
export function post(path, body, options = {}) {
return async state => {
const [resolvedPath,resolvedBody, resolvedOptions] = expandReferences(state, path,body, options);
const [resolvedPath, resolvedBody, resolvedOptions] = expandReferences(state, path, body, options);

const response = await util.request(
state.configuration,
Expand Down