lib/client/sf-gate/docs/TemplatesApi.md

1.8 KiB

SfGate.TemplatesApi

All URIs are relative to http://sf-gate.vernonkeenan.com:8080/v1

Method HTTP request Description
getTemplates GET /templates Get PDF Rendering Templates

getTemplates

TemplateResponse getTemplates(opts)

Get PDF Rendering Templates

Returns the PDF rendering template, or a link to where to get the template

Example

import SfGate from 'sf_gate';
let defaultClient = SfGate.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new SfGate.TemplatesApi();
let opts = {
  'limit': 789, // Number | How many objects to return at one time
  'offset': 789, // Number | How many objects to skip?
  'templateId': "templateId_example" // String | Taxnexus Record Id of a Template
};
apiInstance.getTemplates(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
limit Number How many objects to return at one time [optional]
offset Number How many objects to skip? [optional]
templateId String Taxnexus Record Id of a Template [optional]

Return type

TemplateResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json