Dropbox.Sign.Api.ApiAppApi

All URIs are relative to https://api.hellosign.com/v3

Method	HTTP request	Description
ApiAppCreate	POST /api_app	Create API App
ApiAppDelete	DELETE /api_app/{client_id}	Delete API App
ApiAppGet	GET /api_app/{client_id}	Get API App
ApiAppList	GET /api_app/list	List API Apps
ApiAppUpdate	PUT /api_app/{client_id}	Update API App

ApiAppCreate

ApiAppGetResponse ApiAppCreate (ApiAppCreateRequest apiAppCreateRequest)

Create API App

Creates a new API App.

Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class ApiAppCreateExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";
        // config.AccessToken = "YOUR_ACCESS_TOKEN";

        var oauth = new SubOAuth(
            callbackUrl: "https://example.com/oauth",
            scopes: [
                SubOAuth.ScopesEnum.BasicAccountInfo,
                SubOAuth.ScopesEnum.RequestSignature,
            ]
        );

        var whiteLabelingOptions = new SubWhiteLabelingOptions(
            primaryButtonColor: "#00b3e6",
            primaryButtonTextColor: "#ffffff"
        );

        var apiAppCreateRequest = new ApiAppCreateRequest(
            name: "My Production App",
            domains: [
                "example.com",
            ],
            customLogoFile: new FileStream(
                path: "CustomLogoFile.png",
                mode: FileMode.Open
            ),
            oauth: oauth,
            whiteLabelingOptions: whiteLabelingOptions
        );

        try
        {
            var response = new ApiAppApi(config).ApiAppCreate(
                apiAppCreateRequest: apiAppCreateRequest
            );

            Console.WriteLine(response);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling ApiAppApi#ApiAppCreate: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Using the ApiAppCreateWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create API App
    ApiResponse<ApiAppGetResponse> response = apiInstance.ApiAppCreateWithHttpInfo(apiAppCreateRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ApiAppApi.ApiAppCreateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
apiAppCreateRequest	ApiAppCreateRequest

Return type

ApiAppGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

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

ApiAppDelete

void ApiAppDelete (string clientId)

Delete API App

Deletes an API App. Can only be invoked for apps you own.

Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class ApiAppDeleteExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";
        // config.AccessToken = "YOUR_ACCESS_TOKEN";

        try
        {
            new ApiAppApi(config).ApiAppDelete(
                clientId: "0dd3b823a682527788c4e40cb7b6f7e9"
            );
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling ApiAppApi#ApiAppDelete: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Using the ApiAppDeleteWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete API App
    apiInstance.ApiAppDeleteWithHttpInfo(clientId);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ApiAppApi.ApiAppDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
clientId	string	The client id of the API App to delete.

Return type

void (empty response body)

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

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

ApiAppGet

ApiAppGetResponse ApiAppGet (string clientId)

Get API App

Returns an object with information about an API App.

Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class ApiAppGetExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";
        // config.AccessToken = "YOUR_ACCESS_TOKEN";

        try
        {
            var response = new ApiAppApi(config).ApiAppGet(
                clientId: "0dd3b823a682527788c4e40cb7b6f7e9"
            );

            Console.WriteLine(response);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling ApiAppApi#ApiAppGet: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Using the ApiAppGetWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get API App
    ApiResponse<ApiAppGetResponse> response = apiInstance.ApiAppGetWithHttpInfo(clientId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ApiAppApi.ApiAppGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
clientId	string	The client id of the API App to retrieve.

Return type

ApiAppGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

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

ApiAppList

ApiAppListResponse ApiAppList (int? page = null, int? pageSize = null)

List API Apps

Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.

Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class ApiAppListExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";
        // config.AccessToken = "YOUR_ACCESS_TOKEN";

        try
        {
            var response = new ApiAppApi(config).ApiAppList(
                page: 1,
                pageSize: 20
            );

            Console.WriteLine(response);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling ApiAppApi#ApiAppList: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Using the ApiAppListWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List API Apps
    ApiResponse<ApiAppListResponse> response = apiInstance.ApiAppListWithHttpInfo(page, pageSize);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ApiAppApi.ApiAppListWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
page	int?	Which page number of the API App List to return. Defaults to `1`.	[optional] [default to 1]
pageSize	int?	Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.	[optional] [default to 20]

Return type

ApiAppListResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

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

ApiAppUpdate

ApiAppGetResponse ApiAppUpdate (string clientId, ApiAppUpdateRequest apiAppUpdateRequest)

Update API App

Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.

Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class ApiAppUpdateExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";
        // config.AccessToken = "YOUR_ACCESS_TOKEN";

        var oauth = new SubOAuth(
            callbackUrl: "https://example.com/oauth",
            scopes: [
                SubOAuth.ScopesEnum.BasicAccountInfo,
                SubOAuth.ScopesEnum.RequestSignature,
            ]
        );

        var whiteLabelingOptions = new SubWhiteLabelingOptions(
            primaryButtonColor: "#00b3e6",
            primaryButtonTextColor: "#ffffff"
        );

        var apiAppUpdateRequest = new ApiAppUpdateRequest(
            callbackUrl: "https://example.com/dropboxsign",
            name: "New Name",
            domains: [
                "example.com",
            ],
            customLogoFile: new FileStream(
                path: "CustomLogoFile.png",
                mode: FileMode.Open
            ),
            oauth: oauth,
            whiteLabelingOptions: whiteLabelingOptions
        );

        try
        {
            var response = new ApiAppApi(config).ApiAppUpdate(
                clientId: "0dd3b823a682527788c4e40cb7b6f7e9",
                apiAppUpdateRequest: apiAppUpdateRequest
            );

            Console.WriteLine(response);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling ApiAppApi#ApiAppUpdate: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Using the ApiAppUpdateWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Update API App
    ApiResponse<ApiAppGetResponse> response = apiInstance.ApiAppUpdateWithHttpInfo(clientId, apiAppUpdateRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ApiAppApi.ApiAppUpdateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
clientId	string	The client id of the API App to update.
apiAppUpdateRequest	ApiAppUpdateRequest

Return type

ApiAppGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

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

Uh oh!

FilesExpand file tree

ApiAppApi.md

Latest commit

History

ApiAppApi.md

File metadata and controls

Dropbox.Sign.Api.ApiAppApi

ApiAppCreate

Example

Using the ApiAppCreateWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApiAppDelete

Example

Using the ApiAppDeleteWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApiAppGet

Example

Using the ApiAppGetWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApiAppList

Example

Using the ApiAppListWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApiAppUpdate

Example

Using the ApiAppUpdateWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details