@classapp-tech/mundiapilib v2.4.0

Disclaimer

This lib was created from a fork of the original Mundipagg NodeJS repo.

Getting started

Mundipagg API

How to Build

The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here

NPM is installed by default when Node is installed

To check if node and npm have been successfully installed, write the following commands in command prompt:

• node --version
• npm -version

Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):

npm install

This will install all dependencies in the node_modules folder.

Once dependencies are resolved, you will need to move the folder MundiAPILib in to your node_modules folder.

How to Use

The following section explains how to use the library in a new project.

1. Open Project Folder

Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on File and select Open Folder.

Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.

2. Creating a Test File

Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:

var lib = require('lib');

Save changes.

3. Running The Test File

To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:

node index.js

How to Test

These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:

Method 1 (Run all tests)

1. Navigate to the root directory of the SDK folder from command prompt.
2. Type mocha --recursive to run all the tests.

Method 2 (Run all tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha * to run all the tests.

Method 3 (Run specific controller's tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha MundiAPIController to run all the tests in that controller file.

To increase mocha's default timeout, you can change the TEST_TIMEOUT parameter's value in TestBootstrap.js.

Initialization

Authentication

In order to setup authentication in the API client, you need the following information.

API client can be initialized as following:

const lib = require('lib');

// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "basicAuthUserName"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "basicAuthPassword"; // The password to use with basic authentication

Class Reference

List of Controllers

• CustomersController
• ChargesController
• RecipientsController
• SubscriptionsController
• InvoicesController
• OrdersController
• TokensController
• PlansController
• TransactionsController
• TransfersController

CustomersController

Get singleton instance

The singleton instance of the CustomersController class can be accessed from the API Client.

var controller = lib.CustomersController;

createAccessToken

Creates a access token for a customer

function createAccessToken(customerId, request, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var request = new CreateAccessTokenRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createAccessToken(customerId, request, idempotencyKey, function(error, response, context) {

    
    });

updateCustomer

Updates a customer

function updateCustomer(customerId, request, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var request = new UpdateCustomerRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateCustomer(customerId, request, idempotencyKey, function(error, response, context) {

    
    });

deleteAccessTokens

Delete a Customer's access tokens

function deleteAccessTokens(customerId, callback)

Parameters

Example Usage

    var customerId = customer_id;

    controller.deleteAccessTokens(customerId, function(error, response, context) {

    
    });

getCustomer

Get a customer

function getCustomer(customerId, callback)

Parameters

Example Usage

    var customerId = customer_id;

    controller.getCustomer(customerId, function(error, response, context) {

    
    });

getAddresses

Gets all adressess from a customer

function getAddresses(customerId, page, size, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var page = 177;
    var size = 177;

    controller.getAddresses(customerId, page, size, function(error, response, context) {

    
    });

getAccessToken

Get a Customer's access token

function getAccessToken(customerId, tokenId, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var tokenId = token_id;

    controller.getAccessToken(customerId, tokenId, function(error, response, context) {

    
    });

getAddress

Get a customer's address

function getAddress(customerId, addressId, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var addressId = address_id;

    controller.getAddress(customerId, addressId, function(error, response, context) {

    
    });

createCard

Creates a new card for a customer

function createCard(customerId, request, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var request = new CreateCardRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createCard(customerId, request, idempotencyKey, function(error, response, context) {

    
    });

renewCard

Renew a card

function renewCard(customerId, cardId, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var cardId = card_id;
    var idempotencyKey = 'idempotency-key';

    controller.renewCard(customerId, cardId, idempotencyKey, function(error, response, context) {

    
    });

createCustomer

Creates a new customer

function createCustomer(request, idempotencyKey, callback)

Parameters

Example Usage

    var request = new CreateCustomerRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createCustomer(request, idempotencyKey, function(error, response, context) {

    
    });

updateAddress

Updates an address

function updateAddress(customerId, addressId, request, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var addressId = address_id;
    var request = new UpdateAddressRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateAddress(customerId, addressId, request, idempotencyKey, function(error, response, context) {

    
    });

getAccessTokens

Get all access tokens from a customer

function getAccessTokens(customerId, page, size, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var page = 177;
    var size = 177;

    controller.getAccessTokens(customerId, page, size, function(error, response, context) {

    
    });

updateCustomerMetadata

Updates the metadata a customer

function updateCustomerMetadata(customerId, request, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var request = new UpdateMetadataRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateCustomerMetadata(customerId, request, idempotencyKey, function(error, response, context) {

    
    });

deleteAddress

Delete a Customer's address

function deleteAddress(customerId, addressId, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var addressId = address_id;
    var idempotencyKey = 'idempotency-key';

    controller.deleteAddress(customerId, addressId, idempotencyKey, function(error, response, context) {

    
    });

updateCard

Updates a card

function updateCard(customerId, cardId, request, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var cardId = card_id;
    var request = new UpdateCardRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateCard(customerId, cardId, request, idempotencyKey, function(error, response, context) {

    
    });

deleteAccessToken

Delete a customer's access token

function deleteAccessToken(customerId, tokenId, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var tokenId = token_id;
    var idempotencyKey = 'idempotency-key';

    controller.deleteAccessToken(customerId, tokenId, idempotencyKey, function(error, response, context) {

    
    });

createAddress

Creates a new address for a customer

function createAddress(customerId, request, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var request = new CreateAddressRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createAddress(customerId, request, idempotencyKey, function(error, response, context) {

    
    });

getCard

Get a customer's card

function getCard(customerId, cardId, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var cardId = card_id;

    controller.getCard(customerId, cardId, function(error, response, context) {

    
    });

getCards

Get all cards from a customer

function getCards(customerId, page, size, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var page = 177;
    var size = 177;

    controller.getCards(customerId, page, size, function(error, response, context) {

    
    });

deleteCard

Delete a customer's card

function deleteCard(customerId, cardId, idempotencyKey, callback)

Parameters

Example Usage

    var customerId = customer_id;
    var cardId = card_id;
    var idempotencyKey = 'idempotency-key';

    controller.deleteCard(customerId, cardId, idempotencyKey, function(error, response, context) {

    
    });

getCustomers

Get all Customers

function getCustomers(name, document, page, size, email, code, callback)

Parameters

Example Usage

    var name = 'name';
    var document = 'document';
    var page = 177;
    var size = 177;
    var email = 'email';
    var code = 'Code';

    controller.getCustomers(name, document, page, size, email, code, function(error, response, context) {

    
    });

Back to List of Controllers

ChargesController

Get singleton instance

The singleton instance of the ChargesController class can be accessed from the API Client.

var controller = lib.ChargesController;

getCharge

Get a charge from its id

function getCharge(chargeId, callback)

Parameters

Example Usage

    var chargeId = charge_id;

    controller.getCharge(chargeId, function(error, response, context) {

    
    });

confirmPayment

TODO: Add a method description

function confirmPayment(chargeId, request, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var request = new CreateConfirmPaymentRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.confirmPayment(chargeId, request, idempotencyKey, function(error, response, context) {

    
    });

updateChargeCard

Updates the card from a charge

function updateChargeCard(chargeId, request, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var request = new UpdateChargeCardRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateChargeCard(chargeId, request, idempotencyKey, function(error, response, context) {

    
    });

getCharges

Lists all charges

function getCharges(page, size, code, status, paymentMethod, customerId, orderId, createdSince, createdUntil, callback)

Parameters

Example Usage

    var page = 177;
    var size = 177;
    var code = 'code';
    var status = 'status';
    var paymentMethod = payment_method;
    var customerId = customer_id;
    var orderId = order_id;
    var createdSince = date("D M d, Y G:i");
    var createdUntil = date("D M d, Y G:i");

    controller.getCharges(page, size, code, status, paymentMethod, customerId, orderId, createdSince, createdUntil, function(error, response, context) {

    
    });

cancelCharge

Cancel a charge

function cancelCharge(chargeId, request, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var request = new CreateCancelChargeRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.cancelCharge(chargeId, request, idempotencyKey, function(error, response, context) {

    
    });

retryCharge

Retries a charge

function retryCharge(chargeId, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var idempotencyKey = 'idempotency-key';

    controller.retryCharge(chargeId, idempotencyKey, function(error, response, context) {

    
    });

updateChargePaymentMethod

Updates a charge's payment method

function updateChargePaymentMethod(chargeId, request, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var request = new UpdateChargePaymentMethodRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateChargePaymentMethod(chargeId, request, idempotencyKey, function(error, response, context) {

    
    });

updateChargeMetadata

Updates the metadata from a charge

function updateChargeMetadata(chargeId, request, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var request = new UpdateMetadataRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateChargeMetadata(chargeId, request, idempotencyKey, function(error, response, context) {

    
    });

captureCharge

Captures a charge

function captureCharge(chargeId, request, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var request = new CreateCaptureChargeRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.captureCharge(chargeId, request, idempotencyKey, function(error, response, context) {

    
    });

updateChargeDueDate

Updates the due date from a charge

function updateChargeDueDate(chargeId, request, idempotencyKey, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var request = new UpdateChargeDueDateRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateChargeDueDate(chargeId, request, idempotencyKey, function(error, response, context) {

    
    });

createCharge

Creates a new charge

function createCharge(request, idempotencyKey, callback)

Parameters

Example Usage

    var request = new CreateChargeRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createCharge(request, idempotencyKey, function(error, response, context) {

    
    });

getChargeTransactions

TODO: Add a method description

function getChargeTransactions(chargeId, page, size, callback)

Parameters

Example Usage

    var chargeId = charge_id;
    var page = 177;
    var size = 177;

    controller.getChargeTransactions(chargeId, page, size, function(error, response, context) {

    
    });

getChargesSummary

TODO: Add a method description

function getChargesSummary(status, createdSince, createdUntil, callback)

Parameters

Example Usage

    var status = 'status';
    var createdSince = date("D M d, Y G:i");
    var createdUntil = date("D M d, Y G:i");

    controller.getChargesSummary(status, createdSince, createdUntil, function(error, response, context) {

    
    });

Back to List of Controllers

RecipientsController

Get singleton instance

The singleton instance of the RecipientsController class can be accessed from the API Client.

var controller = lib.RecipientsController;

updateRecipientMetadata

Updates recipient metadata

function updateRecipientMetadata(recipientId, request, idempotencyKey, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new UpdateMetadataRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateRecipientMetadata(recipientId, request, idempotencyKey, function(error, response, context) {

    
    });

updateRecipientTransferSettings

TODO: Add a method description

function updateRecipientTransferSettings(recipientId, request, idempotencyKey, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new UpdateTransferSettingsRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateRecipientTransferSettings(recipientId, request, idempotencyKey, function(error, response, context) {

    
    });

getAnticipation

Gets an anticipation

function getAnticipation(recipientId, anticipationId, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var anticipationId = anticipation_id;

    controller.getAnticipation(recipientId, anticipationId, function(error, response, context) {

    
    });

getRecipients

Retrieves paginated recipients information

function getRecipients(page, size, callback)

Parameters

Example Usage

    var page = 177;
    var size = 177;

    controller.getRecipients(page, size, function(error, response, context) {

    
    });

getBalance

Get balance information for a recipient

function getBalance(recipientId, callback)

Parameters

Example Usage

    var recipientId = recipient_id;

    controller.getBalance(recipientId, function(error, response, context) {

    
    });

getAnticipations

Retrieves a paginated list of anticipations from a recipient

function getAnticipations(recipientId, page, size, status, timeframe, paymentDateSince, paymentDateUntil, createdSince, createdUntil, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var page = 177;
    var size = 177;
    var status = 'status';
    var timeframe = 'timeframe';
    var paymentDateSince = date("D M d, Y G:i");
    var paymentDateUntil = date("D M d, Y G:i");
    var createdSince = date("D M d, Y G:i");
    var createdUntil = date("D M d, Y G:i");

    controller.getAnticipations(recipientId, page, size, status, timeframe, paymentDateSince, paymentDateUntil, createdSince, createdUntil, function(error, response, context) {

    
    });

createAnticipation

Creates an anticipation

function createAnticipation(recipientId, request, idempotencyKey, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new CreateAnticipationRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createAnticipation(recipientId, request, idempotencyKey, function(error, response, context) {

    
    });

updateRecipientDefaultBankAccount

Updates the default bank account from a recipient

function updateRecipientDefaultBankAccount(recipientId, request, idempotencyKey, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new UpdateRecipientBankAccountRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateRecipientDefaultBankAccount(recipientId, request, idempotencyKey, function(error, response, context) {

    
    });

getRecipient

Retrieves recipient information

function getRecipient(recipientId, callback)

Parameters

Example Usage

    var recipientId = recipient_id;

    controller.getRecipient(recipientId, function(error, response, context) {

    
    });

getAnticipationLimits

Gets the anticipation limits for a recipient

function getAnticipationLimits(recipientId, timeframe, paymentDate, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var timeframe = 'timeframe';
    var paymentDate = date("D M d, Y G:i");

    controller.getAnticipationLimits(recipientId, timeframe, paymentDate, function(error, response, context) {

    
    });

getTransfer

Gets a transfer

function getTransfer(recipientId, transferId, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var transferId = transfer_id;

    controller.getTransfer(recipientId, transferId, function(error, response, context) {

    
    });

getTransfers

Gets a paginated list of transfers for the recipient

function getTransfers(recipientId, page, size, status, createdSince, createdUntil, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var page = 85;
    var size = 85;
    var status = 'status';
    var createdSince = date("D M d, Y G:i");
    var createdUntil = date("D M d, Y G:i");

    controller.getTransfers(recipientId, page, size, status, createdSince, createdUntil, function(error, response, context) {

    
    });

updateRecipient

Updates a recipient

function updateRecipient(recipientId, request, idempotencyKey, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new UpdateRecipientRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateRecipient(recipientId, request, idempotencyKey, function(error, response, context) {

    
    });

createRecipient

Creates a new recipient

function createRecipient(request, idempotencyKey, callback)

Parameters

Example Usage

    var request = new CreateRecipientRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createRecipient(request, idempotencyKey, function(error, response, context) {

    
    });

createTransfer

Creates a transfer for a recipient

function createTransfer(recipientId, request, idempotencyKey, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new CreateTransferRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createTransfer(recipientId, request, idempotencyKey, function(error, response, context) {

    
    });

createWithdraw

TODO: Add a method description

function createWithdraw(recipientId, request, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new CreateWithdrawRequest({"key":"value"});

    controller.createWithdraw(recipientId, request, function(error, response, context) {

    
    });

getWithdrawById

TODO: Add a method description

function getWithdrawById(recipientId, withdrawalId, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var withdrawalId = withdrawal_id;

    controller.getWithdrawById(recipientId, withdrawalId, function(error, response, context) {

    
    });

getWithdrawals

Gets a paginated list of transfers for the recipient

function getWithdrawals(recipientId, page, size, status, createdSince, createdUntil, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var page = 85;
    var size = 85;
    var status = 'status';
    var createdSince = date("D M d, Y G:i");
    var createdUntil = date("D M d, Y G:i");

    controller.getWithdrawals(recipientId, page, size, status, createdSince, createdUntil, function(error, response, context) {

    
    });

updateAutomaticAnticipationSettings

Updates recipient metadata

function updateAutomaticAnticipationSettings(recipientId, request, idempotencyKey, callback)

Parameters

Example Usage

    var recipientId = recipient_id;
    var request = new UpdateAutomaticAnticipationSettingsRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateAutomaticAnticipationSettings(recipientId, request, idempotencyKey, function(error, response, context) {

    
    });

getRecipientByCode

Retrieves recipient information

function getRecipientByCode(code, callback)

Parameters

Example Usage

    var code = 'code';

    controller.getRecipientByCode(code, function(error, response, context) {

    
    });

Back to List of Controllers

SubscriptionsController

Get singleton instance

The singleton instance of the SubscriptionsController class can be accessed from the API Client.

var controller = lib.SubscriptionsController;

createDiscount

Creates a discount

function createDiscount(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var request = new CreateDiscountRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createDiscount(subscriptionId, request, idempotencyKey, function(error, response, context) {

    
    });

getSubscriptionItem

Get Subscription Item

function getSubscriptionItem(subscriptionId, itemId, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var itemId = item_id;

    controller.getSubscriptionItem(subscriptionId, itemId, function(error, response, context) {

    
    });

deleteUsage

Deletes a usage

function deleteUsage(subscriptionId, itemId, usageId, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var itemId = item_id;
    var usageId = usage_id;
    var idempotencyKey = 'idempotency-key';

    controller.deleteUsage(subscriptionId, itemId, usageId, idempotencyKey, function(error, response, context) {

    
    });

cancelSubscription

Cancels a subscription

function cancelSubscription(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var request = new CreateCancelSubscriptionRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.cancelSubscription(subscriptionId, request, idempotencyKey, function(error, response, context) {

    
    });

deleteIncrement

Deletes a increment

function deleteIncrement(subscriptionId, incrementId, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var incrementId = increment_id;
    var idempotencyKey = 'idempotency-key';

    controller.deleteIncrement(subscriptionId, incrementId, idempotencyKey, function(error, response, context) {

    
    });

getSubscriptionCycleById

TODO: Add a method description

function getSubscriptionCycleById(subscriptionId, cycleId, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var cycleId = 'cycleId';

    controller.getSubscriptionCycleById(subscriptionId, cycleId, function(error, response, context) {

    
    });

updateSubscriptionStartAt

Updates the start at date from a subscription

function updateSubscriptionStartAt(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var request = new UpdateSubscriptionStartAtRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateSubscriptionStartAt(subscriptionId, request, idempotencyKey, function(error, response, context) {

    
    });

updateSubscriptionPaymentMethod

Updates the payment method from a subscription

function updateSubscriptionPaymentMethod(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var request = new UpdateSubscriptionPaymentMethodRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateSubscriptionPaymentMethod(subscriptionId, request, idempotencyKey, function(error, response, context) {

    
    });

updateCurrentCycleStatus

TODO: Add a method description

function updateCurrentCycleStatus(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var request = new UpdateCurrentCycleStatusRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateCurrentCycleStatus(subscriptionId, request, idempotencyKey, function(error, response, context) {

    
    });

createSubscription

Creates a new subscription

function createSubscription(body, idempotencyKey, callback)

Parameters

Example Usage

    var body = new CreateSubscriptionRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.createSubscription(body, idempotencyKey, function(error, response, context) {

    
    });

getUsagesDetails

TODO: Add a method description

function getUsagesDetails(subscriptionId, cycleId, size, page, itemId, group, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var cycleId = cycle_id;
    var size = 85;
    var page = 85;
    var itemId = item_id;
    var group = 'group';

    controller.getUsagesDetails(subscriptionId, cycleId, size, page, itemId, group, function(error, response, context) {

    
    });

renewSubscription

TODO: Add a method description

function renewSubscription(subscriptionId, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var idempotencyKey = 'idempotency-key';

    controller.renewSubscription(subscriptionId, idempotencyKey, function(error, response, context) {

    
    });

updateSubscriptionItem

Updates a subscription item

function updateSubscriptionItem(subscriptionId, itemId, body, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var itemId = item_id;
    var body = new UpdateSubscriptionItemRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updateSubscriptionItem(subscriptionId, itemId, body, idempotencyKey, function(error, response, context) {

    
    });

createAnUsage

Create Usage

function createAnUsage(subscriptionId, itemId, idempotencyKey, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var itemId = item_id;
    var idempotencyKey = 'idempotency-key';

    controller.createAnUsage(subscriptionId, itemId, idempotencyKey, function(error, response, context) {

    
    });

getIncrementById

TODO: Add a method description

function getIncrementById(subscriptionId, incrementId, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var incrementId = increment_id;

    controller.getIncrementById(subscriptionId, incrementId, function(error, response, context) {

    
    });

(https://apidocs.io/img/method.png ".SubscriptionsController.delete