Skip to content

Latest commit

 

History

History
204 lines (152 loc) · 7.26 KB

GroupBrandsAPI.md

File metadata and controls

204 lines (152 loc) · 7.26 KB
Raw

GroupBrandsAPI

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

Method HTTP request Description
brandsDeleteGroupBrands DELETE /v2.1/accounts/{accountId}/groups/{groupId}/brands Deletes brand information from a group.
brandsGetGroupBrands GET /v2.1/accounts/{accountId}/groups/{groupId}/brands Gets the brand information for a group.
brandsPutGroupBrands PUT /v2.1/accounts/{accountId}/groups/{groupId}/brands Adds an existing brand to a group.

brandsDeleteGroupBrands

    open class func brandsDeleteGroupBrands(accountId: String, groupId: String, brandsRequest: BrandsRequest? = nil, headers: HTTPHeaders = DocuSignAPI.customHeaders, beforeSend: (inout ClientRequest) throws -> () = { _ in }) -> EventLoopFuture<BrandsDeleteGroupBrands>

Deletes brand information from a group.

This method deletes one or more brands from a 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 groupId = "groupId_example" // String | The id of the group.
let brandsRequest = brandsRequest(brands: [brandRequest(brandId: "brandId_example")]) // BrandsRequest |  (optional)

// Deletes brand information from a group.
GroupBrandsAPI.brandsDeleteGroupBrands(accountId: accountId, groupId: groupId, brandsRequest: brandsRequest).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.
groupId String The id of the group.
brandsRequest BrandsRequest [optional]

Return type

BrandsDeleteGroupBrands

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

brandsGetGroupBrands

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

Gets the brand information for a group.

This method returns information about the brands associated with a 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 groupId = "groupId_example" // String | The id of the group.

// Gets the brand information for a group.
GroupBrandsAPI.brandsGetGroupBrands(accountId: accountId, groupId: groupId).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.
groupId String The id of the group.

Return type

BrandsGetGroupBrands

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

brandsPutGroupBrands

    open class func brandsPutGroupBrands(accountId: String, groupId: String, brandsRequest: BrandsRequest? = nil, headers: HTTPHeaders = DocuSignAPI.customHeaders, beforeSend: (inout ClientRequest) throws -> () = { _ in }) -> EventLoopFuture<BrandsPutGroupBrands>

Adds an existing brand to a group.

This method adds one or more existing brands to a group based on the groupId.

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 groupId = "groupId_example" // String | The ID of the group being accessed.
let brandsRequest = brandsRequest(brands: [brandRequest(brandId: "brandId_example")]) // BrandsRequest |  (optional)

// Adds an existing brand to a group.
GroupBrandsAPI.brandsPutGroupBrands(accountId: accountId, groupId: groupId, brandsRequest: brandsRequest).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.
groupId String The ID of the group being accessed.
brandsRequest BrandsRequest [optional]

Return type

BrandsPutGroupBrands

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