UNPKG

mtn-momo-client

Version:

A collection of utils to interact with the mtn-momo api

19 lines (18 loc) 1.1 kB
import type { AxiosInstance } from 'axios'; import type { APIVersion } from '../types'; type CreateProvisioningClientOptions = { /** * The primary key for any of the subscriptions you want to access. Can be found in your momo developer profile under subscriptions * Check out https://momodeveloper.mtn.com/products to subscribe to a product and obtain a subscription key */ subscriptionKey: string; /** The version of the api we are accessing. Defaults to v1. At the time of writing of this user provisions only has one version */ apiVersion?: APIVersion; }; /** * Creates a client to use when creating api requests for provisioning a user * @param {CreateProvisioningClientOptions} options properties to use when creating the client * @returns {AxiosInstance} the client to use when making requests to create the user. Its pre configured with the baseURL and common headers needed for these operations. */ declare const createProvisioningClient: ({ subscriptionKey, apiVersion, }: CreateProvisioningClientOptions) => AxiosInstance; export { createProvisioningClient };