Skip to content

clarksnut/clarksnut-csharp-client

Repository files navigation

IO.Swagger - the C# library for the Clarksnut

Clarksnut UBL collector

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

  • API version: 1.2.0-SNAPSHOT
  • SDK version: 1.0.0
  • Build package: 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 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

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 IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out IO.Swagger.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentsApi();
            var documentId = documentId_example;  // string | Document Id

            try
            {
                // Get Document
                DocumentRepresentation result = apiInstance.GetDocument(documentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.GetDocument: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost:8080

Class Method HTTP request Description
DocumentsApi GetDocument GET /api/documents/{documentId} Get Document
DocumentsApi GetDocuments GET /api/documents Get Documents
DocumentsApi GetXml GET /api/documents/{documentId}/download Download Document
DocumentsApi ImportDocument POST /api/documents Import Document
DocumentsApi PrintDocument GET /api/documents/{documentId}/print Print Document
DocumentsApi SearchDocuments POST /api/documents/search Search Document
DocumentsApi UpdateDocument PUT /api/documents/{documentId} Update Document
PartiesApi GetParties GET /api/parties Get parties
ProfileApi CurrentUser PUT /api/profile Update User Profile
ProfileApi GetCurrentUser GET /api/profile Return User Profile
ProfileSpacesApi AddSpaceCollaborators POST /api/profile/spaces/{spaceId}/collaborators Add Space SpaceCollaborators
ProfileSpacesApi DeleteUserSpace DELETE /api/profile/spaces/{spaceId} Delete space
ProfileSpacesApi GetSpaceCollaborators GET /api/profile/spaces/{spaceId}/collaborators Get Space SpaceCollaborators
ProfileSpacesApi GetUserSpace GET /api/profile/spaces/{spaceId} Get Space
ProfileSpacesApi GetUserSpaces GET /api/profile/spaces Get Spaces of user
ProfileSpacesApi RemoveSpaceCollaborators DELETE /api/profile/spaces/{spaceId}/collaborators/{userId} Remove Space SpaceCollaborators
ProfileSpacesApi UpdateUserSpace PUT /api/profile/spaces/{spaceId} Update space
SpaceRequestAccessApi GetRequestAccess GET /request-access
SpaceRequestAccessApi RequestAccessToSpace POST /request-access
SpaceRequestAccessApi UpdateAccessSpace PUT /request-access/{requestId}
SpacesApi CreateSpace POST /api/spaces Create Space
SpacesApi GetSpace GET /api/spaces/{spaceId} Get Space
SpacesApi GetSpaces GET /api/spaces Get Spaces
UsersApi GetUser GET /api/users/{userId} Get User
UsersApi GetUsers GET /api/users Get Users

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Releases

No releases published

Packages

No packages published

Languages