Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 3.4 KB

TemplateDocumentHtmlDefinitionsAPI.md

File metadata and controls

71 lines (51 loc) · 3.4 KB
Raw

TemplateDocumentHtmlDefinitionsAPI

All URIs are relative to https://www.docusign.net/restapi

Method HTTP request Description
responsiveHtmlGetTemplateDocumentHtmlDefinitions GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions

responsiveHtmlGetTemplateDocumentHtmlDefinitions

    open class func responsiveHtmlGetTemplateDocumentHtmlDefinitions(accountId: String, documentId: String, templateId: String, headers: HTTPHeaders = DocuSignAPI.customHeaders, beforeSend: (inout ClientRequest) throws -> () = { _ in }) -> EventLoopFuture<ResponsiveHtmlGetTemplateDocumentHtmlDefinitions>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import DocuSignAPI

let accountId = "accountId_example" // String | The external account number (int) or account ID GUID.
let documentId = "documentId_example" // String | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.
let templateId = "templateId_example" // String | The id of the template.

TemplateDocumentHtmlDefinitionsAPI.responsiveHtmlGetTemplateDocumentHtmlDefinitions(accountId: accountId, documentId: documentId, templateId: templateId).whenComplete { result in
    switch result {
    case .failure(let error):
    // process error
    case .success(let response):
        switch response {
        // process decoded response value or raw ClientResponse
        case .http200(let value, let raw):
        case .http400(let value, let raw):
        case .http0(let value, let raw):
        }
    }
}

Parameters

Name Type Description Notes
accountId String The external account number (int) or account ID GUID.
documentId String The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.
templateId String The id of the template.

Return type

ResponsiveHtmlGetTemplateDocumentHtmlDefinitions

public enum ResponsiveHtmlGetTemplateDocumentHtmlDefinitions {
    case http200(value: DocumentHtmlDefinitionOriginals?, raw: ClientResponse)
    case http400(value: ErrorDetails?, raw: ClientResponse)
    case http0(value: DocumentHtmlDefinitionOriginals?, raw: ClientResponse)
}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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