zuora-sdk-js v3.2.1

zuora-sdk-js

ZuoraSdkJs - JavaScript client for zuora-sdk-js REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the REST API Overview. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2024-05-20
• Package version: 3.2.1
• Generator version: 7.6.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install zuora-sdk-js --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your zuora-sdk-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ZuoraSdkJs = require('zuora-sdk-js');

var defaultClient = ZuoraSdkJs.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new ZuoraSdkJs.APIHealthApi()
var start_time = new Date("2013-10-20T19:20:30+01:00"); // {Date} Start time of the volume summary.  Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`. 
var end_time = new Date("2013-10-20T19:20:30+01:00"); // {Date} End time of the volume summary.  Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-29T09:07+0800`. 
var opts = {
  'accept_encoding': "accept_encoding_example", // {String} Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
  'content_encoding': "content_encoding_example", // {String} Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
  'authorization': "authorization_example", // {String} The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
  'zuora_entity_ids': "zuora_entity_ids_example", // {String} An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
  'zuora_track_id': "zuora_track_id_example", // {String} A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
  'path': "path_example", // {String} Filters the volume summary by API path name.  You can refer to the api listed in the [API System Health Dashboard](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard) for the path name. Example: `/v1/accounts/{account-key}`. 
  'http_method': "http_method_example", // {String} Filters the volume summary by http method. Example: `Post`. 
  'zuora_version': "'2024-05-20'", // {String} The minor version of the Zuora REST API.  
  'zuora_org_ids': "zuora_org_ids_example" // {String} Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
};
api.getSystemHealthApiVolumeSummary(start_time, end_time, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://rest.zuora.com