Skip to content

Latest commit

 

History

History
204 lines (152 loc) · 11.6 KB

SigningGroupUsersAPI.md

File metadata and controls

204 lines (152 loc) · 11.6 KB
Raw

SigningGroupUsersAPI

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

Method HTTP request Description
signingGroupsDeleteSigningGroupUsers DELETE /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users Deletes one or more members from a signing group.
signingGroupsGetSigningGroupUsers GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users Gets a list of members in a Signing Group.
signingGroupsPutSigningGroupUsers PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users Adds members to a signing group.

signingGroupsDeleteSigningGroupUsers

    open class func signingGroupsDeleteSigningGroupUsers(accountId: String, signingGroupId: String, signingGroupUsers: SigningGroupUsers? = nil, headers: HTTPHeaders = DocuSignAPI.customHeaders, beforeSend: (inout ClientRequest) throws -> () = { _ in }) -> EventLoopFuture<SigningGroupsDeleteSigningGroupUsers>

Deletes one or more members from a signing group.

Deletes one or more members from the specified signing group.

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 signingGroupId = "signingGroupId_example" // String | Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).  **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. 
let signingGroupUsers = SigningGroupUsers(users: [signingGroupUser(email: "email_example", errorDetails: errorDetails(errorCode: "errorCode_example", message: "message_example"), userName: "userName_example")]) // SigningGroupUsers | A complex type that contains information about users in the signing group. (optional)

// Deletes  one or more members from a signing group.
SigningGroupUsersAPI.signingGroupsDeleteSigningGroupUsers(accountId: accountId, signingGroupId: signingGroupId, signingGroupUsers: signingGroupUsers).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.
signingGroupId String Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy.
signingGroupUsers SigningGroupUsers A complex type that contains information about users in the signing group. [optional]

Return type

SigningGroupsDeleteSigningGroupUsers

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

signingGroupsGetSigningGroupUsers

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

Gets a list of members in a Signing Group.

Retrieves the list of members in the specified Signing Group.

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 signingGroupId = "signingGroupId_example" // String | Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).  **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. 

// Gets a list of members in a Signing Group.
SigningGroupUsersAPI.signingGroupsGetSigningGroupUsers(accountId: accountId, signingGroupId: signingGroupId).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.
signingGroupId String Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy.

Return type

SigningGroupsGetSigningGroupUsers

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

signingGroupsPutSigningGroupUsers

    open class func signingGroupsPutSigningGroupUsers(accountId: String, signingGroupId: String, signingGroupUsers: SigningGroupUsers? = nil, headers: HTTPHeaders = DocuSignAPI.customHeaders, beforeSend: (inout ClientRequest) throws -> () = { _ in }) -> EventLoopFuture<SigningGroupsPutSigningGroupUsers>

Adds members to a signing group.

Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.

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 signingGroupId = "signingGroupId_example" // String | Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).  **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. 
let signingGroupUsers = SigningGroupUsers(users: [signingGroupUser(email: "email_example", errorDetails: errorDetails(errorCode: "errorCode_example", message: "message_example"), userName: "userName_example")]) // SigningGroupUsers | A complex type that contains information about users in the signing group. (optional)

// Adds members to a signing group. 
SigningGroupUsersAPI.signingGroupsPutSigningGroupUsers(accountId: accountId, signingGroupId: signingGroupId, signingGroupUsers: signingGroupUsers).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.
signingGroupId String Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy.
signingGroupUsers SigningGroupUsers A complex type that contains information about users in the signing group. [optional]

Return type

SigningGroupsPutSigningGroupUsers

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