Add documentation for all

aspose-barcode-cloud · Mar 24, 2024 · cfe89bf · cfe89bf
1 parent 852daf4
commit cfe89bf
Show file tree

Hide file tree

Showing 91 changed files with 1,261 additions and 2,173 deletions.
diff --git a/example/main.dart b/example/main.dart
@@ -16,8 +16,9 @@ Future<void> main() async {
   )));
 
   // Generate image with barcode
-  final Uint8List generated =
-      await api.getBarcodeGenerate("QR", "text", textLocation: "None");
+  final Uint8List generated = await api.getBarcodeGenerate(
+      EncodeBarcodeType.qR_.toString(), "text",
+      textLocation: "None");
 
   // Save generated image to file
   File(fileName).writeAsBytesSync(generated);
@@ -29,7 +30,7 @@ Future<void> main() async {
   final BarcodeResponseList recognized =
       await api.postBarcodeRecognizeFromUrlOrContent(
     image: formFile,
-    preset: PresetType.highPerformance_.value,
+    preset: PresetType.highPerformance_.toString(),
   );
 
   if (recognized.barcodes != null && recognized.barcodes!.isNotEmpty) {

diff --git a/lib/src/api/barcode_api.dart b/lib/src/api/barcode_api.dart
@@ -5,10 +5,12 @@ import 'package:http/http.dart' show MultipartFile, MultipartRequest;
 import '../../aspose_barcode_cloud.dart';
 import '../api_helper.dart';
 
+/// BarcodeApi
 class BarcodeApi {
-  BarcodeApi(this.apiClient);
+  /// Constructor
+  BarcodeApi(this._apiClient);
 
-  final ApiClient apiClient;
+  final ApiClient _apiClient;
 
   ///
   /// Generate barcode.
@@ -204,7 +206,7 @@ class BarcodeApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
@@ -433,13 +435,13 @@ class BarcodeApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'BarcodeResponseList')
+      return _apiClient.deserialize(response.body, 'BarcodeResponseList')
           as BarcodeResponseList;
     }
   }
@@ -678,13 +680,20 @@ class BarcodeApi {
       }
     } else {}
 
-    final response = await apiClient.invokeAPI(requestPath, 'POST', queryParams,
-        postBody, headerParams, formParams, contentType, authNames);
+    final response = await _apiClient.invokeAPI(
+        requestPath,
+        'POST',
+        queryParams,
+        postBody,
+        headerParams,
+        formParams,
+        contentType,
+        authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'BarcodeResponseList')
+      return _apiClient.deserialize(response.body, 'BarcodeResponseList')
           as BarcodeResponseList;
     }
   }
@@ -717,8 +726,15 @@ class BarcodeApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'POST', queryParams,
-        postBody, headerParams, formParams, contentType, authNames);
+    final response = await _apiClient.invokeAPI(
+        requestPath,
+        'POST',
+        queryParams,
+        postBody,
+        headerParams,
+        formParams,
+        contentType,
+        authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
@@ -938,13 +954,13 @@ class BarcodeApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'ResultImageInfo')
+      return _apiClient.deserialize(response.body, 'ResultImageInfo')
           as ResultImageInfo;
     }
   }
@@ -986,13 +1002,13 @@ class BarcodeApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'BarcodeResponseList')
+      return _apiClient.deserialize(response.body, 'BarcodeResponseList')
           as BarcodeResponseList;
     }
   }
@@ -1034,13 +1050,13 @@ class BarcodeApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'ResultImageInfo')
+      return _apiClient.deserialize(response.body, 'ResultImageInfo')
           as ResultImageInfo;
     }
   }

diff --git a/lib/src/api/file_api.dart b/lib/src/api/file_api.dart
@@ -5,10 +5,12 @@ import 'package:http/http.dart' show MultipartFile, MultipartRequest;
 import '../../aspose_barcode_cloud.dart';
 import '../api_helper.dart';
 
+/// FileApi
 class FileApi {
-  FileApi(this.apiClient);
+  /// Constructor
+  FileApi(this._apiClient);
 
-  final ApiClient apiClient;
+  final ApiClient _apiClient;
 
   ///
   /// Copy file
@@ -50,7 +52,7 @@ class FileApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
@@ -92,7 +94,7 @@ class FileApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(
+    final response = await _apiClient.invokeAPI(
         requestPath,
         'DELETE',
         queryParams,
@@ -141,7 +143,7 @@ class FileApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
@@ -191,7 +193,7 @@ class FileApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
@@ -246,13 +248,13 @@ class FileApi {
       }
     } else {}
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'FilesUploadResult')
+      return _apiClient.deserialize(response.body, 'FilesUploadResult')
           as FilesUploadResult;
     }
   }

diff --git a/lib/src/api/folder_api.dart b/lib/src/api/folder_api.dart
@@ -1,10 +1,12 @@
 import '../../aspose_barcode_cloud.dart';
 import '../api_helper.dart';
 
+/// FolderApi
 class FolderApi {
-  FolderApi(this.apiClient);
+  /// Constructor
+  FolderApi(this._apiClient);
 
-  final ApiClient apiClient;
+  final ApiClient _apiClient;
 
   ///
   /// Copy folder
@@ -40,7 +42,7 @@ class FolderApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
@@ -77,7 +79,7 @@ class FolderApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
@@ -119,7 +121,7 @@ class FolderApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(
+    final response = await _apiClient.invokeAPI(
         requestPath,
         'DELETE',
         queryParams,
@@ -163,13 +165,13 @@ class FolderApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'FilesList') as FilesList;
+      return _apiClient.deserialize(response.body, 'FilesList') as FilesList;
     }
   }
 
@@ -207,7 +209,7 @@ class FolderApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'PUT', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'PUT', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {

diff --git a/lib/src/api/storage_api.dart b/lib/src/api/storage_api.dart
@@ -1,10 +1,12 @@
 import '../../aspose_barcode_cloud.dart';
 import '../api_helper.dart';
 
+/// StorageApi
 class StorageApi {
-  StorageApi(this.apiClient);
+  /// Constructor
+  StorageApi(this._apiClient);
 
-  final ApiClient apiClient;
+  final ApiClient _apiClient;
 
   ///
   /// Get disc usage
@@ -32,13 +34,13 @@ class StorageApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'DiscUsage') as DiscUsage;
+      return _apiClient.deserialize(response.body, 'DiscUsage') as DiscUsage;
     }
   }
 
@@ -70,13 +72,13 @@ class StorageApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'FileVersions')
+      return _apiClient.deserialize(response.body, 'FileVersions')
           as FileVersions;
     }
   }
@@ -113,13 +115,14 @@ class StorageApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'ObjectExist') as ObjectExist;
+      return _apiClient.deserialize(response.body, 'ObjectExist')
+          as ObjectExist;
     }
   }
 
@@ -146,13 +149,13 @@ class StorageApi {
         contentTypes.isNotEmpty ? contentTypes[0] : "application/json";
     final List<String> authNames = ["JWT"];
 
-    final response = await apiClient.invokeAPI(requestPath, 'GET', queryParams,
+    final response = await _apiClient.invokeAPI(requestPath, 'GET', queryParams,
         postBody, headerParams, formParams, contentType, authNames);
 
     if (response.statusCode >= 400) {
       throw ApiException(response.statusCode, response.body);
     } else {
-      return apiClient.deserialize(response.body, 'StorageExist')
+      return _apiClient.deserialize(response.body, 'StorageExist')
           as StorageExist;
     }
   }