Adobe.IO.Swagger 1.0.0

Adobe Sign C# SDK

Table of contents

• Overview
• Frameworks supported
• Third Party Dependencies
• Installation
• Getting Started
• API Endpoints
• Notes
• Contributing
• Licensing
• Report Issues/Bugs

OverView

Adobe Sign SDK aims at providing an easy way to integrate the Adobe Sign RESTful web service into client applications through easy to consume client side objects wrapping the REST API functionality. This repository contains Adobe Sign’s SDK (CSharp) and samples for these APIs.

This C# SDK is automatically generated by the Swagger Codegen project:

• API version: 6.0.0
• SDK version: 1.0.0
• Build package: io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

• .NET 4.0 or later
• Windows Phone 7.1 (Mango)

Third Party Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.0 or later

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

The IO.Swagger.dll will be generated at <AdobeSignCSharpSDK>/bin.

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.model.agreements;

Getting Started

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.model.agreements;

namespace Example
{
    public class Example
    {
        public void main()
        {

            var apiInstance = new AgreementsApi();
            var authorization = authorization_example;  // string | An OAuth Access Token with scopes: 'agreement_write' in the format 'Bearer {accessToken}'.
            var ifMatch = ifMatch_example;  // string | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned.
            var agreementId = agreementId_example;  // string | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.
            var formFieldPostInfo = new FormFieldPostInfo(); // FormFieldPostInfo | List of form fields to add or replace
            var xApiUser = xApiUser_example;  // string | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) 
            var xOnBehalfOfUser = xOnBehalfOfUser_example;  // string | The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) 

            try
            {
                // Adds template fields to an agreement
                AgreementFormFields result = apiInstance.AddTemplateFieldsToAgreement(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsApi.AddTemplateFieldsToAgreement: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.echosign.com/api/rest/v6

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

Notes

1. All endpoints do not require authorization.
2. Date formats can be changed in SwaggerDateConverter.cs.

      namespace IO.Swagger.Client
      {
          /// <summary>
          /// Formatter for 'date' swagger formats ss defined by full-date - RFC3339
          /// see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
          /// </summary>
          public class SwaggerDateConverter : IsoDateTimeConverter
          {
              /// <summary>
              /// Initializes a new instance of the <see cref="SwaggerDateConverter" /> class.
              /// </summary>
              public SwaggerDateConverter()
              {
                  // full-date   = date-fullyear "-" date-month "-" date-mday
                  DateTimeFormat = "yyyy-MM-ddTHH:mm:ssZ";
              }
          }
      }

3. The enum names in CSharp SDK have missing underscores e.g. OUT_FOR_SIGNATURE will be OUTFORSIGNATURE.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

Recommendation

It's recommended to create an instance of ApiClient per thread and per user (with baseUris fetched for user) in a multithreaded environment to avoid any potential issues.

Report Issues/Bugs

You can report the issues in the issues section of the github repo.