Skip to content

Commit 99e6870

Browse files
committed
Model docstrings improved
1 parent e1af021 commit 99e6870

File tree

224 files changed

+1689
-141
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

224 files changed

+1689
-141
lines changed

sdk/AsposeEmailCloudSdk/models/account_base_request.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,12 @@ class AccountBaseRequest(object):
7171
}
7272

7373
def __init__(self, first_account: str = None, second_account: str = None, storage_folder: StorageFolderLocation = None):
74-
"""AccountBaseRequest - a model defined in Swagger"""
74+
"""
75+
EmailClient accounts request
76+
:param first_account (str) First account storage file name for receiving emails (or universal one)
77+
:param second_account (str) Second account storage file name for sending emails (ignored if first is universal)
78+
:param storage_folder (StorageFolderLocation) Storage folder location of account files
79+
"""
7580

7681
self._first_account = None
7782
self._second_account = None

sdk/AsposeEmailCloudSdk/models/add_attachment_request.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,11 @@ class AddAttachmentRequest(object):
5555
}
5656

5757
def __init__(self, document_folder: StorageFolderLocation = None, attachment_folder: StorageFolderLocation = None):
58-
"""AddAttachmentRequest - a model defined in Swagger"""
58+
"""
59+
Add attachment request
60+
:param document_folder (StorageFolderLocation) Storage folder location of document
61+
:param attachment_folder (StorageFolderLocation) Storage folder location of an attachment
62+
"""
5963

6064
self._document_folder = None
6165
self._attachment_folder = None

sdk/AsposeEmailCloudSdk/models/ai_bcr_base64_image.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,11 @@ class AiBcrBase64Image(AiBcrImage):
5555
}
5656

5757
def __init__(self, is_single: bool = None, base64_data: str = None):
58-
"""AiBcrBase64Image - a model defined in Swagger"""
58+
"""
59+
Image to recognize
60+
:param is_single (bool) Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon
61+
:param base64_data (str) Image data in base64
62+
"""
5963
super(AiBcrBase64Image, self).__init__()
6064

6165
self._base64_data = None

sdk/AsposeEmailCloudSdk/models/ai_bcr_base64_rq.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,11 @@ class AiBcrBase64Rq(AiBcrRq):
5757
}
5858

5959
def __init__(self, options: AiBcrOptions = None, images: List[AiBcrBase64Image] = None):
60-
"""AiBcrBase64Rq - a model defined in Swagger"""
60+
"""
61+
Parse business card image request
62+
:param options (AiBcrOptions) Recognition options
63+
:param images (List[AiBcrBase64Image]) Images to recognize
64+
"""
6165
super(AiBcrBase64Rq, self).__init__()
6266

6367
self._images = None

sdk/AsposeEmailCloudSdk/models/ai_bcr_image.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,10 @@ class AiBcrImage(object):
5656
}
5757

5858
def __init__(self, is_single: bool = None):
59-
"""AiBcrImage - a model defined in Swagger"""
59+
"""
60+
Image for recognition
61+
:param is_single (bool) Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon
62+
"""
6063

6164
self._is_single = None
6265
self.discriminator = 'Type'

sdk/AsposeEmailCloudSdk/models/ai_bcr_image_storage_file.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,11 @@ class AiBcrImageStorageFile(AiBcrImage):
5656
}
5757

5858
def __init__(self, is_single: bool = None, file: StorageFileLocation = None):
59-
"""AiBcrImageStorageFile - a model defined in Swagger"""
59+
"""
60+
Image from storage for recognition
61+
:param is_single (bool) Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon
62+
:param file (StorageFileLocation) Image location
63+
"""
6064
super(AiBcrImageStorageFile, self).__init__()
6165

6266
self._file = None

sdk/AsposeEmailCloudSdk/models/ai_bcr_ocr_data.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,13 @@ class AiBcrOcrData(object):
5959
}
6060

6161
def __init__(self, id: str = None, image: str = None, details: Dict[str, str] = None, data: List[AiBcrOcrDataPart] = None):
62-
"""AiBcrOcrData - a model defined in Swagger"""
62+
"""
63+
Image OCR results
64+
:param id (str) Image identifier
65+
:param image (str) Image with possible pre-processing in Base64
66+
:param details (Dict[str, str]) Additional details from OCR engine
67+
:param data (List[AiBcrOcrDataPart]) OCR results
68+
"""
6369

6470
self._id = None
6571
self._image = None

sdk/AsposeEmailCloudSdk/models/ai_bcr_ocr_data_part.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,15 @@ class AiBcrOcrDataPart(object):
6161
}
6262

6363
def __init__(self, x: float = None, y: float = None, width: float = None, height: float = None, text: str = None, details: Dict[str, str] = None):
64-
"""AiBcrOcrDataPart - a model defined in Swagger"""
64+
"""
65+
Recognized text block
66+
:param x (float) X position of text block
67+
:param y (float) Y position of text block
68+
:param width (float) Width of text block
69+
:param height (float) Height of text block
70+
:param text (str) Recognized text
71+
:param details (Dict[str, str]) Additional recognition result details
72+
"""
6573

6674
self._x = None
6775
self._y = None

sdk/AsposeEmailCloudSdk/models/ai_bcr_options.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,11 @@ class AiBcrOptions(object):
5353
}
5454

5555
def __init__(self, languages: str = None, countries: str = None):
56-
"""AiBcrOptions - a model defined in Swagger"""
56+
"""
57+
Recognition options
58+
:param languages (str) Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default
59+
:param countries (str) Comma-separated codes of countries
60+
"""
5761

5862
self._languages = None
5963
self._countries = None

sdk/AsposeEmailCloudSdk/models/ai_bcr_parse_ocr_data_rq.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,11 @@ class AiBcrParseOcrDataRq(AiBcrRq):
5757
}
5858

5959
def __init__(self, options: AiBcrOptions = None, data: List[AiBcrOcrData] = None):
60-
"""AiBcrParseOcrDataRq - a model defined in Swagger"""
60+
"""
61+
Parse ocr data request
62+
:param options (AiBcrOptions) Recognition options
63+
:param data (List[AiBcrOcrData]) OCR data
64+
"""
6165
super(AiBcrParseOcrDataRq, self).__init__()
6266

6367
self._data = None

0 commit comments

Comments
 (0)