Accessing the Node.js SDK object model

Accessing the Node.js SDK object model

Instantiating the models

When making a specific eSignature REST API call using the Node.js SDK, you usually have to include a specific module used for the data sent or returned as part of that API request. The Node.js modules used to pass data to and from API endpoints are called models. We will use the Brand object as an example. The Brand model can be found in our open-source GitHub repository.

brandName is an example of a property of the Brand model. To set the brandName property of a Brand object, use this code:

    brand.brandName = "My Brand";

To get the value of the brandName property, you can simply use the string that it returns:

    console.log("The brand name is ${brand.brandName}");

Most Node.js SDK models also provide a constructor that enables developers to initialize many of the object’s properties at the same time that it is created. For example, you could instantiate a new Brand object and set some of its properties at the same time:

    const brand = {
       brandName: "My Brand",
       defaultBrandLanguage: "en"
    }

Making API calls

To construct an API call, you need to include both the model and the accountId of the account making the API call, each time you make a request. That information is not part of the ApiClient object, but is required by the SDK to be able to generate the URL for the specific endpoint.

For example, to create a new brand, you would instantiate a Brand object and populate it with initial values as shown above, then add the accountId to call the API:

results = await accountsApi.createBrand(args.accountId, { brand: brand })

Naming conventions

The Node.js SDK uses the naming conventions in the Google JavaScript Style Guide. All classes and modules use PascalCase and all functions, methods, parameters, and variables use camelCase.

• The categories in the API Reference are called Apis in the Node.js SDK. As an example, AccountsApi would be the module you use to make API calls for endpoints in the Accounts Category in the API Reference.
• The resources within each category in the API Reference do not have direct counterparts in the Node.js SDK. Instead, each API method in each resource corresponds to a Node.js function within the module corresponding to the top-level category. The function name is always camelCase and is a combination of the verb and the object that is being worked upon. For example, for the AccountBrands:update API method, the Node.js function within the AccountsApi module is updateBrand.
• The parameters for each API method are based on the API Reference. Every API call has to specify the accountId as its first parameter, required to determine which account is making the API request. The remaining parameters are defined per API call in the documentation and may include optional parameters. Parameter names are always written in camelCase.
• The request and response objects (if they exist; some modules have one or the other) are all defined as public functions. These functions are a deserialized version of the JSON that is sent by the REST API. For example, the updateBrand function returns an object called Brand, which represents the response of the API call.

For any array returned by the JSON, the model would include an Array.<T> with elements corresponding to that information where T can be another model or a simple type (typically a string).