8000 GitHub - ajax484/sudo-africa-node
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

ajax484/sudo-africa-node

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📖 SudoAfrica SDK

Easily integrate with Sudo Africa services, providing a comprehensive API for managing customers.

📦 Installation

npm install sudo-africa-node

🚀 Getting Started

Firstly, you need to instantiate the SudoAfrica class:

const SudoAfrica = require('sudoafrica-sdk');
const sudoInstance = new SudoAfrica('YOUR_API_KEY', 'YOUR_BASE_URL');

📝 API

🔷 createCustomer(data)

Create a new customer.

Arguments:

  • data: Object - Customer details.

Returns:

  • Promise - The created customer data.

    🔷 getCustomers(page, limit)

    Retrieve a list of customers.

    Arguments:

    • page: Number (default: 0) - Page number.
    • limit: Number (default: 100) - Number of results per page.

    Returns:

    • Promise - List of customers.

    🔷 getCustomerById(customerId)

    Retrieve a specific customer.

    Arguments:

    • customerId: String - The customer's ID.

    Returns:

    • Promise - The customer's data.

      🔷 updateCustomer(customerId, customerData)

      Update an existing customer.

      Arguments:

      • customerId: String - The customer's ID.
      • customerData: Object - New data for the customer.

      Returns:

      • Promise - The updated customer data.

        🔷 updateCustomerDocumentUrl(customerId, fileName, fileType)

        Update a customer's document URL.

        Arguments:

        • customerId: String - The customer's ID.
        • fileName: String - Name of the file.
        • fileType: String - Type of the file (e.g., 'image').

        Returns:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%
0