Skip to content

squiggle-dev/squiggle-csharp

Repository files navigation

Squiggle - the C# library for the Squiggle API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

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

  • API version: 0.0.1
  • SDK version: 0.2.12
  • Build package: class io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

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

Dependencies

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

Install-Package RestSharp
Install-Package Newtonsoft.Json

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

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

using Squiggle.Api;
using Squiggle.Client;
using Squiggle.Model;

Getting Started

using System;
using System.Diagnostics;
using Squiggle.Api;
using Squiggle.Client;
using Squiggle.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            // Configure API key authorization: jwt
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DefaultApi();
            var data = new Address(); // Address | 

            try
            {
                Address result = apiInstance.AddAddress(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.AddAddress: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.squigglesignatures.com/v1

Class Method HTTP request Description
DefaultApi AddAddress POST /addresses
DefaultApi AddAddressBatch POST /addresses/batch
DefaultApi AddClient POST /clients
DefaultApi AddFile POST /files
DefaultApi AddGlobalTemplate POST /global-templates
DefaultApi AddSnippet POST /snippets
DefaultApi AddTemplate POST /templates
DefaultApi AddUser POST /users
DefaultApi DeleteAddress DELETE /addresses/{id}
DefaultApi DeleteFile DELETE /files/{id}
DefaultApi DeleteGlobalTemplate DELETE /global-templates/{id}
DefaultApi DeleteSnippet DELETE /snippets/{id}
DefaultApi DeleteTemplate DELETE /templates/{id}
DefaultApi DeleteUser DELETE /users/{id}
DefaultApi EditAddress PATCH /addresses/{id}
DefaultApi EditFile PATCH /files/{id}
DefaultApi EditGlobalTemplate PATCH /global-templates/{id}
DefaultApi EditSnippet PATCH /snippets/{id}
DefaultApi EditTemplate PATCH /templates/{id}
DefaultApi EditUser PATCH /users/{id}
DefaultApi FindAddresses GET /addresses
DefaultApi FindFiles GET /files
DefaultApi FindGlobalTemplates GET /global-templates
DefaultApi FindSignatures GET /signatures
DefaultApi FindSnippets GET /snippets
DefaultApi FindTemplates GET /templates
DefaultApi FindUsers GET /users
DefaultApi GenerateAddressAuthCode POST /addresses/generate-auth-code
DefaultApi GenerateAddressAuthCodeById POST /addresses/generate-auth-code/{id}
DefaultApi GetAddress GET /addresses/{id}
DefaultApi GetAddressToken POST /token/address
DefaultApi GetFile GET /files/{id}
DefaultApi GetGlobalTemplate GET /global-templates/{id}
DefaultApi GetImage GET /image/{id}
DefaultApi GetSignature GET /signatures/{id}
DefaultApi GetSnippet GET /snippets/{id}
DefaultApi GetTemplate GET /templates/{id}
DefaultApi GetUser GET /users/{id}
DefaultApi GetUserToken POST /token/user
DefaultApi Render POST /render

Documentation for Models

Documentation for Authorization

jwt

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

C# client for the Squiggle API

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages