Rename ClientApi to DocApi.

Author: jqr

README.md

@@ -33,7 +33,7 @@ using System.IO;
 class Example {
   static void Main(string[] args) {
     Configuration.Username = "YOUR_API_KEY_HERE"; // this key works for test documents
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
 
     Doc doc = new Doc();
     doc.Test = true;                                                        // test documents are free but watermarked

docraptor.yaml

@@ -10,7 +10,7 @@ schemes: [https]
 securityDefinitions:
   basicAuth:
     type: basic
-    description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
+    description: Use your API key as the username. Password does not need to be set.
 produces:
   - application/json
   - application/xml
@@ -22,11 +22,10 @@ paths:
   /docs:
     post:
       operationId: createDoc
-      tags: [Client]
+      tags: [Doc]
       description: >
         Creates a document synchronously.
       security:
-
         - basicAuth: []
       parameters:
         - name: doc
@@ -54,7 +53,7 @@ paths:
   /async_docs:
     post:
       operationId: createAsyncDoc
-      tags: [Client]
+      tags: [Doc]
       description: >
         Creates a document asynchronously.
         You must use a callback url or the the returned status id and the status api to find out when it completes.
@@ -87,11 +86,10 @@ paths:
   /status/{id}:
     get:
       operationId: getAsyncDocStatus
-      tags: [Client]
+      tags: [Doc]
       description: >
         Check on the status of an asynchronously created document.
       security:
-
         - basicAuth: []
       parameters:
         - name: id
@@ -112,15 +110,13 @@ paths:
         500:
           description: Server Error
 
-
   /download/{id}:
     get:
       operationId: getAsyncDoc
-      tags: [Client]
-      description:
+      tags: [Doc]
+      description: >
         Downloads a document.
       security:
-
         - basicAuth: []
       parameters:
         - name: id

examples/async.cs

@@ -21,7 +21,7 @@ class AsyncTest {
   static void Main(string[] args) {
     try {
       Configuration.Default.Username = "YOUR_API_KEY_HERE"; // this key works for test documents
-      ClientApi docraptor = new ClientApi();
+      DocApi docraptor = new DocApi();
 
       Doc doc = new Doc();
       doc.Test = true;                                                        // test documents are free but watermarked

examples/sync.cs

@@ -22,7 +22,7 @@ class SyncTest {
   static void Main(string[] args) {
     try {
       Configuration.Default.Username = "YOUR_API_KEY_HERE"; // this key works for test documents
-      ClientApi docraptor = new ClientApi();
+      DocApi docraptor = new DocApi();
 
       Doc doc = new Doc();
       doc.Test = true;                                                        // test documents are free but watermarked

…c/main/csharp/DocRaptor/Api/ClientApi.cs src/main/csharp/DocRaptor/Api/DocApi.cssrc/main/csharp/DocRaptor/Api/ClientApi.cs renamed to src/main/csharp/DocRaptor/Api/DocApi.cs src/main/csharp/DocRaptor/Api/ClientApi.cs renamed to src/main/csharp/DocRaptor/Api/DocApi.cs

@@ -12,7 +12,7 @@ namespace DocRaptor.Api
     /// <summary>
     /// Represents a collection of functions to interact with the API endpoints
     /// </summary>
-    public interface IClientApi
+    public interface IDocApi
     {
 
         /// <summary>
@@ -180,24 +180,24 @@ public interface IClientApi
     /// <summary>
     /// Represents a collection of functions to interact with the API endpoints
     /// </summary>
-    public class ClientApi : IClientApi
+    public class DocApi : IDocApi
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="ClientApi"/> class.
+        /// Initializes a new instance of the <see cref="DocApi"/> class.
         /// </summary>
         /// <returns></returns>
-        public ClientApi(String basePath)
+        public DocApi(String basePath)
         {
             this.Configuration = new Configuration(new ApiClient(basePath));
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ClientApi"/> class
+        /// Initializes a new instance of the <see cref="DocApi"/> class
         /// using Configuration object
         /// </summary>
         /// <param name="configuration">An instance of Configuration</param>
         /// <returns></returns>
-        public ClientApi(Configuration configuration = null)
+        public DocApi(Configuration configuration = null)
         {
             if (configuration == null) // use the default one in Configuration
                 this.Configuration = Configuration.Default; 
@@ -274,7 +274,7 @@ public ApiResponse< AsyncDoc > CreateAsyncDocWithHttpInfo (Doc doc)
 
             // verify the required parameter 'doc' is set
             if (doc == null)
-                throw new ApiException(400, "Missing required parameter 'doc' when calling ClientApi->CreateAsyncDoc");
+                throw new ApiException(400, "Missing required parameter 'doc' when calling DocApi->CreateAsyncDoc");
 
 
             var path_ = "/async_docs";
@@ -448,7 +448,7 @@ public ApiResponse< byte[] > CreateDocWithHttpInfo (Doc doc)
 
             // verify the required parameter 'doc' is set
             if (doc == null)
-                throw new ApiException(400, "Missing required parameter 'doc' when calling ClientApi->CreateDoc");
+                throw new ApiException(400, "Missing required parameter 'doc' when calling DocApi->CreateDoc");
 
 
             var path_ = "/docs";
@@ -622,7 +622,7 @@ public ApiResponse< byte[] > GetAsyncDocWithHttpInfo (string id)
 
             // verify the required parameter 'id' is set
             if (id == null)
-                throw new ApiException(400, "Missing required parameter 'id' when calling ClientApi->GetAsyncDoc");
+                throw new ApiException(400, "Missing required parameter 'id' when calling DocApi->GetAsyncDoc");
 
 
             var path_ = "/download/{id}";
@@ -790,7 +790,7 @@ public ApiResponse< AsyncDocStatus > GetAsyncDocStatusWithHttpInfo (string id)
 
             // verify the required parameter 'id' is set
             if (id == null)
-                throw new ApiException(400, "Missing required parameter 'id' when calling ClientApi->GetAsyncDocStatus");
+                throw new ApiException(400, "Missing required parameter 'id' when calling DocApi->GetAsyncDocStatus");
 
 
             var path_ = "/status/{id}";

test/async.cs

@@ -8,7 +8,7 @@ class AsyncTest {
   static void Main(string[] args) {
     Configuration.Default.Username = "YOUR_API_KEY_HERE";
     // Configuration.Default.Debug = true; // Not supported in Csharp
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
 
     Doc doc = new Doc();
     doc.Name = "csharp-async.pdf";

test/invalid_async.cs

@@ -8,7 +8,7 @@ class InvalidAsyncTest {
   static void Main(string[] args) {
     Configuration.Default.Username = "YOUR_API_KEY_HERE";
     // Configuration.Default.Debug = true; // Not supported in Csharp
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
 
     Doc doc = new Doc();
     doc.Name = new String('s', 201); // limit is 200 characters

test/invalid_sync.cs

@@ -9,7 +9,7 @@ class InvalidSyncTest {
   static void Main(string[] args) {
     Configuration.Default.Username = "YOUR_API_KEY_HERE";
     // Configuration.Default.Debug = true; // Not supported in Csharp
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
 
     Doc doc = new Doc();
     doc.Name = new String('s', 201); // limit is 200 characters

test/sync.cs

@@ -9,7 +9,7 @@ class SyncTest {
   static void Main(string[] args) {
     Configuration.Default.Username = "YOUR_API_KEY_HERE";
     // Configuration.Default.Debug = true; // Not supported in Csharp
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
 
     Doc doc = new Doc();
     doc.Name = "csharp-sync.pdf";

test/xlsx.cs

@@ -9,7 +9,7 @@ class XlsxTest {
   static void Main(string[] args) {
     Configuration.Default.Username = "YOUR_API_KEY_HERE";
     // Configuration.Default.Debug = true; // Not supported in Csharp
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
 
     Doc doc = new Doc();
     doc.Name = "csharp-xlsx.xlsx";