Skip to content

Commit d82b18c

Browse files
fix(web3mail,web3telegram): correct parameter name from grantedAccess to grantedAccesses
1 parent 43ca22a commit d82b18c

File tree

5 files changed

+39
-39
lines changed

5 files changed

+39
-39
lines changed

src/guides/use-iapp/integrate-web3-messaging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
190190

191191
// Step 2: Prepare the campaign
192192
const emailCampaign = await web3mail.prepareEmailCampaign({
193-
grantedAccess: grantedAccessArray,
193+
grantedAccesses: grantedAccessArray,
194194
emailSubject: 'Hello from My Awesome App!',
195195
emailContent: 'Hello! This is a bulk email sent to all recipients.',
196196
contentType: 'text/html',
@@ -216,7 +216,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
216216

217217
// Step 2: Prepare the campaign
218218
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
219-
grantedAccess: grantedAccessArray,
219+
grantedAccesses: grantedAccessArray,
220220
telegramContent: 'Hello! This is a bulk message sent to all recipients.',
221221
senderName: 'My Awesome App',
222222
});

src/references/web3mail/methods/prepareEmailCampaign.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
3939

4040
// Prepare the campaign
4141
const emailCampaign = await web3mail.prepareEmailCampaign({
42-
grantedAccess: grantedAccessArray,
42+
grantedAccesses: grantedAccessArray,
4343
emailSubject: 'My email subject',
4444
emailContent: 'My email content',
4545
contentType: 'text/plain',
@@ -58,7 +58,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
5858

5959
// Prepare the campaign
6060
const emailCampaign = await web3mail.prepareEmailCampaign({
61-
grantedAccess: grantedAccessArray,
61+
grantedAccesses: grantedAccessArray,
6262
emailSubject: 'My email subject',
6363
emailContent: 'My email content',
6464
contentType: 'text/plain',
@@ -73,7 +73,7 @@ const emailCampaign = await web3mail.prepareEmailCampaign({
7373
import { type PrepareEmailCampaignParams } from '@iexec/web3mail';
7474
```
7575

76-
### grantedAccess <RequiredBadge />
76+
### grantedAccesses <RequiredBadge />
7777

7878
**Type:** `GrantedAccess[]`
7979

@@ -82,7 +82,7 @@ access to their protected data with bulk processing capability.
8282

8383
```ts twoslash
8484
const emailCampaign = await web3mail.prepareEmailCampaign({
85-
grantedAccess: grantedAccessArray, // [!code focus]
85+
grantedAccesses: grantedAccessArray, // [!code focus]
8686
emailSubject: 'My subject',
8787
emailContent: 'My content',
8888
});
@@ -96,7 +96,7 @@ The email subject that will be sent to all recipients.
9696

9797
```ts twoslash
9898
const emailCampaign = await web3mail.prepareEmailCampaign({
99-
grantedAccess: grantedAccessArray,
99+
grantedAccesses: grantedAccessArray,
100100
emailSubject: 'My email subject', // [!code focus]
101101
emailContent: 'My email content',
102102
});
@@ -113,7 +113,7 @@ and stored in IPFS.
113113

114114
```ts twoslash
115115
const emailCampaign = await web3mail.prepareEmailCampaign({
116-
grantedAccess: grantedAccessArray,
116+
grantedAccesses: grantedAccessArray,
117117
emailSubject: 'My email subject',
118118
emailContent: 'My email content', // [!code focus]
119119
});
@@ -129,7 +129,7 @@ The MIME type of the email content (e.g., `'text/plain'`, `'text/html'`).
129129

130130
```ts twoslash
131131
const emailCampaign = await web3mail.prepareEmailCampaign({
132-
grantedAccess: grantedAccessArray,
132+
grantedAccesses: grantedAccessArray,
133133
emailSubject: 'My email subject',
134134
emailContent: 'My email content',
135135
contentType: 'text/html', // [!code focus]
@@ -146,7 +146,7 @@ Limits the number of protected data items processed per task.
146146

147147
```ts twoslash
148148
const emailCampaign = await web3mail.prepareEmailCampaign({
149-
grantedAccess: grantedAccessArray,
149+
grantedAccesses: grantedAccessArray,
150150
emailSubject: 'My email subject',
151151
emailContent: 'My email content',
152152
maxProtectedDataPerTask: 10, // [!code focus]
@@ -164,7 +164,7 @@ You can specify this during preparation or when sending the campaign.
164164

165165
```ts twoslash
166166
const emailCampaign = await web3mail.prepareEmailCampaign({
167-
grantedAccess: grantedAccessArray,
167+
grantedAccesses: grantedAccessArray,
168168
emailSubject: 'My email subject',
169169
emailContent: 'My email content',
170170
workerpoolAddressOrEns: '0xa5de76...', // [!code focus]
@@ -183,7 +183,7 @@ preparation or when sending the campaign.
183183

184184
```ts twoslash
185185
const emailCampaign = await web3mail.prepareEmailCampaign({
186-
grantedAccess: grantedAccessArray,
186+
grantedAccesses: grantedAccessArray,
187187
emailSubject: 'My email subject',
188188
emailContent: 'My email content',
189189
workerpoolMaxPrice: 0.1 * 1e9, // [!code focus]
@@ -198,7 +198,7 @@ An optional label to identify or categorize the campaign.
198198

199199
```ts twoslash
200200
const emailCampaign = await web3mail.prepareEmailCampaign({
201-
grantedAccess: grantedAccessArray,
201+
grantedAccesses: grantedAccessArray,
202202
emailSubject: 'My email subject',
203203
emailContent: 'My email content',
204204
label: 'Newsletter Campaign', // [!code focus]
@@ -216,7 +216,7 @@ data.
216216

217217
```ts twoslash
218218
const emailCampaign = await web3mail.prepareEmailCampaign({
219-
grantedAccess: grantedAccessArray,
219+
grantedAccesses: grantedAccessArray,
220220
emailSubject: 'My email subject',
221221
emailContent: 'My email content',
222222
dataMaxPrice: 0.1 * 1e9, // [!code focus]
@@ -234,7 +234,7 @@ for using the Web3Mail application.
234234

235235
```ts twoslash
236236
const emailCampaign = await web3mail.prepareEmailCampaign({
237-
grantedAccess: grantedAccessArray,
237+
grantedAccesses: grantedAccessArray,
238238
emailSubject: 'My email subject',
239239
emailContent: 'My email content',
240240
appMaxPrice: 0.1 * 1e9, // [!code focus]
@@ -280,7 +280,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
280280

281281
// Step 2: Prepare the campaign
282282
const emailCampaign = await web3mail.prepareEmailCampaign({
283-
grantedAccess: grantedAccessArray,
283+
grantedAccesses: grantedAccessArray,
284284
emailSubject: 'Hello from My Awesome App!',
285285
emailContent:
286286
'Hello! This is a bulk email sent to all recipients. Thank you for subscribing!',
@@ -308,7 +308,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
308308

309309
// Step 2: Prepare the campaign
310310
const emailCampaign = await web3mail.prepareEmailCampaign({
311-
grantedAccess: grantedAccessArray,
311+
grantedAccesses: grantedAccessArray,
312312
emailSubject: 'Hello from My Awesome App!',
313313
emailContent:
314314
'Hello! This is a bulk email sent to all recipients. Thank you for subscribing!',

src/references/web3mail/methods/sendEmailCampaign.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const web3mail = new IExecWeb3mail(web3Provider);
3939

4040
// Step 1: Prepare the campaign
4141
const emailCampaign = await web3mail.prepareEmailCampaign({
42-
grantedAccess: grantedAccessArray,
42+
grantedAccesses: grantedAccessArray,
4343
emailSubject: 'My email subject',
4444
emailContent: 'My email content',
4545
});
@@ -59,7 +59,7 @@ const web3mail = new IExecWeb3mail(web3Provider);
5959

6060
// Step 1: Prepare the campaign
6161
const emailCampaign = await web3mail.prepareEmailCampaign({
62-
grantedAccess: grantedAccessArray,
62+
grantedAccesses: grantedAccessArray,
6363
emailSubject: 'My email subject',
6464
emailContent: 'My email content',
6565
});
@@ -165,7 +165,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
165165
// Step 3: Prepare the campaign
166166
// See: prepareEmailCampaign method
167167
const emailCampaign = await web3mail.prepareEmailCampaign({
168-
grantedAccess: grantedAccessArray,
168+
grantedAccesses: grantedAccessArray,
169169
emailSubject: 'Hello from My Awesome App!',
170170
emailContent: 'Hello! This is a bulk email to all recipients.',
171171
contentType: 'text/html',
@@ -205,7 +205,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
205205
// Step 3: Prepare the campaign
206206
// See: prepareEmailCampaign method
207207
const emailCampaign = await web3mail.prepareEmailCampaign({
208-
grantedAccess: grantedAccessArray,
208+
grantedAccesses: grantedAccessArray,
209209
emailSubject: 'Hello from My Awesome App!',
210210
emailContent: 'Hello! This is a bulk email to all recipients.',
211211
contentType: 'text/html',

src/references/web3telegram/methods/prepareTelegramCampaign.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
4141

4242
// Prepare the campaign
4343
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
44-
grantedAccess: grantedAccessArray,
44+
grantedAccesses: grantedAccessArray,
4545
telegramContent: 'My telegram message content',
4646
senderName: 'Awesome project team',
4747
});
@@ -59,7 +59,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
5959

6060
// Prepare the campaign
6161
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
62-
grantedAccess: grantedAccessArray,
62+
grantedAccesses: grantedAccessArray,
6363
telegramContent: 'My telegram message content',
6464
senderName: 'Awesome project team',
6565
});
@@ -73,7 +73,7 @@ const telegramCampaign = await web3telegram.prepareTelegramCampaign({
7373
import { type PrepareTelegramCampaignParams } from '@iexec/web3telegram';
7474
```
7575

76-
### grantedAccess <RequiredBadge />
76+
### grantedAccesses <RequiredBadge />
7777

7878
**Type:** `GrantedAccess[]`
7979

@@ -82,7 +82,7 @@ access to their protected data with bulk processing capability.
8282

8383
```ts twoslash
8484
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
85-
grantedAccess: grantedAccessArray, // [!code focus]
85+
grantedAccesses: grantedAccessArray, // [!code focus]
8686
telegramContent: 'My message',
8787
senderName: 'My App',
8888
});
@@ -99,7 +99,7 @@ encrypted and stored in IPFS.
9999

100100
```ts twoslash
101101
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
102-
grantedAccess: grantedAccessArray,
102+
grantedAccesses: grantedAccessArray,
103103
telegramContent: 'My telegram message content', // [!code focus]
104104
senderName: 'Awesome project team',
105105
});
@@ -113,7 +113,7 @@ The name of the telegram message sender that will be displayed to recipients.
113113

114114
```ts twoslash
115115
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
116-
grantedAccess: grantedAccessArray,
116+
grantedAccesses: grantedAccessArray,
117117
telegramContent: 'My telegram message content',
118118
senderName: 'Awesome project team', // [!code focus]
119119
});
@@ -129,7 +129,7 @@ Limits the number of protected data items processed per task.
129129

130130
```ts twoslash
131131
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
132-
grantedAccess: grantedAccessArray,
132+
grantedAccesses: grantedAccessArray,
133133
telegramContent: 'My telegram message content',
134134
senderName: 'Awesome project team',
135135
maxProtectedDataPerTask: 10, // [!code focus]
@@ -147,7 +147,7 @@ You can specify this during preparation or when sending the campaign.
147147

148148
```ts twoslash
149149
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
150-
grantedAccess: grantedAccessArray,
150+
grantedAccesses: grantedAccessArray,
151151
telegramContent: 'My telegram message content',
152152
senderName: 'Awesome project team',
153153
workerpoolAddressOrEns: '0xa5de76...', // [!code focus]
@@ -166,7 +166,7 @@ during preparation or when sending the campaign.
166166

167167
```ts twoslash
168168
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
169-
grantedAccess: grantedAccessArray,
169+
grantedAccesses: grantedAccessArray,
170170
telegramContent: 'My telegram message content',
171171
senderName: 'Awesome project team',
172172
workerpoolMaxPrice: 0.1 * 1e9, // [!code focus]
@@ -181,7 +181,7 @@ An optional label to identify or categorize the campaign.
181181

182182
```ts twoslash
183183
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
184-
grantedAccess: grantedAccessArray,
184+
grantedAccesses: grantedAccessArray,
185185
telegramContent: 'My telegram message content',
186186
senderName: 'Awesome project team',
187187
label: 'Newsletter Campaign', // [!code focus]
@@ -199,7 +199,7 @@ data.
199199

200200
```ts twoslash
201201
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
202-
grantedAccess: grantedAccessArray,
202+
grantedAccesses: grantedAccessArray,
203203
telegramContent: 'My telegram message content',
204204
senderName: 'Awesome project team',
205205
dataMaxPrice: 0.1 * 1e9, // [!code focus]
@@ -217,7 +217,7 @@ provider for using the Web3Telegram application.
217217

218218
```ts twoslash
219219
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
220-
grantedAccess: grantedAccessArray,
220+
grantedAccesses: grantedAccessArray,
221221
telegramContent: 'My telegram message content',
222222
senderName: 'Awesome project team',
223223
appMaxPrice: 0.1 * 1e9, // [!code focus]
@@ -263,7 +263,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
263263

264264
// Step 2: Prepare the campaign
265265
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
266-
grantedAccess: grantedAccessArray,
266+
grantedAccesses: grantedAccessArray,
267267
telegramContent:
268268
'Hello! This is a bulk message sent to all recipients. Thank you for subscribing!',
269269
senderName: 'My Awesome App',
@@ -292,7 +292,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
292292

293293
// Step 2: Prepare the campaign
294294
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
295-
grantedAccess: grantedAccessArray,
295+
grantedAccesses: grantedAccessArray,
296296
telegramContent:
297297
'Hello! This is a bulk message sent to all recipients. Thank you for subscribing!',
298298
senderName: 'My Awesome App',

src/references/web3telegram/methods/sendTelegramCampaign.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const web3telegram = new IExecWeb3telegram(web3Provider);
3939

4040
// Step 1: Prepare the campaign
4141
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
42-
grantedAccess: grantedAccessArray,
42+
grantedAccesses: grantedAccessArray,
4343
telegramContent: 'My telegram message content',
4444
senderName: 'Awesome project team',
4545
});
@@ -59,7 +59,7 @@ const web3telegram = new IExecWeb3telegram(web3Provider);
5959

6060
// Step 1: Prepare the campaign
6161
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
62-
grantedAccess: grantedAccessArray,
62+
grantedAccesses: grantedAccessArray,
6363
telegramContent: 'My telegram message content',
6464
senderName: 'Awesome project team',
6565
});
@@ -165,7 +165,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
165165
// Step 3: Prepare the campaign
166166
// See: prepareTelegramCampaign method
167167
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
168-
grantedAccess: grantedAccessArray,
168+
grantedAccesses: grantedAccessArray,
169169
telegramContent: 'Hello! This is a bulk message to all recipients.',
170170
senderName: 'My Awesome App',
171171
});
@@ -204,7 +204,7 @@ const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
204204
// Step 3: Prepare the campaign
205205
// See: prepareTelegramCampaign method
206206
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
207-
grantedAccess: grantedAccessArray,
207+
grantedAccesses: grantedAccessArray,
208208
telegramContent: 'Hello! This is a bulk message to all recipients.',
209209
senderName: 'My Awesome App',
210210
});

0 commit comments

Comments
 (0)