Skip to content

DocumentAttachmentsApi.md

Latest commit

 

History

History
176 lines (119 loc) · 4.64 KB

DocumentAttachmentsApi.md

File metadata and controls

176 lines (119 loc) · 4.64 KB

SignrequestClient.DocumentAttachmentsApi

All URIs are relative to https://signrequest.com/api/v1

Method HTTP request Description
documentAttachmentsCreate POST /document-attachments/ Create a Document Attachment
documentAttachmentsList GET /document-attachments/ Retrieve a list of Document Attachments
documentAttachmentsRead GET /document-attachments/{uuid}/ Retrieve a Document Attachment

documentAttachmentsCreate

DocumentAttachment documentAttachmentsCreate(data)

Create a Document Attachment

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.DocumentAttachmentsApi();

var data = new SignrequestClient.DocumentAttachment(); // DocumentAttachment | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.documentAttachmentsCreate(data, callback);

Parameters

Name Type Description Notes
data DocumentAttachment

Return type

DocumentAttachment

Authorization

Token

HTTP request headers

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

documentAttachmentsList

InlineResponse2001 documentAttachmentsList(opts)

Retrieve a list of Document Attachments

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.DocumentAttachmentsApi();

var opts = { 
  'document__uuid': "document__uuid_example", // String | 
  'document__external_id': "document__external_id_example", // String | 
  'created': "created_example", // String | 
  'page': 56, // Number | A page number within the paginated result set.
  'limit': 56 // Number | Number of results to return per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.documentAttachmentsList(opts, callback);

Parameters

Name Type Description Notes
document__uuid String [optional]
document__external_id String [optional]
created String [optional]
page Number A page number within the paginated result set. [optional]
limit Number Number of results to return per page. [optional]

Return type

InlineResponse2001

Authorization

Token

HTTP request headers

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

documentAttachmentsRead

DocumentAttachment documentAttachmentsRead(uuid)

Retrieve a Document Attachment

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.DocumentAttachmentsApi();

var uuid = "uuid_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.documentAttachmentsRead(uuid, callback);

Parameters

Name Type Description Notes
uuid String

Return type

DocumentAttachment

Authorization

Token

HTTP request headers

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