{"_id":"@adiba-banking-cloud/backoffice-console-ob-api-sdk","_rev":"3-cf234ffa5c6769ddf9a19496c2ec5d83","name":"@adiba-banking-cloud/backoffice-console-ob-api-sdk","dist-tags":{"latest":"0.1.3"},"versions":{"0.1.1":{"name":"@adiba-banking-cloud/backoffice-console-ob-api-sdk","version":"0.1.1","keywords":[],"author":{"name":"TUROG Technologies"},"license":"ISC","_id":"@adiba-banking-cloud/backoffice-console-ob-api-sdk@0.1.1","maintainers":[{"name":"xamuel98","email":"samuelakintomiwa98@gmail.com"},{"name":"adiba-creation-team","email":"devops@turog.ng"}],"dist":{"shasum":"f1ef7398b871aa62ddab6534ccc57a4cd470b911","tarball":"https://registry.npmjs.org/@adiba-banking-cloud/backoffice-console-ob-api-sdk/-/backoffice-console-ob-api-sdk-0.1.1.tgz","fileCount":36,"integrity":"sha512-Wap4rUWR3Qt9ygnVATzUONLtQlC5vCm68x3ORsPOj+kQeLflrob1LbeB7+lFY40Z+rktvHZQrFzc9mDNZEp5lQ==","signatures":[{"sig":"MEUCIQDBT0P930ct4JTVdZOAzZYB4am5NKbH0PiQ77gKZO7rOAIgC2bIWqhmOfFo16nYVSjDLqAhqALakvP/yYXUqvq31RY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":177528},"main":"dist/index.cjs.js","types":"dist/types/index.d.ts","module":"dist/index.esm.js","gitHead":"8ccb4bf3b7900a00feaf3974810711d7f5cd480f","scripts":{"build":"rollup -c","clean":"rm -rf dist"},"_npmUser":{"name":"xamuel98","email":"samuelakintomiwa98@gmail.com"},"_npmVersion":"11.16.0","description":"An ADIBA Open Banking API SDK for backoffice console applications","directories":{},"_nodeVersion":"26.3.1","dependencies":{"axios":"^1.14.0"},"_hasShrinkwrap":false,"devDependencies":{"tslib":"^2.8.1","rollup":"^4.60.1","typescript":"^6.0.2","@rollup/plugin-commonjs":"^29.0.2","@rollup/plugin-typescript":"^12.3.0","@rollup/plugin-node-resolve":"^16.0.3"},"_npmOperationalInternal":{"tmp":"tmp/backoffice-console-ob-api-sdk_0.1.1_1782470605302_0.1420423397507662","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@adiba-banking-cloud/backoffice-console-ob-api-sdk","version":"0.1.2","keywords":[],"author":{"name":"TUROG Technologies"},"license":"ISC","_id":"@adiba-banking-cloud/backoffice-console-ob-api-sdk@0.1.2","maintainers":[{"name":"xamuel98","email":"samuelakintomiwa98@gmail.com"},{"name":"adiba-creation-team","email":"devops@turog.ng"}],"dist":{"shasum":"4a7d4999e496d1e24a93b8605d02916383a8bba9","tarball":"https://registry.npmjs.org/@adiba-banking-cloud/backoffice-console-ob-api-sdk/-/backoffice-console-ob-api-sdk-0.1.2.tgz","fileCount":36,"integrity":"sha512-lYad9ton/Sfj28dqeqpKBvpbM6+Lk5iSXR/b6chf5PRuA5NSth2NlsXidpxSV5SKy443kGMiINf0HZgUmlB5cA==","signatures":[{"sig":"MEQCIEWI2ap/f135IJWbEmfofHeiqzck7t5H5OM9W1ipDimCAiAcOyTB93GmowQbElkWSMSAFaau3zhadV59rY+B2vEWHw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":187775},"main":"dist/index.cjs.js","types":"dist/types/index.d.ts","module":"dist/index.esm.js","gitHead":"ecf094b5593ada994120ba26507dc1e34d7d1f15","scripts":{"test":"node --test tests/**/*.test.mjs","build":"rollup -c","clean":"rm -rf dist"},"_npmUser":{"name":"xamuel98","email":"samuelakintomiwa98@gmail.com"},"_npmVersion":"11.16.0","description":"An ADIBA Open Banking API SDK for backoffice console applications","directories":{},"_nodeVersion":"26.3.1","dependencies":{"axios":"^1.14.0"},"_hasShrinkwrap":false,"devDependencies":{"tslib":"^2.8.1","rollup":"^4.60.1","typescript":"^6.0.2","@rollup/plugin-commonjs":"^29.0.2","@rollup/plugin-typescript":"^12.3.0","@rollup/plugin-node-resolve":"^16.0.3"},"_npmOperationalInternal":{"tmp":"tmp/backoffice-console-ob-api-sdk_0.1.2_1782803332306_0.30573638016564053","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@adiba-banking-cloud/backoffice-console-ob-api-sdk","author":{"name":"TUROG Technologies"},"version":"0.1.3","description":"An ADIBA Open Banking API SDK for backoffice console applications","license":"ISC","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/types/index.d.ts","scripts":{"build":"rollup -c","clean":"rm -rf dist","test":"node --test tests/**/*.test.mjs"},"keywords":[],"devDependencies":{"@rollup/plugin-commonjs":"^29.0.2","@rollup/plugin-node-resolve":"^16.0.3","@rollup/plugin-typescript":"^12.3.0","rollup":"^4.60.1","tslib":"^2.8.1","typescript":"^6.0.2"},"dependencies":{"@adiba-banking-cloud/filter-builder":"^0.1.0","axios":"^1.14.0"},"gitHead":"375cc7721aa30b114240b5a1f801f5435145aeae","_id":"@adiba-banking-cloud/backoffice-console-ob-api-sdk@0.1.3","_nodeVersion":"26.3.1","_npmVersion":"11.16.0","dist":{"integrity":"sha512-CHOQgJba95HTdY6BYRW72BEUeI4MsOG9Zg0osBBJ7pxw8dwIFfp4FQWjOwUFYFKYmHp/7Z5XTBLH3lu7CGvnNw==","shasum":"d3d680660c3a01d8f9247ef9a01493b1a08c3b67","tarball":"https://registry.npmjs.org/@adiba-banking-cloud/backoffice-console-ob-api-sdk/-/backoffice-console-ob-api-sdk-0.1.3.tgz","fileCount":38,"unpackedSize":260152,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIC0R2kv6XFVUEb/S6mdDg33L068JZforqN2GkKL2LKeNAiBHeKzq2+AqxR3fMz9QyqKXMx2odKZ39s5VXR1i9Z4a8A=="}]},"_npmUser":{"name":"xamuel98","email":"samuelakintomiwa98@gmail.com"},"directories":{},"maintainers":[{"name":"xamuel98","email":"samuelakintomiwa98@gmail.com"},{"name":"adiba-creation-team","email":"devops@turog.ng"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/backoffice-console-ob-api-sdk_0.1.3_1782812504267_0.673201842803749"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-26T10:43:25.089Z","modified":"2026-06-30T09:41:44.553Z","0.1.1":"2026-06-26T10:43:25.469Z","0.1.2":"2026-06-30T07:08:52.502Z","0.1.3":"2026-06-30T09:41:44.384Z"},"author":{"name":"TUROG Technologies"},"license":"ISC","keywords":[],"description":"An ADIBA Open Banking API SDK for backoffice console applications","maintainers":[{"name":"xamuel98","email":"samuelakintomiwa98@gmail.com"},{"name":"adiba-creation-team","email":"devops@turog.ng"}],"readme":"# @adiba-banking-cloud/backoffice-console-ob-api-sdk\n\nOpen Banking API SDK for ADIBA backoffice console applications.\n\nThis package follows the same runtime/client/export paradigm as the Retail\nEngine SDK, but is sourced from the Open Banking OpenAPI document at\n[`document.yaml`](../document.yaml).\n\n## Collections\n\nThe SDK currently includes typed support for:\n\n- `Applications`\n- `Consents`\n- `Customers`\n- `Dashboard`\n- `Health`\n- `Merchants`\n- `Providers`\n- `Purposes`\n\n## Installation\n\n```bash\nnpm install @adiba-banking-cloud/backoffice-console-ob-api-sdk\n```\n\n## Configuration\n\nConfigure the SDK once at app startup:\n\n```ts\nimport { configureBackofficeOpenBankingSdk } from \"@adiba-banking-cloud/backoffice-console-ob-api-sdk\";\n\nconfigureBackofficeOpenBankingSdk({\n  baseURL: \"https://api.s2.adiba.app/automation/bo\",\n  requireAuth: true,\n  getAccessToken: async () => {\n    return localStorage.getItem(\"access_token\") ?? undefined;\n  },\n  onUnauthorized: async () => {\n    // handle token expiry / redirect to login\n  },\n});\n```\n\nThe SDK prefixes requests with `\"/ob/0.0.1\"` by default. If the API version or\nmount path changes, override it from one place:\n\n```ts\nconfigureBackofficeOpenBankingSdk({\n  baseURL: \"https://api.s2.adiba.app/automation/bo\",\n  apiPathPrefix: \"/ob/1.0.0\",\n});\n```\n\n## Usage\n\n### Applications\n\n```ts\nimport { ApplicationsApi } from \"@adiba-banking-cloud/backoffice-console-ob-api-sdk\";\n\nconst response = await ApplicationsApi.listApplications({\n  page: 1,\n  limit: 10,\n  applicationStatus: \"ACTIVE\",\n});\n\nconsole.log(response.data.data);\n```\n\nList-style collections also expose OData-friendly helpers for search and filter\nuse cases:\n\n```ts\nimport { CustomersApi } from \"@adiba-banking-cloud/backoffice-console-ob-api-sdk\";\n\nconst filteredCustomers = await CustomersApi.queryCustomers(\"Acme\", {\n  customerType: \"BUSINESS\",\n  consentStatus: \"ACTIVE\",\n});\n```\n\n### Providers\n\n```ts\nimport { ProvidersApi } from \"@adiba-banking-cloud/backoffice-console-ob-api-sdk\";\n\nconst response = await ProvidersApi.getProviderByCode(\"TPP-001\");\n\nconsole.log(response.data.tppName);\n```\n\n## Public API\n\n### Runtime exports\n\n- `configureBackofficeOpenBankingSdk`\n- `setApiBaseUrl`\n- `setAccessTokenProvider`\n- `apiClient`\n- `API_ENDPOINTS`\n\n### Feature exports\n\n- `ApplicationsApi`\n- `ConsentsApi`\n- `CustomersApi`\n- `DashboardApi`\n- `HealthApi`\n- `MerchantsApi`\n- `ProvidersApi`\n- `PurposesApi`\n\n### Type exports\n\nThe package re-exports feature types from each collection barrel, including:\n\n- list query params and paginated response shapes\n- create and update request payloads\n- entity summary and detail payloads\n- bulk operation payloads and success responses\n\n## Notes on typing\n\nThis SDK follows `document.yaml` as the source of truth.\n\nWhere the spec provides concrete request or response structures, those are typed\ndirectly. Where the spec has malformed inline schemas or underspecified payloads\n(for example the bulk merchant hold and purpose update bodies), the SDK keeps\nthose payloads intentionally conservative and documented instead of inventing\nfields that were not reliably described.\n\nThe provider creation endpoint is documented as `multipart/form-data`. The SDK\naccepts either a browser `FormData` instance or a typed field object and will\nprepare multipart data when `FormData` is available at runtime.\n\n## Development\n\nBuild the package:\n\n```bash\nnpm run build\n```\n\nType-check the package:\n\n```bash\nnpx tsc --noEmit\n```\n","readmeFilename":"README.md"}