Skip to content

Commit f24531b

Browse files
Marat-GumerovMarat-Gumerov
authored
Merge pull request #17 from aspose-email-cloud/develop
Develop
2 parents 777199c + 8d7fd11 commit f24531b

File tree

549 files changed

+37122
-1889
lines changed

Some content is hidden

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

549 files changed

+37122
-1889
lines changed

‎README.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,16 @@ Aspose.Email Cloud is a REST API for creating email applications that work with
2121
- Email configuration discovery.
2222
- Disposable email address detection.
2323

24-
## New features in version 20.9
24+
## New features in version 20.10
2525

26-
Aspose.Email Cloud SDK 20.9.0 is based on a new v4.0 REST API.
26+
Aspose.Email Cloud 20.10.0 comes with SDK improvements:
2727

28-
- All SDK functions are divided into groups (Email, Calendar, Contact, Client, Ai, Mapi, etc.).
29-
- Unified file API provided for supported file types (Save, Get, Convert, AsFile, FromFile, AsMapi/AsDto).
30-
- HierarchicalObject based API is removed.
31-
- All models are stored in one folder/namespace.
32-
- The request models are simplified.
28+
- Typescript, PHP, Java SDKs now have model builders to simplify their initialization.
29+
- All SDK methods now have code examples with parameters initialization.
30+
- Some models now have initialization examples for all SDKs.
31+
- SDK reference documentation with examples now available at url [docs.aspose.cloud/email/reference-api](https://docs.aspose.cloud/email/reference-api/)
3332

34-
See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-9-release-notes/).
33+
See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-10-release-notes/).
3534

3635
## How to use the SDK?
3736
The complete source code is available in the [GIT repository](https://github.com/aspose-email-cloud/aspose-email-cloud-java/tree/master/src/main/java/com/aspose/email/cloud/sdk).

‎docs/AiBcrApi.md‎

Lines changed: 243 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,264 @@
1-
# AiBcrApi
1+
# AiBcrApi (EmailCloud.ai().bcr())
2+
3+
AI Business card recognition operations.
24

3-
45
<a name="parse"></a>
5-
# **parse**
6-
> [ContactList](ContactList.md) parse(AiBcrParseRequest request)
6+
## parse
7+
8+
Description: Parse images to vCard document models
79

8-
Parse images to vCard document models
10+
Returns: List of vCards
911

10-
### **AiBcrParseRequest** Parameters
12+
Method call example:
1113
```java
12-
public AiBcrParseRequest(
13-
byte[] file,
14-
String countries,
15-
String languages,
16-
Boolean isSingle)
14+
ContactList result = api.ai().bcr().parse(request);
1715
```
1816

19-
Name | Type | Description | Notes
20-
---- | ---- | ----------- | -----
21-
**file** | **byte[]**| File to parse |
22-
**countries** | **String**| Comma-separated codes of countries. | [optional] [default to ]
23-
**languages** | **String**| Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \&quot;it\&quot; or \&quot;ita\&quot; for Italian); it&#39;s \&quot;\&quot; by default. | [optional] [default to ]
24-
**isSingle** | **Boolean**| Determines that image contains single VCard or more. | [optional] [default to true]
2517

26-
### Return type
18+
### Parameter: request
19+
20+
Description: parse method request.
21+
22+
See parameter model documentation at [AiBcrParseRequest](AiBcrParseRequest.md).
23+
24+
<details>
25+
<summary>Parameter initialization example:</summary>
26+
27+
```java
28+
AiBcrParseRequest request = Models.aiBcrParseRequest()
29+
.file(IOUtils.toByteArray(new FileInputStream("/path/to/image.png")))
30+
.countries("us")
31+
.languages("en")
32+
.isSingle(true)
33+
.build();
34+
```
35+
36+
</details>
37+
38+
### Result
39+
40+
Description: List of vCards
41+
42+
Return type: [**ContactList**](ContactList.md)
43+
44+
<details>
45+
<summary>Result example</summary>
46+
47+
```java
48+
result = Models.contactList()
49+
.value(Arrays.<ContactDto>asList(
50+
Models.contactDto()
51+
.attachments(Arrays.<Attachment>asList(
52+
Models.attachment()
53+
.name("attachment.txt")
54+
.base64Data("U29tZSBmaWxlIGNvbnRlbnQ=")
55+
.build()))
56+
.displayName("Alex Thomas")
57+
.emailAddresses(Arrays.<EmailAddress>asList(
58+
Models.emailAddress()
59+
.category(Models.enumWithCustomOfEmailAddressCategory()
60+
.value("Custom")
61+
.description("Partners")
62+
.build())
63+
.displayName("Alex Thomas Partners")
64+
.preferred(true)
65+
.address("email@aspose.com")
66+
.build()))
67+
.gender("Male")
68+
.givenName("Alex")
69+
.phoneNumbers(Arrays.<PhoneNumber>asList(
70+
Models.phoneNumber()
71+
.category(Models.enumWithCustomOfPhoneNumberCategory()
72+
.value("Office")
73+
.build())
74+
.number("+49 211 4247 21")
75+
.preferred(true)
76+
.build()))
77+
.profession("GENERAL DIRECTOR")
78+
.surname("Thomas")
79+
.urls(Arrays.<Url>asList(
80+
Models.url()
81+
.category(Models.enumWithCustomOfUrlCategory()
82+
.value("Work")
83+
.build())
84+
.preferred(true)
85+
.href("www.aspose.com")
86+
.build()))
87+
.build()))
88+
.build();
89+
```
90+
</details>
91+
92+
### Complete example
93+
94+
<details>
95+
<summary>Method call example:</summary>
96+
97+
```java
98+
EmailCloud api = new EmailCloud(appKey, appSid);
99+
100+
// Prepare parameters:
101+
AiBcrParseRequest request = Models.aiBcrParseRequest()
102+
.file(IOUtils.toByteArray(new FileInputStream("/path/to/image.png")))
103+
.countries("us")
104+
.languages("en")
105+
.isSingle(true)
106+
.build();
107+
108+
// Call method:
109+
ContactList result = api.ai().bcr().parse(request);
110+
111+
// Result example:
112+
result = Models.contactList()
113+
.value(Arrays.<ContactDto>asList(
114+
Models.contactDto()
115+
.attachments(Arrays.<Attachment>asList(
116+
Models.attachment()
117+
.name("attachment.txt")
118+
.base64Data("U29tZSBmaWxlIGNvbnRlbnQ=")
119+
.build()))
120+
.displayName("Alex Thomas")
121+
.emailAddresses(Arrays.<EmailAddress>asList(
122+
Models.emailAddress()
123+
.category(Models.enumWithCustomOfEmailAddressCategory()
124+
.value("Custom")
125+
.description("Partners")
126+
.build())
127+
.displayName("Alex Thomas Partners")
128+
.preferred(true)
129+
.address("email@aspose.com")
130+
.build()))
131+
.gender("Male")
132+
.givenName("Alex")
133+
.phoneNumbers(Arrays.<PhoneNumber>asList(
134+
Models.phoneNumber()
135+
.category(Models.enumWithCustomOfPhoneNumberCategory()
136+
.value("Office")
137+
.build())
138+
.number("+49 211 4247 21")
139+
.preferred(true)
140+
.build()))
141+
.profession("GENERAL DIRECTOR")
142+
.surname("Thomas")
143+
.urls(Arrays.<Url>asList(
144+
Models.url()
145+
.category(Models.enumWithCustomOfUrlCategory()
146+
.value("Work")
147+
.build())
148+
.preferred(true)
149+
.href("www.aspose.com")
150+
.build()))
151+
.build()))
152+
.build();
153+
154+
```
27155

28-
[**ContactList**](ContactList.md)
156+
</details>
29157

30158
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to API README]](README.md)
31159

32-
33160
<a name="parseStorage"></a>
34-
# parseStorage
35-
> [StorageFileLocationList](StorageFileLocationList.md) parseStorage([AiBcrParseStorageRequest](AiBcrParseStorageRequest.md) request)
161+
## parseStorage
36162

37-
Parse images from storage to vCard files
163+
Description: Parse images from storage to vCard files
38164

39-
### request Parameter
165+
Returns: List of vCard files located on storage
166+
167+
Method call example:
168+
```java
169+
StorageFileLocationList result = api.ai().bcr().parseStorage(request);
170+
```
171+
172+
### Parameter: request
173+
174+
Description: Request with images located on storage
40175

41176
See parameter model documentation at [AiBcrParseStorageRequest](AiBcrParseStorageRequest.md)
42177

43-
### Return type
178+
<details>
179+
<summary>Parameter initialization example:</summary>
180+
181+
```java
182+
AiBcrParseStorageRequest request = Models.aiBcrParseStorageRequest()
183+
.outFolder(Models.storageFolderLocation()
184+
.storage("First Storage")
185+
.folderPath("VCard/files/produced/by/parser/will/be/placed/here")
186+
.build())
187+
.images(Arrays.<AiBcrImageStorageFile>asList(
188+
Models.aiBcrImageStorageFile()
189+
.file(Models.storageFileLocation()
190+
.fileName("VCardScanImage.jpg")
191+
.storage("First Storage")
192+
.folderPath("image/location/on/storage")
193+
.build())
194+
.isSingle(true)
195+
.build()))
196+
.build();
197+
```
198+
199+
</details>
200+
201+
202+
### Result
203+
204+
Description: List of vCard files located on storage
205+
206+
Return type: [**StorageFileLocationList**](StorageFileLocationList.md)
207+
208+
<details>
209+
<summary>Result example</summary>
210+
211+
```java
212+
result = Models.storageFileLocationList()
213+
.value(Arrays.<StorageFileLocation>asList(
214+
Models.storageFileLocation()
215+
.fileName("fileOnStorage.txt")
216+
.storage("First Storage")
217+
.folderPath("file/location/folder/on/storage")
218+
.build()))
219+
.build();
220+
```
221+
</details>
222+
223+
### Complete example
224+
225+
<details>
226+
<summary>Method call example:</summary>
227+
228+
```java
229+
EmailCloud api = new EmailCloud(appKey, appSid);
230+
231+
// Prepare parameters:
232+
AiBcrParseStorageRequest request = Models.aiBcrParseStorageRequest()
233+
.outFolder(Models.storageFolderLocation()
234+
.storage("First Storage")
235+
.folderPath("VCard/files/produced/by/parser/will/be/placed/here")
236+
.build())
237+
.images(Arrays.<AiBcrImageStorageFile>asList(
238+
Models.aiBcrImageStorageFile()
239+
.file(Models.storageFileLocation()
240+
.fileName("VCardScanImage.jpg")
241+
.storage("First Storage")
242+
.folderPath("image/location/on/storage")
243+
.build())
244+
.isSingle(true)
245+
.build()))
246+
.build();
247+
248+
// Call method:
249+
StorageFileLocationList result = api.ai().bcr().parseStorage(request);
250+
251+
// Result example:
252+
result = Models.storageFileLocationList()
253+
.value(Arrays.<StorageFileLocation>asList(
254+
Models.storageFileLocation()
255+
.fileName("fileOnStorage.txt")
256+
.storage("First Storage")
257+
.folderPath("file/location/folder/on/storage")
258+
.build()))
259+
.build();
260+
```
44261

45-
[**StorageFileLocationList**](StorageFileLocationList.md)
262+
</details>
46263

47264
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to API README]](README.md)

‎docs/AiBcrImage.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
21
# AiBcrImage
2+
3+
Image for recognition
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------
@@ -9,4 +11,3 @@ Name | Type | Description | Notes
911

1012

1113
[[Back to Model list]](Models.md) [[Back to API README]](README.md)
12-

‎docs/AiBcrImageStorageFile.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
1-
21
# AiBcrImageStorageFile
2+
3+
Image from storage for recognition
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------
68
**file** | [**StorageFileLocation**](StorageFileLocation.md) | Image location |
79

8-
910
## Parent class
1011

1112
See: [AiBcrImage](AiBcrImage.md)
1213

13-
[[Back to Model list]](Models.md) [[Back to API README]](README.md)
1414

15+
## Example
16+
```java
17+
AiBcrImageStorageFile aiBcrImageStorageFile = Models.aiBcrImageStorageFile()
18+
.file(Models.storageFileLocation()
19+
.fileName("VCardScanImage.jpg")
20+
.storage("First Storage")
21+
.folderPath("image/location/on/storage")
22+
.build())
23+
.isSingle(true)
24+
.build();
25+
```
26+
27+
28+
[[Back to Model list]](Models.md) [[Back to API README]](README.md)

‎docs/AiBcrOptions.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
21
# AiBcrOptions
2+
3+
Recognition options.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------
@@ -10,4 +12,3 @@ Name | Type | Description | Notes
1012

1113

1214
[[Back to Model list]](Models.md) [[Back to API README]](README.md)
13-

‎docs/AiBcrParseRequest.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# AiBcrParseRequest
2+
3+
Request model for AiBcrApi.parse
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
---- | ---- | ----------- | -----
9+
**file** | **byte[]**| File to parse |
10+
**countries** | **String**| Comma-separated codes of countries. | [optional] [default to ]
11+
**languages** | **String**| Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. | [optional] [default to ]
12+
**isSingle** | **Boolean**| Determines that image contains single VCard or more. | [optional] [default to true]
13+
14+
## Example
15+
```java
16+
AiBcrParseRequest request = Models.aiBcrParseRequest()
17+
.file(IOUtils.toByteArray(new FileInputStream("/path/to/image.png")))
18+
.countries("us")
19+
.languages("en")
20+
.isSingle(true)
21+
.build();
22+
```
23+

0 commit comments

Comments
 (0)