Skip to content

Latest commit

 

History

History
190 lines (141 loc) · 7.33 KB

ENoteConfigurationsAPI.md

File metadata and controls

190 lines (141 loc) · 7.33 KB
Raw

ENoteConfigurationsAPI

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

Method HTTP request Description
eNoteConfigurationDeleteENoteConfiguration DELETE /v2.1/accounts/{accountId}/settings/enote_configuration Deletes configuration information for the eNote eOriginal integration.
eNoteConfigurationGetENoteConfiguration GET /v2.1/accounts/{accountId}/settings/enote_configuration Returns the configuration information for the eNote eOriginal integration.
eNoteConfigurationPutENoteConfiguration PUT /v2.1/accounts/{accountId}/settings/enote_configuration Updates configuration information for the eNote eOriginal integration.

eNoteConfigurationDeleteENoteConfiguration

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

Deletes configuration information for the eNote eOriginal integration.

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.

// Deletes configuration information for the eNote eOriginal integration.
ENoteConfigurationsAPI.eNoteConfigurationDeleteENoteConfiguration(accountId: accountId).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.

Return type

ENoteConfigurationDeleteENoteConfiguration

public enum ENoteConfigurationDeleteENoteConfiguration {
    case http200(value: Void?, raw: ClientResponse)
    case http400(value: ErrorDetails?, raw: ClientResponse)
    case http0(value: Void?, 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]

eNoteConfigurationGetENoteConfiguration

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

Returns the configuration information for the eNote eOriginal integration.

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.

// Returns the configuration information for the eNote eOriginal integration.
ENoteConfigurationsAPI.eNoteConfigurationGetENoteConfiguration(accountId: accountId).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.

Return type

ENoteConfigurationGetENoteConfiguration

public enum ENoteConfigurationGetENoteConfiguration {
    case http200(value: ENoteConfiguration?, raw: ClientResponse)
    case http400(value: ErrorDetails?, raw: ClientResponse)
    case http0(value: ENoteConfiguration?, 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]

eNoteConfigurationPutENoteConfiguration

    open class func eNoteConfigurationPutENoteConfiguration(accountId: String, eNoteConfiguration: ENoteConfiguration? = nil, headers: HTTPHeaders = DocuSignAPI.customHeaders, beforeSend: (inout ClientRequest) throws -> () = { _ in }) -> EventLoopFuture<ENoteConfigurationPutENoteConfiguration>

Updates configuration information for the eNote eOriginal integration.

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 eNoteConfiguration = eNoteConfiguration(apiKey: "apiKey_example", connectConfigured: "connectConfigured_example", eNoteConfigured: "eNoteConfigured_example", organization: "organization_example", password: "password_example", userName: "userName_example") // ENoteConfiguration |  (optional)

// Updates configuration information for the eNote eOriginal integration.
ENoteConfigurationsAPI.eNoteConfigurationPutENoteConfiguration(accountId: accountId, eNoteConfiguration: eNoteConfiguration).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.
eNoteConfiguration ENoteConfiguration [optional]

Return type

ENoteConfigurationPutENoteConfiguration

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

Authorization

No authorization required

HTTP request headers

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

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