HelloSign 6.0.0-beta.3

.NET 6.0
This is a prerelease version of HelloSign. 
dotnet add package HelloSign --version 6.0.0-beta.3
NuGet\Install-Package HelloSign -Version 6.0.0-beta.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="HelloSign" Version="6.0.0-beta.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add HelloSign --version 6.0.0-beta.3
#r "nuget: HelloSign, 6.0.0-beta.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install HelloSign as a Cake Addin
#addin nuget:?package=HelloSign&version=6.0.0-beta.3&prerelease

// Install HelloSign as a Cake Tool
#tool nuget:?package=HelloSign&version=6.0.0-beta.3&prerelease

HelloSign - the C# library for the HelloSign API

HelloSign v3 API

⚠ This package is not yet ready for production use ⚠

We are working hard on getting this package ready, but it is not there, yet!

You should think twice before using package on anything critical.

The interfaces may change without warning. Backwards compatibility is not yet guaranteed nor implied!

Contributing

Submodule

This repo uses the hellosign/openapi repo as a submodule for its OAS source. When you first clone this repo you must also instantiate the submodule by running the following:

git submodule init
git submodule update --remote

Changes to the OAS

You must make OAS changes in the oas/openapi.yaml file within the hellosign/openapi submodule.

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: 6.0.0-beta.3
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

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.

<a name="frameworks-supported"></a>

Frameworks supported

<a name="dependencies"></a>

Dependencies

<a name="usage"></a>

Installation & Usage

NuGet Package Manager

The HelloSign .NET SDK beta/pre-release can be installed using the NuGet package manager, under the package name HelloSign (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;

<a name="getting-started"></a>

Getting Started

using System;

using HelloSign.Api;
using HelloSign.Client;
using HelloSign.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 apiInstance = new AccountApi(config);

        var data = new AccountCreateRequest(
            emailAddress: "newuser@hellosign.com"
        );

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

<a name="documentation-for-api-endpoints"></a>

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
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 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 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 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 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

<a name="documentation-for-models"></a>

Documentation for Models

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="api_key"></a>

api_key

  • Type: HTTP basic authentication

<a name="oauth2"></a>

oauth2

  • Type: Bearer Authentication
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.0.0-beta.3 1,078 9/19/2022
6.0.0-beta.2 1,715 8/31/2022
1.6.0-beta 1,007 5/18/2022
1.5.4 38,329 2/6/2023
1.5.3 109,066 5/31/2022
1.5.2 3,596 4/28/2022
1.5.1 1,428 4/27/2022
1.3.0 557,809 5/7/2019
1.2.0 1,557 5/6/2019
1.1.0 16,541 2/20/2019
1.0.0 28,601 1/29/2019
0.6.0 6,569 1/28/2019
0.5.9 6,037 1/25/2019
0.5.8 6,465 11/21/2018
0.5.7 27,396 1/25/2018
0.5.6 16,843 5/16/2017
0.5.5 16,661 1/6/2017
0.5.4 1,903 12/22/2016
0.5.3 65,190 7/25/2016
0.5.2 6,183 6/22/2016
0.5.1 2,290 5/10/2016
0.5.0 1,922 5/10/2016

Minor update