Skip to content

TemplateSettingsApi.md

Latest commit

 

History

History
129 lines (83 loc) · 3.8 KB

TemplateSettingsApi.md

File metadata and controls

129 lines (83 loc) · 3.8 KB

.TemplateSettingsApi

All URIs are relative to https://api.pandadoc.com

Method HTTP request Description
templateSettingsGet GET /public/v2/templates/{template_id}/settings Get template settings
templateSettingsUpdate PATCH /public/v2/templates/{template_id}/settings Update template settings

templateSettingsGet

TemplateSettingsResponse templateSettingsGet()

Retrieves the settings for a specified template. Only the language field is currently supported.

Example

import * as pd_api from 'pandadoc-node-client';

// replace it with your API key
const API_KEY = "YOUR_API_KEY";
const configuration = pd_api.createConfiguration(
    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
);
const apiInstance = new pd_api.TemplateSettingsApi(configuration);

const body:pd_api.TemplateSettingsApiTemplateSettingsGetRequest = {
  // string | Unique identifier of the template to retrieve settings for.
  templateId: "BhVzRcxH9Z2LgfPPGXFUBa",
};

apiInstance.templateSettingsGet(body).then((data) => {
  console.log('API called successfully. Returned data: %o', data);
}).catch((error) => console.error(error));

Parameters

Name Type Description Notes
templateId [string] Unique identifier of the template to retrieve settings for. defaults to undefined

Return type

TemplateSettingsResponse

Authorization

apiKey, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successfully retrieved template settings. -

[Back to top] [Back to API list] [Back to README]

templateSettingsUpdate

TemplateSettingsResponse templateSettingsUpdate(updateTemplateSettingsRequest)

Updates the settings for a specified template. Only the language field is currently supported.

Example

import * as pd_api from 'pandadoc-node-client';

// replace it with your API key
const API_KEY = "YOUR_API_KEY";
const configuration = pd_api.createConfiguration(
    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
);
const apiInstance = new pd_api.TemplateSettingsApi(configuration);

const body:pd_api.TemplateSettingsApiTemplateSettingsUpdateRequest = {
  // string | Unique identifier of the template to update settings for.
  templateId: "BhVzRcxH9Z2LgfPPGXFUBa",
  // UpdateTemplateSettingsRequest
  updateTemplateSettingsRequest: {
    language: "en-US",
  },
};

apiInstance.templateSettingsUpdate(body).then((data) => {
  console.log('API called successfully. Returned data: %o', data);
}).catch((error) => console.error(error));

Parameters

Name Type Description Notes
updateTemplateSettingsRequest UpdateTemplateSettingsRequest
templateId [string] Unique identifier of the template to update settings for. defaults to undefined

Return type

TemplateSettingsResponse

Authorization

apiKey, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successfully updated template settings. -

[Back to top] [Back to API list] [Back to README]