Skip to content

hellosign/dropbox-sign-dotnet

BranchesTags

Repository files navigation

Dropbox.Sign - the C# library for the Dropbox Sign API

Dropbox Sign v3 API

Migrating from legacy SDK

This SDK is generated from our officially maintained OpenAPI spec. We've made important updates that introduce new functionality and create feature parity between the Dropbox Sign API and the SDK. However, some of these changes are considered "breaking" in the sense that they'll require you to update your existing code in order to continue using the SDK. Please refer to this migration guide for more information.

Contributing

This repo is no longer accepting new issues or Pull Requests. All issues or Pull Requests must be opened against the hellosign/hellosign-openapi repo!

Changes to the SDK code

You must make SDK code changes in the mustache file within the templates directory that corresponds to the file you want updated.

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 3.0.0
  • SDK version: 1.7.0
  • Generator version: 7.8.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Building

You must have docker (or podman linked to docker) installed. Highly recommended to use rootless docker.

Run the following and everything is done for you:

./run-build

Attention: Any changes you have made to the SDK code that you have not made to the OAS file and/or the mustache template files will be lost when you run this command.

Frameworks supported

Dependencies

Installation & Usage

NuGet Package Manager

The Dropbox Sign .NET SDK can be installed using the NuGet package manager, under the package name Dropbox.Sign (package details).

Build from Source

You can follow the NuGet quickstart to create and publish the package via the dotnet CLI. Or, you can create and publish using Visual Studio.

Alternatively, the .nupkg can be published to a local feed or other host and consumed via NuGet as usual.

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System;

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

public class Example
{
    public static void Main()
    {
        var config = new Configuration();
        // Configure HTTP basic authorization: api_key
        config.Username = "YOUR_API_KEY";

        // or, configure Bearer (JWT) authorization: oauth2
        // config.AccessToken = "YOUR_BEARER_TOKEN";

        var accountApi = new AccountApi(config);

        var data = new AccountCreateRequest(
            emailAddress: "[email protected]"
        );

        try
        {
            var result = accountApi.AccountCreate(data);
            Console.WriteLine(result);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountApi AccountCreate POST /account/create Create Account
AccountApi AccountGet GET /account Get Account
AccountApi AccountUpdate PUT /account Update Account
AccountApi AccountVerify POST /account/verify Verify Account
ApiAppApi ApiAppCreate POST /api_app Create API App
ApiAppApi ApiAppDelete DELETE /api_app/{client_id} Delete API App
ApiAppApi ApiAppGet GET /api_app/{client_id} Get API App
ApiAppApi ApiAppList GET /api_app/list List API Apps
ApiAppApi ApiAppUpdate PUT /api_app/{client_id} Update API App
BulkSendJobApi BulkSendJobGet GET /bulk_send_job/{bulk_send_job_id} Get Bulk Send Job
BulkSendJobApi BulkSendJobList GET /bulk_send_job/list List Bulk Send Jobs
EmbeddedApi EmbeddedEditUrl POST /embedded/edit_url/{template_id} Get Embedded Template Edit URL
EmbeddedApi EmbeddedSignUrl GET /embedded/sign_url/{signature_id} Get Embedded Sign URL
FaxApi FaxDelete DELETE /fax/{fax_id} Delete Fax
FaxApi FaxFiles GET /fax/files/{fax_id} List Fax Files
FaxApi FaxGet GET /fax/{fax_id} Get Fax
FaxApi FaxList GET /fax/list Lists Faxes
FaxApi FaxSend POST /fax/send Send Fax
FaxLineApi FaxLineAddUser PUT /fax_line/add_user Add Fax Line User
FaxLineApi FaxLineAreaCodeGet GET /fax_line/area_codes Get Available Fax Line Area Codes
FaxLineApi FaxLineCreate POST /fax_line/create Purchase Fax Line
FaxLineApi FaxLineDelete DELETE /fax_line Delete Fax Line
FaxLineApi FaxLineGet GET /fax_line Get Fax Line
FaxLineApi FaxLineList GET /fax_line/list List Fax Lines
FaxLineApi FaxLineRemoveUser PUT /fax_line/remove_user Remove Fax Line Access
OAuthApi OauthTokenGenerate POST /oauth/token OAuth Token Generate
OAuthApi OauthTokenRefresh POST /oauth/token?refresh OAuth Token Refresh
ReportApi ReportCreate POST /report/create Create Report
SignatureRequestApi SignatureRequestBulkCreateEmbeddedWithTemplate POST /signature_request/bulk_create_embedded_with_template Embedded Bulk Send with Template
SignatureRequestApi SignatureRequestBulkSendWithTemplate POST /signature_request/bulk_send_with_template Bulk Send with Template
SignatureRequestApi SignatureRequestCancel POST /signature_request/cancel/{signature_request_id} Cancel Incomplete Signature Request
SignatureRequestApi SignatureRequestCreateEmbedded POST /signature_request/create_embedded Create Embedded Signature Request
SignatureRequestApi SignatureRequestCreateEmbeddedWithTemplate POST /signature_request/create_embedded_with_template Create Embedded Signature Request with Template
SignatureRequestApi SignatureRequestFiles GET /signature_request/files/{signature_request_id} Download Files
SignatureRequestApi SignatureRequestFilesAsDataUri GET /signature_request/files_as_data_uri/{signature_request_id} Download Files as Data Uri
SignatureRequestApi SignatureRequestFilesAsFileUrl GET /signature_request/files_as_file_url/{signature_request_id} Download Files as File Url
SignatureRequestApi SignatureRequestGet GET /signature_request/{signature_request_id} Get Signature Request
SignatureRequestApi SignatureRequestList GET /signature_request/list List Signature Requests
SignatureRequestApi SignatureRequestReleaseHold POST /signature_request/release_hold/{signature_request_id} Release On-Hold Signature Request
SignatureRequestApi SignatureRequestRemind POST /signature_request/remind/{signature_request_id} Send Request Reminder
SignatureRequestApi SignatureRequestRemove POST /signature_request/remove/{signature_request_id} Remove Signature Request Access
SignatureRequestApi SignatureRequestSend POST /signature_request/send Send Signature Request
SignatureRequestApi SignatureRequestSendWithTemplate POST /signature_request/send_with_template Send with Template
SignatureRequestApi SignatureRequestUpdate POST /signature_request/update/{signature_request_id} Update Signature Request
TeamApi TeamAddMember PUT /team/add_member Add User to Team
TeamApi TeamCreate POST /team/create Create Team
TeamApi TeamDelete DELETE /team/destroy Delete Team
TeamApi TeamGet GET /team Get Team
TeamApi TeamInfo GET /team/info Get Team Info
TeamApi TeamInvites GET /team/invites List Team Invites
TeamApi TeamMembers GET /team/members/{team_id} List Team Members
TeamApi TeamRemoveMember POST /team/remove_member Remove User from Team
TeamApi TeamSubTeams GET /team/sub_teams/{team_id} List Sub Teams
TeamApi TeamUpdate PUT /team Update Team
TemplateApi TemplateAddUser POST /template/add_user/{template_id} Add User to Template
TemplateApi TemplateCreate POST /template/create Create Template
TemplateApi TemplateCreateEmbeddedDraft POST /template/create_embedded_draft Create Embedded Template Draft
TemplateApi TemplateDelete POST /template/delete/{template_id} Delete Template
TemplateApi TemplateFiles GET /template/files/{template_id} Get Template Files
TemplateApi TemplateFilesAsDataUri GET /template/files_as_data_uri/{template_id} Get Template Files as Data Uri
TemplateApi TemplateFilesAsFileUrl GET /template/files_as_file_url/{template_id} Get Template Files as File Url
TemplateApi TemplateGet GET /template/{template_id} Get Template
TemplateApi TemplateList GET /template/list List Templates
TemplateApi TemplateRemoveUser POST /template/remove_user/{template_id} Remove User from Template
TemplateApi TemplateUpdateFiles POST /template/update_files/{template_id} Update Template Files
UnclaimedDraftApi UnclaimedDraftCreate POST /unclaimed_draft/create Create Unclaimed Draft
UnclaimedDraftApi UnclaimedDraftCreateEmbedded POST /unclaimed_draft/create_embedded Create Embedded Unclaimed Draft
UnclaimedDraftApi UnclaimedDraftCreateEmbeddedWithTemplate POST /unclaimed_draft/create_embedded_with_template Create Embedded Unclaimed Draft with Template
UnclaimedDraftApi UnclaimedDraftEditAndResend POST /unclaimed_draft/edit_and_resend/{signature_request_id} Edit and Resend Unclaimed Draft

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

  • Type: HTTP basic authentication

oauth2

  • Type: Bearer Authentication

About

Official C# .NET SDK for the Dropbox Sign API

www.nuget.org/packages/Dropbox.Sign

Topics

dropbox openapi hellosign-api hellosign dropbox-sign

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

3 stars

Watchers

5 watching

Forks

4 forks
Report repository

Releases

12 tags

Contributors 5

Languages