Skip to content

Commit a74f581

Browse files
Marat-GumerovMarat-Gumerov
committed
Client credentials fields renamed in documentation
1 parent b10b854 commit a74f581

19 files changed

+102
-101
lines changed

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@ See more details about SDK installation in this tutorial: [SDK setup](https://do
5050
### Usage examples
5151
To use the API, you should create an EmailCloud object:
5252
```typescript
53-
var appKey = "Your App Key";
54-
var appSid = "Your App SID";
55-
var api = new EmailCloud(appSid, appKey);
53+
let clientSecret = "Your Client secret";
54+
let clientId = "Your Client id";
55+
56+
let api = new EmailCloud(clientSecret, clientId);
5657
```
5758

5859
#### Business cards recognition API

‎doc/AiBcrApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ let result = Models.contactList()
9696
<summary>Method call example:</summary>
9797

9898
```typescript
99-
const api = new EmailCloud(app_key, app_sid);
99+
const api = new EmailCloud(clientSecret, clientId);
100100

101101
// Prepare parameters:
102102
let request = Models.AiBcrParseRequest()
@@ -227,7 +227,7 @@ let result = Models.storageFileLocationList()
227227
<summary>Method call example:</summary>
228228

229229
```typescript
230-
const api = new EmailCloud(app_key, app_sid);
230+
const api = new EmailCloud(clientSecret, clientId);
231231

232232
// Prepare parameters:
233233
let request = Models.aiBcrParseStorageRequest()

‎doc/AiNameApi.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ let result = Models.aiNameWeightedVariants()
6363
<summary>Method call example:</summary>
6464

6565
```typescript
66-
const api = new EmailCloud(app_key, app_sid);
66+
const api = new EmailCloud(clientSecret, clientId);
6767

6868
// Prepare parameters:
6969
let request = Models.AiNameCompleteRequest()
@@ -152,7 +152,7 @@ let result = Models.aiNameWeightedVariants()
152152
<summary>Method call example:</summary>
153153

154154
```typescript
155-
const api = new EmailCloud(app_key, app_sid);
155+
const api = new EmailCloud(clientSecret, clientId);
156156

157157
// Prepare parameters:
158158
let request = Models.AiNameExpandRequest()
@@ -261,7 +261,7 @@ let result = Models.aiNameWeightedVariants()
261261
<summary>Method call example:</summary>
262262

263263
```typescript
264-
const api = new EmailCloud(app_key, app_sid);
264+
const api = new EmailCloud(clientSecret, clientId);
265265

266266
// Prepare parameters:
267267
let request = Models.aiNameParsedRequest()
@@ -364,7 +364,7 @@ let result = Models.aiNameFormatted()
364364
<summary>Method call example:</summary>
365365

366366
```typescript
367-
const api = new EmailCloud(app_key, app_sid);
367+
const api = new EmailCloud(clientSecret, clientId);
368368

369369
// Prepare parameters:
370370
let request = Models.AiNameFormatRequest()
@@ -460,7 +460,7 @@ let result = Models.aiNameFormatted()
460460
<summary>Method call example:</summary>
461461

462462
```typescript
463-
const api = new EmailCloud(app_key, app_sid);
463+
const api = new EmailCloud(clientSecret, clientId);
464464

465465
// Prepare parameters:
466466
let request = Models.aiNameParsedRequest()
@@ -552,7 +552,7 @@ let result = ;
552552
<summary>Method call example:</summary>
553553

554554
```typescript
555-
const api = new EmailCloud(app_key, app_sid);
555+
const api = new EmailCloud(clientSecret, clientId);
556556

557557
// Prepare parameters:
558558
let request = Models.AiNameGenderizeRequest()
@@ -641,7 +641,7 @@ let result = ;
641641
<summary>Method call example:</summary>
642642

643643
```typescript
644-
const api = new EmailCloud(app_key, app_sid);
644+
const api = new EmailCloud(clientSecret, clientId);
645645

646646
// Prepare parameters:
647647
let request = Models.aiNameParsedRequest()
@@ -738,7 +738,7 @@ let result = Models.aiNameMatchResult()
738738
<summary>Method call example:</summary>
739739

740740
```typescript
741-
const api = new EmailCloud(app_key, app_sid);
741+
const api = new EmailCloud(clientSecret, clientId);
742742

743743
// Prepare parameters:
744744
let request = Models.AiNameMatchRequest()
@@ -863,7 +863,7 @@ let result = Models.aiNameMatchResult()
863863
<summary>Method call example:</summary>
864864

865865
```typescript
866-
const api = new EmailCloud(app_key, app_sid);
866+
const api = new EmailCloud(clientSecret, clientId);
867867

868868
// Prepare parameters:
869869
let request = Models.aiNameMatchParsedRequest()
@@ -1004,7 +1004,7 @@ let result = Models.aiNameComponentList()
10041004
<summary>Method call example:</summary>
10051005

10061006
```typescript
1007-
const api = new EmailCloud(app_key, app_sid);
1007+
const api = new EmailCloud(clientSecret, clientId);
10081008

10091009
// Prepare parameters:
10101010
let request = Models.AiNameParseRequest()
@@ -1097,7 +1097,7 @@ let result = ;
10971097
<summary>Method call example:</summary>
10981098

10991099
```typescript
1100-
const api = new EmailCloud(app_key, app_sid);
1100+
const api = new EmailCloud(clientSecret, clientId);
11011101

11021102
// Prepare parameters:
11031103
let request = Models.AiNameParseEmailAddressRequest()

‎doc/CalendarApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ let result = Models.alternateView()
9696
<summary>Method call example:</summary>
9797

9898
```typescript
99-
const api = new EmailCloud(app_key, app_sid);
99+
const api = new EmailCloud(clientSecret, clientId);
100100

101101
// Prepare parameters:
102102
let request = Models.calendarAsAlternateRequest()
@@ -219,7 +219,7 @@ Return type: Promise< Buffer >
219219
<summary>Method call example:</summary>
220220

221221
```typescript
222-
const api = new EmailCloud(app_key, app_sid);
222+
const api = new EmailCloud(clientSecret, clientId);
223223

224224
// Prepare parameters:
225225
let request = Models.calendarAsFileRequest()
@@ -359,7 +359,7 @@ let result = Models.mapiCalendarDto()
359359
<summary>Method call example:</summary>
360360

361361
```typescript
362-
const api = new EmailCloud(app_key, app_sid);
362+
const api = new EmailCloud(clientSecret, clientId);
363363

364364
// Prepare parameters:
365365
let calendarDto = Models.calendarDto()
@@ -472,7 +472,7 @@ Return type: Promise< Buffer >
472472
<summary>Method call example:</summary>
473473

474474
```typescript
475-
const api = new EmailCloud(app_key, app_sid);
475+
const api = new EmailCloud(clientSecret, clientId);
476476

477477
// Prepare parameters:
478478
let request = Models.CalendarConvertRequest()
@@ -560,7 +560,7 @@ let result = Models.calendarDto()
560560
<summary>Method call example:</summary>
561561

562562
```typescript
563-
const api = new EmailCloud(app_key, app_sid);
563+
const api = new EmailCloud(clientSecret, clientId);
564564

565565
// Prepare parameters:
566566
let request = Models.CalendarFromFileRequest()
@@ -673,7 +673,7 @@ let result = Models.calendarDto()
673673
<summary>Method call example:</summary>
674674

675675
```typescript
676-
const api = new EmailCloud(app_key, app_sid);
676+
const api = new EmailCloud(clientSecret, clientId);
677677

678678
// Prepare parameters:
679679
let request = Models.CalendarGetRequest()
@@ -789,7 +789,7 @@ let result = Models.alternateView()
789789
<summary>Method call example:</summary>
790790

791791
```typescript
792-
const api = new EmailCloud(app_key, app_sid);
792+
const api = new EmailCloud(clientSecret, clientId);
793793

794794
// Prepare parameters:
795795
let request = Models.CalendarGetAsAlternateRequest()
@@ -875,7 +875,7 @@ Return type: Promise< Buffer >
875875
<summary>Method call example:</summary>
876876

877877
```typescript
878-
const api = new EmailCloud(app_key, app_sid);
878+
const api = new EmailCloud(clientSecret, clientId);
879879

880880
// Prepare parameters:
881881
let request = Models.CalendarGetAsFileRequest()
@@ -978,7 +978,7 @@ let result = Models.calendarStorageList()
978978
<summary>Method call example:</summary>
979979

980980
```typescript
981-
const api = new EmailCloud(app_key, app_sid);
981+
const api = new EmailCloud(clientSecret, clientId);
982982

983983
// Prepare parameters:
984984
let request = Models.CalendarGetListRequest()
@@ -1093,7 +1093,7 @@ Return type: Promise< any >
10931093
<summary>Method call example:</summary>
10941094

10951095
```typescript
1096-
const api = new EmailCloud(app_key, app_sid);
1096+
const api = new EmailCloud(clientSecret, clientId);
10971097

10981098
// Prepare parameters:
10991099
let request = Models.calendarSaveRequest()

‎doc/ClientAccountApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ let result = Models.emailClientAccount()
6666
<summary>Method call example:</summary>
6767

6868
```typescript
69-
const api = new EmailCloud(app_key, app_sid);
69+
const api = new EmailCloud(clientSecret, clientId);
7070

7171
// Prepare parameters:
7272
let request = Models.ClientAccountGetRequest()
@@ -182,7 +182,7 @@ let result = Models.emailClientMultiAccount()
182182
<summary>Method call example:</summary>
183183

184184
```typescript
185-
const api = new EmailCloud(app_key, app_sid);
185+
const api = new EmailCloud(clientSecret, clientId);
186186

187187
// Prepare parameters:
188188
let request = Models.ClientAccountGetMultiRequest()
@@ -287,7 +287,7 @@ Return type: Promise< any >
287287
<summary>Method call example:</summary>
288288

289289
```typescript
290-
const api = new EmailCloud(app_key, app_sid);
290+
const api = new EmailCloud(clientSecret, clientId);
291291

292292
// Prepare parameters:
293293
let request = Models.clientAccountSaveRequest()
@@ -392,7 +392,7 @@ Return type: Promise< any >
392392
<summary>Method call example:</summary>
393393

394394
```typescript
395-
const api = new EmailCloud(app_key, app_sid);
395+
const api = new EmailCloud(clientSecret, clientId);
396396

397397
// Prepare parameters:
398398
let request = Models.clientAccountSaveMultiRequest()

‎doc/ClientFolderApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Return type: Promise< any >
4545
<summary>Method call example:</summary>
4646

4747
```typescript
48-
const api = new EmailCloud(app_key, app_sid);
48+
const api = new EmailCloud(clientSecret, clientId);
4949

5050
// Prepare parameters:
5151
let request = Models.clientFolderCreateRequest()
@@ -108,7 +108,7 @@ Return type: Promise< any >
108108
<summary>Method call example:</summary>
109109

110110
```typescript
111-
const api = new EmailCloud(app_key, app_sid);
111+
const api = new EmailCloud(clientSecret, clientId);
112112

113113
// Prepare parameters:
114114
let request = Models.clientFolderDeleteRequest()
@@ -182,7 +182,7 @@ let result = ;
182182
<summary>Method call example:</summary>
183183

184184
```typescript
185-
const api = new EmailCloud(app_key, app_sid);
185+
const api = new EmailCloud(clientSecret, clientId);
186186

187187
// Prepare parameters:
188188
let request = Models.ClientFolderGetListRequest()

‎doc/ClientMessageApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ let result = ;
8686
<summary>Method call example:</summary>
8787

8888
```typescript
89-
const api = new EmailCloud(app_key, app_sid);
89+
const api = new EmailCloud(clientSecret, clientId);
9090

9191
// Prepare parameters:
9292
let request = Models.clientMessageAppendRequest()
@@ -193,7 +193,7 @@ let result = ;
193193
<summary>Method call example:</summary>
194194

195195
```typescript
196-
const api = new EmailCloud(app_key, app_sid);
196+
const api = new EmailCloud(clientSecret, clientId);
197197

198198
// Prepare parameters:
199199
let request = Models.ClientMessageAppendFileRequest()
@@ -259,7 +259,7 @@ Return type: Promise< any >
259259
<summary>Method call example:</summary>
260260

261261
```typescript
262-
const api = new EmailCloud(app_key, app_sid);
262+
const api = new EmailCloud(clientSecret, clientId);
263263

264264
// Prepare parameters:
265265
let request = Models.clientMessageDeleteRequest()
@@ -339,7 +339,7 @@ let result = Models.mailMessageBase()
339339
<summary>Method call example:</summary>
340340

341341
```typescript
342-
const api = new EmailCloud(app_key, app_sid);
342+
const api = new EmailCloud(clientSecret, clientId);
343343

344344
// Prepare parameters:
345345
let request = Models.ClientMessageFetchRequest()
@@ -411,7 +411,7 @@ Return type: Promise< Buffer >
411411
<summary>Method call example:</summary>
412412

413413
```typescript
414-
const api = new EmailCloud(app_key, app_sid);
414+
const api = new EmailCloud(clientSecret, clientId);
415415

416416
// Prepare parameters:
417417
let request = Models.ClientMessageFetchFileRequest()
@@ -491,7 +491,7 @@ let result = ;
491491
<summary>Method call example:</summary>
492492

493493
```typescript
494-
const api = new EmailCloud(app_key, app_sid);
494+
const api = new EmailCloud(clientSecret, clientId);
495495

496496
// Prepare parameters:
497497
let request = Models.ClientMessageListRequest()
@@ -560,7 +560,7 @@ Return type: Promise< any >
560560
<summary>Method call example:</summary>
561561

562562
```typescript
563-
const api = new EmailCloud(app_key, app_sid);
563+
const api = new EmailCloud(clientSecret, clientId);
564564

565565
// Prepare parameters:
566566
let request = Models.clientMessageMoveRequest()
@@ -650,7 +650,7 @@ Return type: Promise< any >
650650
<summary>Method call example:</summary>
651651

652652
```typescript
653-
const api = new EmailCloud(app_key, app_sid);
653+
const api = new EmailCloud(clientSecret, clientId);
654654

655655
// Prepare parameters:
656656
let request = Models.clientMessageSendRequest()
@@ -737,7 +737,7 @@ Return type: Promise< any >
737737
<summary>Method call example:</summary>
738738

739739
```typescript
740-
const api = new EmailCloud(app_key, app_sid);
740+
const api = new EmailCloud(clientSecret, clientId);
741741

742742
// Prepare parameters:
743743
let request = Models.ClientMessageSendFileRequest()
@@ -799,7 +799,7 @@ Return type: Promise< any >
799799
<summary>Method call example:</summary>
800800

801801
```typescript
802-
const api = new EmailCloud(app_key, app_sid);
802+
const api = new EmailCloud(clientSecret, clientId);
803803

804804
// Prepare parameters:
805805
let request = Models.clientMessageSetIsReadRequest()

0 commit comments

Comments
 (0)