Skip to content

Commit a9ec6f1

Browse files
SDK version 20.5.0.84 generated
1 parent 5e5a761 commit a9ec6f1

File tree

4 files changed

+419
-0
lines changed

4 files changed

+419
-0
lines changed

doc/EmailApi.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -855,6 +855,33 @@ Name | Type | Description | Notes
855855

856856
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
857857

858+
<a name="convertemailmodeltofile"></a>
859+
# **convertEmailModelToFile**
860+
861+
```typescript
862+
public async convertEmailModelToFile(requestObj: ConvertEmailModelToFileRequest) : Promise<{response: RequestResponse, body: Buffer; }>
863+
```
864+
865+
Converts Email model to specified format and returns as file
866+
867+
### Return type
868+
869+
`Promise<{response: RequestResponse, body: Buffer; }>`
870+
871+
### Request Parameters
872+
```typescript
873+
new ConvertEmailModelToFileRequest(
874+
destinationFormat,
875+
emailDto)
876+
```
877+
878+
Name | Type | Description | Notes
879+
------------- | ------------- | ------------- | -------------
880+
**destinationFormat** | **string**| File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html |
881+
**emailDto** | [**EmailDto**](EmailDto.md)| Email model to convert |
882+
883+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
884+
858885
<a name="copyfile"></a>
859886
# **copyFile**
860887

@@ -1638,6 +1665,31 @@ Name | Type | Description | Notes
16381665

16391666
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
16401667

1668+
<a name="getcalendarfileasmodel"></a>
1669+
# **getCalendarFileAsModel**
1670+
1671+
```typescript
1672+
public async getCalendarFileAsModel(requestObj: GetCalendarFileAsModelRequest) : Promise<{response: RequestResponse, body: CalendarDto; }>
1673+
```
1674+
1675+
Converts calendar document to a model representation
1676+
1677+
### Return type
1678+
1679+
`Promise<{response: RequestResponse, body: CalendarDto; }>`
1680+
1681+
### Request Parameters
1682+
```typescript
1683+
new GetCalendarFileAsModelRequest(
1684+
file)
1685+
```
1686+
1687+
Name | Type | Description | Notes
1688+
------------- | ------------- | ------------- | -------------
1689+
**file** | **Buffer**| File to convert |
1690+
1691+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1692+
16411693
<a name="getcalendarlist"></a>
16421694
# **getCalendarList**
16431695

@@ -1828,6 +1880,33 @@ Name | Type | Description | Notes
18281880

18291881
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
18301882

1883+
<a name="getcontactfileasmodel"></a>
1884+
# **getContactFileAsModel**
1885+
1886+
```typescript
1887+
public async getContactFileAsModel(requestObj: GetContactFileAsModelRequest) : Promise<{response: RequestResponse, body: ContactDto; }>
1888+
```
1889+
1890+
Converts contact document to a model representation
1891+
1892+
### Return type
1893+
1894+
`Promise<{response: RequestResponse, body: ContactDto; }>`
1895+
1896+
### Request Parameters
1897+
```typescript
1898+
new GetContactFileAsModelRequest(
1899+
format,
1900+
file)
1901+
```
1902+
1903+
Name | Type | Description | Notes
1904+
------------- | ------------- | ------------- | -------------
1905+
**format** | **string**| File format Enum, available values: VCard, WebDav, Msg |
1906+
**file** | **Buffer**| File to convert |
1907+
1908+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1909+
18311910
<a name="getcontactlist"></a>
18321911
# **getContactList**
18331912

@@ -2130,6 +2209,33 @@ Name | Type | Description | Notes
21302209

21312210
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
21322211

2212+
<a name="getemailfileasmodel"></a>
2213+
# **getEmailFileAsModel**
2214+
2215+
```typescript
2216+
public async getEmailFileAsModel(requestObj: GetEmailFileAsModelRequest) : Promise<{response: RequestResponse, body: EmailDto; }>
2217+
```
2218+
2219+
Converts email document to a model representation
2220+
2221+
### Return type
2222+
2223+
`Promise<{response: RequestResponse, body: EmailDto; }>`
2224+
2225+
### Request Parameters
2226+
```typescript
2227+
new GetEmailFileAsModelRequest(
2228+
format,
2229+
file)
2230+
```
2231+
2232+
Name | Type | Description | Notes
2233+
------------- | ------------- | ------------- | -------------
2234+
**format** | **string**| File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html |
2235+
**file** | **Buffer**| File to convert |
2236+
2237+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
2238+
21332239
<a name="getemailmodel"></a>
21342240
# **getEmailModel**
21352241

doc/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Class | Method | HTTP request | Description
3535
*EmailApi* | [**convertContact**](EmailApi.md#convertcontact) | **PUT** /email/ContactModel/{format}/convert/{destinationFormat} | Converts contact document to specified format and returns as file
3636
*EmailApi* | [**convertContactModelToFile**](EmailApi.md#convertcontactmodeltofile) | **PUT** /email/ContactModel/model-as-file/{destinationFormat} | Converts contact model to specified format and returns as file
3737
*EmailApi* | [**convertEmail**](EmailApi.md#convertemail) | **PUT** /email/convert/{format} | Converts email document to specified format and returns as file
38+
*EmailApi* | [**convertEmailModelToFile**](EmailApi.md#convertemailmodeltofile) | **PUT** /email/model/model-as-file/{destinationFormat} | Converts Email model to specified format and returns as file
3839
*EmailApi* | [**copyFile**](EmailApi.md#copyfile) | **PUT** /email/storage/file/copy/{srcPath} | Copy file
3940
*EmailApi* | [**copyFolder**](EmailApi.md#copyfolder) | **PUT** /email/storage/folder/copy/{srcPath} | Copy folder
4041
*EmailApi* | [**createCalendar**](EmailApi.md#createcalendar) | **PUT** /email/Calendar/{name} | Create calendar file
@@ -62,12 +63,14 @@ Class | Method | HTTP request | Description
6263
*EmailApi* | [**getCalendar**](EmailApi.md#getcalendar) | **GET** /email/Calendar/{name}/properties | Get calendar file properties
6364
*EmailApi* | [**getCalendarAsFile**](EmailApi.md#getcalendarasfile) | **GET** /email/CalendarModel/{fileName}/as-file/{format} | Converts calendar document from storage to specified format and returns as file
6465
*EmailApi* | [**getCalendarAttachment**](EmailApi.md#getcalendarattachment) | **GET** /email/Calendar/{name}/attachments/{attachment} | Get iCalendar document attachment by name
66+
*EmailApi* | [**getCalendarFileAsModel**](EmailApi.md#getcalendarfileasmodel) | **PUT** /email/CalendarModel/file-as-model | Converts calendar document to a model representation
6567
*EmailApi* | [**getCalendarList**](EmailApi.md#getcalendarlist) | **GET** /email/Calendar | Get iCalendar files list in folder on storage
6668
*EmailApi* | [**getCalendarModel**](EmailApi.md#getcalendarmodel) | **GET** /email/CalendarModel/{name} | Get calendar file
6769
*EmailApi* | [**getCalendarModelAsAlternate**](EmailApi.md#getcalendarmodelasalternate) | **GET** /email/CalendarModel/{name}/as-alternate/{calendarAction} | Get iCalendar from storage as AlternateView
6870
*EmailApi* | [**getCalendarModelList**](EmailApi.md#getcalendarmodellist) | **GET** /email/CalendarModel | Get iCalendar list from storage folder
6971
*EmailApi* | [**getContactAsFile**](EmailApi.md#getcontactasfile) | **GET** /email/ContactModel/{format}/{fileName}/as-file/{destinationFormat} | Converts calendar document from storage to specified format and returns as file
7072
*EmailApi* | [**getContactAttachment**](EmailApi.md#getcontactattachment) | **GET** /email/Contact/{format}/{name}/attachments/{attachment} | Get attachment file by name
73+
*EmailApi* | [**getContactFileAsModel**](EmailApi.md#getcontactfileasmodel) | **PUT** /email/ContactModel/{format}/file-as-model | Converts contact document to a model representation
7174
*EmailApi* | [**getContactList**](EmailApi.md#getcontactlist) | **GET** /email/Contact/{format} | Get contact list from storage folder
7275
*EmailApi* | [**getContactModel**](EmailApi.md#getcontactmodel) | **GET** /email/ContactModel/{format}/{name} | Get contact document.
7376
*EmailApi* | [**getContactModelList**](EmailApi.md#getcontactmodellist) | **GET** /email/ContactModel/{format} | Get contact list from storage folder.
@@ -78,6 +81,7 @@ Class | Method | HTTP request | Description
7881
*EmailApi* | [**getEmailAttachment**](EmailApi.md#getemailattachment) | **GET** /email/{fileName}/attachments/{attachment} | Get email attachment by name
7982
*EmailApi* | [**getEmailClientAccount**](EmailApi.md#getemailclientaccount) | **GET** /email/client/email-client-account | Get email client account from storage
8083
*EmailApi* | [**getEmailClientMultiAccount**](EmailApi.md#getemailclientmultiaccount) | **GET** /email/client/multi-account | Get email client multi account file (*.multi.account). Will respond error if file extension is not \&quot;.multi.account\&quot;.
84+
*EmailApi* | [**getEmailFileAsModel**](EmailApi.md#getemailfileasmodel) | **PUT** /email/model/{format}/file-as-model | Converts email document to a model representation
8185
*EmailApi* | [**getEmailModel**](EmailApi.md#getemailmodel) | **GET** /email/model/{format}/{name} | Get email document.
8286
*EmailApi* | [**getEmailModelList**](EmailApi.md#getemailmodellist) | **GET** /email/model/{format} | Get email list from storage folder.
8387
*EmailApi* | [**getEmailProperty**](EmailApi.md#getemailproperty) | **GET** /email/{fileName}/properties/{propertyName} | Get an email document property by its name

src/api.ts

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1538,6 +1538,52 @@ export class EmailApi {
15381538
return Promise.resolve({body: result, response});
15391539
}
15401540

1541+
/**
1542+
* Converts Email model to specified format and returns as file
1543+
* @param requestObj contains request parameters
1544+
*/
1545+
public async convertEmailModelToFile(requestObj: requestModels.ConvertEmailModelToFileRequest): Promise<{response: request.RequestResponse, body: Buffer}> {
1546+
const localVarPath = this.configuration.getApiBaseUrl() + "/email/model/model-as-file/{destinationFormat}"
1547+
.replace("{" + "destinationFormat" + "}", String(requestObj.destinationFormat));
1548+
const queryParameters: any = {};
1549+
const headerParams: any = {};
1550+
const formParams: any = {};
1551+
1552+
// verify required parameter 'requestObj.destinationFormat' is not null or undefined
1553+
if (requestObj.destinationFormat === null || requestObj.destinationFormat === undefined) {
1554+
throw new Error('Required parameter "requestObj.destinationFormat" was null or undefined when calling convertEmailModelToFile.');
1555+
}
1556+
1557+
// verify required parameter 'requestObj.emailDto' is not null or undefined
1558+
if (requestObj.emailDto === null || requestObj.emailDto === undefined) {
1559+
throw new Error('Required parameter "requestObj.emailDto" was null or undefined when calling convertEmailModelToFile.');
1560+
}
1561+
1562+
// tslint:disable-next-line:prefer-const
1563+
let useFormData = false;
1564+
1565+
const requestOptions: request.Options = {
1566+
method: "PUT",
1567+
qs: queryParameters,
1568+
headers: headerParams,
1569+
uri: localVarPath,
1570+
encoding: null,
1571+
body: ObjectSerializer.serialize(requestObj.emailDto, "EmailDto"),
1572+
};
1573+
1574+
if (Object.keys(formParams).length) {
1575+
if (useFormData) {
1576+
(requestOptions as any).formData = formParams;
1577+
} else {
1578+
requestOptions.form = formParams;
1579+
}
1580+
}
1581+
1582+
const response = await invokeApiMethod(requestOptions, this.configuration);
1583+
const result = ObjectSerializer.deserialize(response.body, "Buffer");
1584+
return Promise.resolve({body: result, response});
1585+
}
1586+
15411587
/**
15421588
* Copy file
15431589
* @param requestObj contains request parameters
@@ -2888,6 +2934,55 @@ export class EmailApi {
28882934
return Promise.resolve({body: result, response});
28892935
}
28902936

2937+
/**
2938+
* Converts calendar document to a model representation
2939+
* @param requestObj contains request parameters
2940+
*/
2941+
public async getCalendarFileAsModel(requestObj: requestModels.GetCalendarFileAsModelRequest): Promise<{response: request.RequestResponse, body: model.CalendarDto}> {
2942+
const localVarPath = this.configuration.getApiBaseUrl() + "/email/CalendarModel/file-as-model";
2943+
const queryParameters: any = {};
2944+
const headerParams: any = {};
2945+
const formParams: any = {};
2946+
2947+
// verify required parameter 'requestObj.file' is not null or undefined
2948+
if (requestObj.file === null || requestObj.file === undefined) {
2949+
throw new Error('Required parameter "requestObj.file" was null or undefined when calling getCalendarFileAsModel.');
2950+
}
2951+
2952+
// tslint:disable-next-line:prefer-const
2953+
let useFormData = false;
2954+
2955+
if (requestObj.file !== undefined) {
2956+
formParams.File = {
2957+
value: requestObj.file,
2958+
options: {
2959+
filename: 'File'
2960+
}
2961+
};
2962+
}
2963+
useFormData = true;
2964+
2965+
const requestOptions: request.Options = {
2966+
method: "PUT",
2967+
qs: queryParameters,
2968+
headers: headerParams,
2969+
uri: localVarPath,
2970+
json: true,
2971+
};
2972+
2973+
if (Object.keys(formParams).length) {
2974+
if (useFormData) {
2975+
(requestOptions as any).formData = formParams;
2976+
} else {
2977+
requestOptions.form = formParams;
2978+
}
2979+
}
2980+
2981+
const response = await invokeApiMethod(requestOptions, this.configuration);
2982+
const result = ObjectSerializer.deserialize(response.body, "CalendarDto");
2983+
return Promise.resolve({body: result, response});
2984+
}
2985+
28912986
/**
28922987
* Get iCalendar files list in folder on storage
28932988
* @param requestObj contains request parameters
@@ -3234,6 +3329,61 @@ export class EmailApi {
32343329
return Promise.resolve({body: result, response});
32353330
}
32363331

3332+
/**
3333+
* Converts contact document to a model representation
3334+
* @param requestObj contains request parameters
3335+
*/
3336+
public async getContactFileAsModel(requestObj: requestModels.GetContactFileAsModelRequest): Promise<{response: request.RequestResponse, body: model.ContactDto}> {
3337+
const localVarPath = this.configuration.getApiBaseUrl() + "/email/ContactModel/{format}/file-as-model"
3338+
.replace("{" + "format" + "}", String(requestObj.format));
3339+
const queryParameters: any = {};
3340+
const headerParams: any = {};
3341+
const formParams: any = {};
3342+
3343+
// verify required parameter 'requestObj.format' is not null or undefined
3344+
if (requestObj.format === null || requestObj.format === undefined) {
3345+
throw new Error('Required parameter "requestObj.format" was null or undefined when calling getContactFileAsModel.');
3346+
}
3347+
3348+
// verify required parameter 'requestObj.file' is not null or undefined
3349+
if (requestObj.file === null || requestObj.file === undefined) {
3350+
throw new Error('Required parameter "requestObj.file" was null or undefined when calling getContactFileAsModel.');
3351+
}
3352+
3353+
// tslint:disable-next-line:prefer-const
3354+
let useFormData = false;
3355+
3356+
if (requestObj.file !== undefined) {
3357+
formParams.File = {
3358+
value: requestObj.file,
3359+
options: {
3360+
filename: 'File'
3361+
}
3362+
};
3363+
}
3364+
useFormData = true;
3365+
3366+
const requestOptions: request.Options = {
3367+
method: "PUT",
3368+
qs: queryParameters,
3369+
headers: headerParams,
3370+
uri: localVarPath,
3371+
json: true,
3372+
};
3373+
3374+
if (Object.keys(formParams).length) {
3375+
if (useFormData) {
3376+
(requestOptions as any).formData = formParams;
3377+
} else {
3378+
requestOptions.form = formParams;
3379+
}
3380+
}
3381+
3382+
const response = await invokeApiMethod(requestOptions, this.configuration);
3383+
const result = ObjectSerializer.deserialize(response.body, "ContactDto");
3384+
return Promise.resolve({body: result, response});
3385+
}
3386+
32373387
/**
32383388
* Get contact list from storage folder
32393389
* @param requestObj contains request parameters
@@ -3770,6 +3920,61 @@ export class EmailApi {
37703920
return Promise.resolve({body: result, response});
37713921
}
37723922

3923+
/**
3924+
* Converts email document to a model representation
3925+
* @param requestObj contains request parameters
3926+
*/
3927+
public async getEmailFileAsModel(requestObj: requestModels.GetEmailFileAsModelRequest): Promise<{response: request.RequestResponse, body: model.EmailDto}> {
3928+
const localVarPath = this.configuration.getApiBaseUrl() + "/email/model/{format}/file-as-model"
3929+
.replace("{" + "format" + "}", String(requestObj.format));
3930+
const queryParameters: any = {};
3931+
const headerParams: any = {};
3932+
const formParams: any = {};
3933+
3934+
// verify required parameter 'requestObj.format' is not null or undefined
3935+
if (requestObj.format === null || requestObj.format === undefined) {
3936+
throw new Error('Required parameter "requestObj.format" was null or undefined when calling getEmailFileAsModel.');
3937+
}
3938+
3939+
// verify required parameter 'requestObj.file' is not null or undefined
3940+
if (requestObj.file === null || requestObj.file === undefined) {
3941+
throw new Error('Required parameter "requestObj.file" was null or undefined when calling getEmailFileAsModel.');
3942+
}
3943+
3944+
// tslint:disable-next-line:prefer-const
3945+
let useFormData = false;
3946+
3947+
if (requestObj.file !== undefined) {
3948+
formParams.File = {
3949+
value: requestObj.file,
3950+
options: {
3951+
filename: 'File'
3952+
}
3953+
};
3954+
}
3955+
useFormData = true;
3956+
3957+
const requestOptions: request.Options = {
3958+
method: "PUT",
3959+
qs: queryParameters,
3960+
headers: headerParams,
3961+
uri: localVarPath,
3962+
json: true,
3963+
};
3964+
3965+
if (Object.keys(formParams).length) {
3966+
if (useFormData) {
3967+
(requestOptions as any).formData = formParams;
3968+
} else {
3969+
requestOptions.form = formParams;
3970+
}
3971+
}
3972+
3973+
const response = await invokeApiMethod(requestOptions, this.configuration);
3974+
const result = ObjectSerializer.deserialize(response.body, "EmailDto");
3975+
return Promise.resolve({body: result, response});
3976+
}
3977+
37733978
/**
37743979
* Get email document.
37753980
* @param requestObj contains request parameters

0 commit comments

Comments
 (0)