test-deployment-no-conflict v0.1.0

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 TestDeploymentNoConflict 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

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

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 = 133;
    var page = 133;
    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) {

    
    });

deleteDiscount

Deletes a discount

function deleteDiscount(subscriptionId, discountId, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getIncrements

TODO: Add a method description

function getIncrements(subscriptionId, page, size, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var page = 133;
    var size = 133;

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

    
    });

createUsage

Creates a usage

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

Parameters

Example Usage

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

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

    
    });

createSubscriptionItem

Creates a new Subscription item

function createSubscriptionItem(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getUsages

Lists all usages from a subscription item

function getUsages(subscriptionId, itemId, page, size, code, group, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var itemId = item_id;
    var page = 133;
    var size = 133;
    var code = 'code';
    var group = 'group';

    controller.getUsages(subscriptionId, itemId, page, size, code, group, function(error, response, context) {

    
    });

updateSubscriptionBillingDate

Updates the billing date from a subscription

function updateSubscriptionBillingDate(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

updateLatestPeriodEndAt

TODO: Add a method description

function updateLatestPeriodEndAt(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getSubscriptionCycles

TODO: Add a method description

function getSubscriptionCycles(subscriptionId, page, size, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var page = 'page';
    var size = 'size';

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

    
    });

getSubscription

Gets a subscription

function getSubscription(subscriptionId, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;

    controller.getSubscription(subscriptionId, function(error, response, context) {

    
    });

updateSubscriptionAffiliationId

TODO: Add a method description

function updateSubscriptionAffiliationId(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

deleteSubscriptionItem

Deletes a subscription item

function deleteSubscriptionItem(subscriptionId, subscriptionItemId, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

updateSubscriptionCard

Updates the credit card from a subscription

function updateSubscriptionCard(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

updateSubscriptionMetadata

Updates the metadata from a subscription

function updateSubscriptionMetadata(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

updateSubscriptionDueDays

Updates the boleto due days from a subscription

function updateSubscriptionDueDays(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getDiscounts

TODO: Add a method description

function getDiscounts(subscriptionId, page, size, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var page = 133;
    var size = 133;

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

    
    });

createIncrement

Creates a increment

function createIncrement(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getSubscriptions

Gets all subscriptions

function getSubscriptions(page, size, code, billingType, customerId, planId, cardId, status, nextBillingSince, nextBillingUntil, createdSince, createdUntil, callback)

Parameters

Example Usage

    var page = 133;
    var size = 133;
    var code = 'code';
    var billingType = billing_type;
    var customerId = customer_id;
    var planId = plan_id;
    var cardId = card_id;
    var status = 'status';
    var nextBillingSince = date("D M d, Y G:i");
    var nextBillingUntil = 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.getSubscriptions(page, size, code, billingType, customerId, planId, cardId, status, nextBillingSince, nextBillingUntil, createdSince, createdUntil, function(error, response, context) {

    
    });

getDiscountById

TODO: Add a method description

function getDiscountById(subscriptionId, discountId, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var discountId = 'discountId';

    controller.getDiscountById(subscriptionId, discountId, function(error, response, context) {

    
    });

getSubscriptionItems

Get Subscription Items

function getSubscriptionItems(subscriptionId, page, size, name, code, status, description, createdSince, createdUntil, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var page = 133;
    var size = 133;
    var name = 'name';
    var code = 'code';
    var status = 'status';
    var description = 'description';
    var createdSince = created_since;
    var createdUntil = created_until;

    controller.getSubscriptionItems(subscriptionId, page, size, name, code, status, description, createdSince, createdUntil, function(error, response, context) {

    
    });

updateSubscriptionMiniumPrice

Atualização do valor mínimo da assinatura

function updateSubscriptionMiniumPrice(subscriptionId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getUsageReport

TODO: Add a method description

function getUsageReport(subscriptionId, periodId, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;
    var periodId = period_id;

    controller.getUsageReport(subscriptionId, periodId, function(error, response, context) {

    
    });

Back to List of Controllers

OrdersController

Get singleton instance

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

var controller = lib.OrdersController;

updateOrderStatus

TODO: Add a method description

function updateOrderStatus(id, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

deleteAllOrderItems

TODO: Add a method description

function deleteAllOrderItems(orderId, idempotencyKey, callback)

Parameters

Example Usage

    var orderId = 'orderId';
    var idempotencyKey = 'idempotency-key';

    controller.deleteAllOrderItems(orderId, idempotencyKey, function(error, response, context) {

    
    });

updateOrderMetadata

Updates the metadata from an order

function updateOrderMetadata(orderId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getOrders

Gets all orders

function getOrders(page, size, code, status, createdSince, createdUntil, customerId, callback)

Parameters

Example Usage

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

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

    
    });

createOrderItem

TODO: Add a method description

function createOrderItem(orderId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

deleteOrderItem

TODO: Add a method description

function deleteOrderItem(orderId, itemId, idempotencyKey, callback)

Parameters

Example Usage

    var orderId = 'orderId';
    var itemId = 'itemId';
    var idempotencyKey = 'idempotency-key';

    controller.deleteOrderItem(orderId, itemId, idempotencyKey, function(error, response, context) {

    
    });

getOrder

Gets an order

function getOrder(orderId, callback)

Parameters

Example Usage

    var orderId = order_id;

    controller.getOrder(orderId, function(error, response, context) {

    
    });

createOrder

Creates a new Order

function createOrder(body, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getOrderItem

TODO: Add a method description

function getOrderItem(orderId, itemId, callback)

Parameters

Example Usage

    var orderId = 'orderId';
    var itemId = 'itemId';

    controller.getOrderItem(orderId, itemId, function(error, response, context) {

    
    });

updateOrderItem

TODO: Add a method description

function updateOrderItem(orderId, itemId, request, idempotencyKey, callback)

Parameters

Example Usage

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

    controller.updateOrderItem(orderId, itemId, request, idempotencyKey, function(error, response, context) {

    
    });

Back to List of Controllers

PlansController

Get singleton instance

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

var controller = lib.PlansController;

updatePlanItem

Updates a plan item

function updatePlanItem(planId, planItemId, body, idempotencyKey, callback)

Parameters

Example Usage

    var planId = plan_id;
    var planItemId = plan_item_id;
    var body = new UpdatePlanItemRequest({"key":"value"});
    var idempotencyKey = 'idempotency-key';

    controller.updatePlanItem(planId, planItemId, body, idempotencyKey, function(error, response, context) {

    
    });

createPlanItem

Adds a new item to a plan

function createPlanItem(planId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getPlans

Gets all plans

function getPlans(page, size, name, status, billingType, createdSince, createdUntil, callback)

Parameters

Example Usage

    var page = 133;
    var size = 133;
    var name = 'name';
    var status = 'status';
    var billingType = billing_type;
    var createdSince = date("D M d, Y G:i");
    var createdUntil = date("D M d, Y G:i");

    controller.getPlans(page, size, name, status, billingType, createdSince, createdUntil, function(error, response, context) {

    
    });

getPlan

Gets a plan

function getPlan(planId, callback)

Parameters

Example Usage

    var planId = plan_id;

    controller.getPlan(planId, function(error, response, context) {

    
    });

updatePlan

Updates a plan

function updatePlan(planId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

updatePlanMetadata

Updates the metadata from a plan

function updatePlanMetadata(planId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

createPlan

Creates a new plan

function createPlan(body, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

deletePlanItem

Removes an item from a plan

function deletePlanItem(planId, planItemId, idempotencyKey, callback)

Parameters

Example Usage

    var planId = plan_id;
    var planItemId = plan_item_id;
    var idempotencyKey = 'idempotency-key';

    controller.deletePlanItem(planId, planItemId, idempotencyKey, function(error, response, context) {

    
    });

getPlanItem

Gets a plan item

function getPlanItem(planId, planItemId, callback)

Parameters

Example Usage

    var planId = plan_id;
    var planItemId = plan_item_id;

    controller.getPlanItem(planId, planItemId, function(error, response, context) {

    
    });

deletePlan

Deletes a plan

function deletePlan(planId, idempotencyKey, callback)

Parameters

Example Usage

    var planId = plan_id;
    var idempotencyKey = 'idempotency-key';

    controller.deletePlan(planId, idempotencyKey, function(error, response, context) {

    
    });

Back to List of Controllers

InvoicesController

Get singleton instance

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

var controller = lib.InvoicesController;

createInvoice

Create an Invoice

function createInvoice(subscriptionId, cycleId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getPartialInvoice

TODO: Add a method description

function getPartialInvoice(subscriptionId, callback)

Parameters

Example Usage

    var subscriptionId = subscription_id;

    controller.getPartialInvoice(subscriptionId, function(error, response, context) {

    
    });

updateInvoiceStatus

Updates the status from an invoice

function updateInvoiceStatus(invoiceId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

getInvoice

Gets an invoice

function getInvoice(invoiceId, callback)

Parameters

Example Usage

    var invoiceId = invoice_id;

    controller.getInvoice(invoiceId, function(error, response, context) {

    
    });

updateInvoiceMetadata

Updates the metadata from an invoice

function updateInvoiceMetadata(invoiceId, request, idempotencyKey, callback)

Parameters

Example Usage

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

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

    
    });

cancelInvoice

Cancels an invoice

function cancelInvoice(invoiceId, idempotencyKey, callback)

Parameters

Example Usage

    var invoiceId = invoice_id;
    var idempotencyKey = 'idempotency-key';

    controller.cancelInvoice(invoiceId, idempotencyKey, function(error, response, context) {

    
    });

getInvoices

Gets all invoices

function getInvoices(page, size, code, customerId, subscriptionId, createdSince, createdUntil, status, dueSince, dueUntil, callback)

Parameters

Example Usage

    var page = 133;
    var size = 133;
    var code = 'code';
    var customerId = customer_id;
    var subscriptionId = subscription_id;
    var createdSince = date("D M d, Y G:i");
    var createdUntil = date("D M d, Y G:i");
    var status = 'status';
    var dueSince = date("D M d, Y G:i");
    var dueUntil = date("D M d, Y G:i");

    controller.getInvoices(page, size, code, customerId, subscriptionId, createdSince, createdUntil, status, dueSince, dueUntil, function(error, response, context) {

    
    });

Back to List of Controllers

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

| Parameter | Tags | Description | |----------