particle-api-js 10.6.0 → 11.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/dist/particle.min.js +1 -1
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +256 -276
- package/package.json +1 -1
- package/src/Agent.js +10 -33
- package/src/EventStream.js +4 -1
- package/src/Particle.js +124 -154
- package/test/Agent.spec.js +0 -22
- package/test/EventStream.spec.js +4 -1
- package/test/Particle.spec.js +1 -46
package/docs/api.md
CHANGED
|
@@ -18,7 +18,6 @@
|
|
|
18
18
|
- [deleteCurrentAccessToken](#deletecurrentaccesstoken)
|
|
19
19
|
- [deleteActiveAccessTokens](#deleteactiveaccesstokens)
|
|
20
20
|
- [deleteUser](#deleteuser)
|
|
21
|
-
- [listAccessTokens](#listaccesstokens)
|
|
22
21
|
- [trackingIdentity](#trackingidentity)
|
|
23
22
|
- [listDevices](#listdevices)
|
|
24
23
|
- [getDevice](#getdevice)
|
|
@@ -140,7 +139,7 @@
|
|
|
140
139
|
|
|
141
140
|
## Particle
|
|
142
141
|
|
|
143
|
-
[src/Particle.js:
|
|
142
|
+
[src/Particle.js:19-2826](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L19-L2826 "Source code on GitHub")
|
|
144
143
|
|
|
145
144
|
Particle Cloud API wrapper.
|
|
146
145
|
|
|
@@ -156,7 +155,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
156
155
|
|
|
157
156
|
### constructor
|
|
158
157
|
|
|
159
|
-
[src/Particle.js:
|
|
158
|
+
[src/Particle.js:32-41](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L32-L41 "Source code on GitHub")
|
|
160
159
|
|
|
161
160
|
Contructor for the Cloud API wrapper.
|
|
162
161
|
|
|
@@ -169,11 +168,11 @@ Create a new Particle object and call methods below on it.
|
|
|
169
168
|
- `options.clientSecret` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**
|
|
170
169
|
- `options.clientId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?**
|
|
171
170
|
- `options.tokenDuration` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?**
|
|
172
|
-
- `options.auth` **
|
|
171
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. If not specified here, will have to be added to every request
|
|
173
172
|
|
|
174
173
|
### login
|
|
175
174
|
|
|
176
|
-
[src/Particle.js:
|
|
175
|
+
[src/Particle.js:78-95](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L78-L95 "Source code on GitHub")
|
|
177
176
|
|
|
178
177
|
Login to Particle Cloud using an existing Particle acccount.
|
|
179
178
|
|
|
@@ -190,7 +189,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
190
189
|
|
|
191
190
|
### sendOtp
|
|
192
191
|
|
|
193
|
-
[src/Particle.js:
|
|
192
|
+
[src/Particle.js:106-122](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L106-L122 "Source code on GitHub")
|
|
194
193
|
|
|
195
194
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
196
195
|
|
|
@@ -206,14 +205,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
206
205
|
|
|
207
206
|
### enableMfa
|
|
208
207
|
|
|
209
|
-
[src/Particle.js:
|
|
208
|
+
[src/Particle.js:132-134](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L132-L134 "Source code on GitHub")
|
|
210
209
|
|
|
211
210
|
Enable MFA on the currently logged in user
|
|
212
211
|
|
|
213
212
|
**Parameters**
|
|
214
213
|
|
|
215
214
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
216
|
-
- `options.auth` **
|
|
215
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
217
216
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
218
217
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
219
218
|
|
|
@@ -221,7 +220,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
221
220
|
|
|
222
221
|
### confirmMfa
|
|
223
222
|
|
|
224
|
-
[src/Particle.js:
|
|
223
|
+
[src/Particle.js:147-161](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L147-L161 "Source code on GitHub")
|
|
225
224
|
|
|
226
225
|
Confirm MFA for the user. This must be called with current TOTP code, determined from the results of enableMfa(). You will be prompted to enter an OTP code every time you login after enrollment is confirmed.
|
|
227
226
|
|
|
@@ -231,7 +230,7 @@ Confirm MFA for the user. This must be called with current TOTP code, determined
|
|
|
231
230
|
- `options.mfaToken` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Token given from previous step to
|
|
232
231
|
- `options.otp` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Current one-time-password generated from the authentication app
|
|
233
232
|
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
234
|
-
- `options.auth` **
|
|
233
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
235
234
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
236
235
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
237
236
|
|
|
@@ -239,7 +238,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
239
238
|
|
|
240
239
|
### disableMfa
|
|
241
240
|
|
|
242
|
-
[src/Particle.js:
|
|
241
|
+
[src/Particle.js:172-180](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L172-L180 "Source code on GitHub")
|
|
243
242
|
|
|
244
243
|
Disable MFA for the user.
|
|
245
244
|
|
|
@@ -247,7 +246,7 @@ Disable MFA for the user.
|
|
|
247
246
|
|
|
248
247
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
249
248
|
- `options.currentPassword` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** User's current password
|
|
250
|
-
- `options.auth` **
|
|
249
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
251
250
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
252
251
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
253
252
|
|
|
@@ -255,7 +254,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
255
254
|
|
|
256
255
|
### createCustomer
|
|
257
256
|
|
|
258
|
-
[src/Particle.js:
|
|
257
|
+
[src/Particle.js:192-208](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L192-L208 "Source code on GitHub")
|
|
259
258
|
|
|
260
259
|
Create Customer for Product.
|
|
261
260
|
|
|
@@ -272,7 +271,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
272
271
|
|
|
273
272
|
### loginAsClientOwner
|
|
274
273
|
|
|
275
|
-
[src/Particle.js:
|
|
274
|
+
[src/Particle.js:217-231](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L217-L231 "Source code on GitHub")
|
|
276
275
|
|
|
277
276
|
Login to Particle Cloud using an OAuth client.
|
|
278
277
|
|
|
@@ -286,7 +285,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
286
285
|
|
|
287
286
|
### createUser
|
|
288
287
|
|
|
289
|
-
[src/Particle.js:
|
|
288
|
+
[src/Particle.js:244-256](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L244-L256 "Source code on GitHub")
|
|
290
289
|
|
|
291
290
|
Create a user account for the Particle Cloud
|
|
292
291
|
|
|
@@ -304,7 +303,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
304
303
|
|
|
305
304
|
### verifyUser
|
|
306
305
|
|
|
307
|
-
[src/Particle.js:
|
|
306
|
+
[src/Particle.js:266-273](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L266-L273 "Source code on GitHub")
|
|
308
307
|
|
|
309
308
|
Verify new user account via verification email
|
|
310
309
|
|
|
@@ -319,7 +318,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
319
318
|
|
|
320
319
|
### resetPassword
|
|
321
320
|
|
|
322
|
-
[src/Particle.js:
|
|
321
|
+
[src/Particle.js:283-290](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L283-L290 "Source code on GitHub")
|
|
323
322
|
|
|
324
323
|
Send reset password email for a Particle Cloud user account
|
|
325
324
|
|
|
@@ -334,15 +333,13 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
334
333
|
|
|
335
334
|
### deleteAccessToken
|
|
336
335
|
|
|
337
|
-
[src/Particle.js:
|
|
336
|
+
[src/Particle.js:300-306](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L300-L306 "Source code on GitHub")
|
|
338
337
|
|
|
339
338
|
Revoke an access token
|
|
340
339
|
|
|
341
340
|
**Parameters**
|
|
342
341
|
|
|
343
342
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
344
|
-
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username of the Particle cloud account that the token belongs to.
|
|
345
|
-
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password for the account
|
|
346
343
|
- `options.token` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access token you wish to revoke
|
|
347
344
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
348
345
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -351,14 +348,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
351
348
|
|
|
352
349
|
### deleteCurrentAccessToken
|
|
353
350
|
|
|
354
|
-
[src/Particle.js:
|
|
351
|
+
[src/Particle.js:316-323](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L316-L323 "Source code on GitHub")
|
|
355
352
|
|
|
356
353
|
Revoke the current session access token
|
|
357
354
|
|
|
358
355
|
**Parameters**
|
|
359
356
|
|
|
360
357
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
361
|
-
- `options.auth` **
|
|
358
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
362
359
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
363
360
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
364
361
|
|
|
@@ -366,14 +363,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
366
363
|
|
|
367
364
|
### deleteActiveAccessTokens
|
|
368
365
|
|
|
369
|
-
[src/Particle.js:
|
|
366
|
+
[src/Particle.js:333-340](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L333-L340 "Source code on GitHub")
|
|
370
367
|
|
|
371
368
|
Revoke all active access tokens
|
|
372
369
|
|
|
373
370
|
**Parameters**
|
|
374
371
|
|
|
375
372
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
376
|
-
- `options.auth` **
|
|
373
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
377
374
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
378
375
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
379
376
|
|
|
@@ -381,40 +378,23 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
381
378
|
|
|
382
379
|
### deleteUser
|
|
383
380
|
|
|
384
|
-
[src/Particle.js:
|
|
381
|
+
[src/Particle.js:351-359](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L351-L359 "Source code on GitHub")
|
|
385
382
|
|
|
386
383
|
Delete the current user
|
|
387
384
|
|
|
388
385
|
**Parameters**
|
|
389
386
|
|
|
390
387
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
391
|
-
- `options.auth` **
|
|
388
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
392
389
|
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
|
|
393
390
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
394
391
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
395
392
|
|
|
396
393
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
397
394
|
|
|
398
|
-
### listAccessTokens
|
|
399
|
-
|
|
400
|
-
[src/Particle.js:376-384](https://github.com/spark/particle-api-js/blob/be140b28fba0636f389ec10a4fe492586de434c8/src/Particle.js#L376-L384 "Source code on GitHub")
|
|
401
|
-
|
|
402
|
-
List all valid access tokens for a Particle Cloud account
|
|
403
|
-
|
|
404
|
-
**Parameters**
|
|
405
|
-
|
|
406
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
407
|
-
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username
|
|
408
|
-
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Password
|
|
409
|
-
- `options.otp` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current one-time-password generated from the authentication application
|
|
410
|
-
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
411
|
-
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
412
|
-
|
|
413
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
414
|
-
|
|
415
395
|
### trackingIdentity
|
|
416
396
|
|
|
417
|
-
[src/Particle.js:
|
|
397
|
+
[src/Particle.js:371-379](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L371-L379 "Source code on GitHub")
|
|
418
398
|
|
|
419
399
|
Retrieves the information that is used to identify the current login for tracking.
|
|
420
400
|
|
|
@@ -423,7 +403,7 @@ Retrieves the information that is used to identify the current login for trackin
|
|
|
423
403
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options for this API call (optional, default `{}`)
|
|
424
404
|
- `options.full` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** When true, retrieve all information for registering a user with the tracking API. When false,
|
|
425
405
|
retrieve only the unique tracking ID for the current login. (optional, default `false`)
|
|
426
|
-
- `options.auth` **
|
|
406
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
427
407
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
428
408
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
429
409
|
|
|
@@ -431,7 +411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
431
411
|
|
|
432
412
|
### listDevices
|
|
433
413
|
|
|
434
|
-
[src/Particle.js:
|
|
414
|
+
[src/Particle.js:397-416](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L397-L416 "Source code on GitHub")
|
|
435
415
|
|
|
436
416
|
List devices claimed to the account or product
|
|
437
417
|
|
|
@@ -446,7 +426,7 @@ List devices claimed to the account or product
|
|
|
446
426
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Current page of results
|
|
447
427
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Records per page
|
|
448
428
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** List devices in this product ID or slug
|
|
449
|
-
- `options.auth` **
|
|
429
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
450
430
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
451
431
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
452
432
|
|
|
@@ -454,7 +434,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
454
434
|
|
|
455
435
|
### getDevice
|
|
456
436
|
|
|
457
|
-
[src/Particle.js:
|
|
437
|
+
[src/Particle.js:428-431](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L428-L431 "Source code on GitHub")
|
|
458
438
|
|
|
459
439
|
Get detailed informationa about a device
|
|
460
440
|
|
|
@@ -463,7 +443,7 @@ Get detailed informationa about a device
|
|
|
463
443
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
464
444
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
465
445
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
466
|
-
- `options.auth` **
|
|
446
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
467
447
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
468
448
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
469
449
|
|
|
@@ -471,7 +451,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
471
451
|
|
|
472
452
|
### claimDevice
|
|
473
453
|
|
|
474
|
-
[src/Particle.js:
|
|
454
|
+
[src/Particle.js:443-454](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L443-L454 "Source code on GitHub")
|
|
475
455
|
|
|
476
456
|
Claim a device to the account. The device must be online and unclaimed.
|
|
477
457
|
|
|
@@ -480,7 +460,7 @@ Claim a device to the account. The device must be online and unclaimed.
|
|
|
480
460
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
481
461
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
482
462
|
- `options.requestTransfer` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** True to request the device be transfered from another user
|
|
483
|
-
- `options.auth` **
|
|
463
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
484
464
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
485
465
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
486
466
|
|
|
@@ -488,7 +468,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
488
468
|
|
|
489
469
|
### addDeviceToProduct
|
|
490
470
|
|
|
491
|
-
[src/Particle.js:
|
|
471
|
+
[src/Particle.js:468-486](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L468-L486 "Source code on GitHub")
|
|
492
472
|
|
|
493
473
|
Add a device to a product or move device out of quarantine.
|
|
494
474
|
|
|
@@ -499,7 +479,7 @@ Add a device to a product or move device out of quarantine.
|
|
|
499
479
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Add to this product ID or slug
|
|
500
480
|
- `options.file` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** A file that contains a single-column list of device IDs, device serial numbers, device IMEIs, or devie ICCIDs.
|
|
501
481
|
Node: Either a path or Buffer. Browser: a File or Blob.
|
|
502
|
-
- `options.auth` **
|
|
482
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
503
483
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
504
484
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
505
485
|
|
|
@@ -507,7 +487,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
507
487
|
|
|
508
488
|
### removeDevice
|
|
509
489
|
|
|
510
|
-
[src/Particle.js:
|
|
490
|
+
[src/Particle.js:499-503](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L499-L503 "Source code on GitHub")
|
|
511
491
|
|
|
512
492
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
513
493
|
|
|
@@ -517,7 +497,7 @@ Unclaim / Remove a device from your account or product, or deny quarantine
|
|
|
517
497
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
518
498
|
- `options.deny` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** (Product only) Deny this quarantined device, instead of removing an already approved device
|
|
519
499
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Remove from this product ID or slug
|
|
520
|
-
- `options.auth` **
|
|
500
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
521
501
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
522
502
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
523
503
|
|
|
@@ -525,7 +505,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
525
505
|
|
|
526
506
|
### removeDeviceOwner
|
|
527
507
|
|
|
528
|
-
[src/Particle.js:
|
|
508
|
+
[src/Particle.js:515-518](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L515-L518 "Source code on GitHub")
|
|
529
509
|
|
|
530
510
|
Unclaim a product device its the owner, but keep it in the product
|
|
531
511
|
|
|
@@ -534,7 +514,7 @@ Unclaim a product device its the owner, but keep it in the product
|
|
|
534
514
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
535
515
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
536
516
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Remove from this product ID or slug
|
|
537
|
-
- `options.auth` **
|
|
517
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
538
518
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
539
519
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
540
520
|
|
|
@@ -542,7 +522,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
542
522
|
|
|
543
523
|
### renameDevice
|
|
544
524
|
|
|
545
|
-
[src/Particle.js:
|
|
525
|
+
[src/Particle.js:531-533](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L531-L533 "Source code on GitHub")
|
|
546
526
|
|
|
547
527
|
Rename a device
|
|
548
528
|
|
|
@@ -552,7 +532,7 @@ Rename a device
|
|
|
552
532
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
553
533
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Desired Name
|
|
554
534
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Rename device in this product ID or slug
|
|
555
|
-
- `options.auth` **
|
|
535
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
556
536
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
557
537
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
558
538
|
|
|
@@ -560,7 +540,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
560
540
|
|
|
561
541
|
### signalDevice
|
|
562
542
|
|
|
563
|
-
[src/Particle.js:
|
|
543
|
+
[src/Particle.js:546-548](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L546-L548 "Source code on GitHub")
|
|
564
544
|
|
|
565
545
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
566
546
|
|
|
@@ -570,7 +550,7 @@ Instruct the device to turn on/off the LED in a rainbow pattern
|
|
|
570
550
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
571
551
|
- `options.signal` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Signal on or off
|
|
572
552
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
573
|
-
- `options.auth` **
|
|
553
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
574
554
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
575
555
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
576
556
|
|
|
@@ -578,7 +558,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
578
558
|
|
|
579
559
|
### setDeviceNotes
|
|
580
560
|
|
|
581
|
-
[src/Particle.js:
|
|
561
|
+
[src/Particle.js:561-563](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L561-L563 "Source code on GitHub")
|
|
582
562
|
|
|
583
563
|
Store some notes about device
|
|
584
564
|
|
|
@@ -588,7 +568,7 @@ Store some notes about device
|
|
|
588
568
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
589
569
|
- `options.notes` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Your notes about this device
|
|
590
570
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
591
|
-
- `options.auth` **
|
|
571
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
592
572
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
593
573
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
594
574
|
|
|
@@ -596,7 +576,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
596
576
|
|
|
597
577
|
### markAsDevelopmentDevice
|
|
598
578
|
|
|
599
|
-
[src/Particle.js:
|
|
579
|
+
[src/Particle.js:576-578](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L576-L578 "Source code on GitHub")
|
|
600
580
|
|
|
601
581
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
602
582
|
|
|
@@ -606,7 +586,7 @@ Mark device as being used in development of a product so it opts out of automati
|
|
|
606
586
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
607
587
|
- `options.development` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Set to true to mark as development, false to return to product fleet (optional, default `true`)
|
|
608
588
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
|
|
609
|
-
- `options.auth` **
|
|
589
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
610
590
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
611
591
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
612
592
|
|
|
@@ -614,7 +594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
614
594
|
|
|
615
595
|
### lockDeviceProductFirmware
|
|
616
596
|
|
|
617
|
-
[src/Particle.js:
|
|
597
|
+
[src/Particle.js:592-594](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L592-L594 "Source code on GitHub")
|
|
618
598
|
|
|
619
599
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
620
600
|
|
|
@@ -625,7 +605,7 @@ Mark device as being used in development of a product, so it opts out of automat
|
|
|
625
605
|
- `options.desiredFirmwareVersion` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Lock the product device to run this firmware version.
|
|
626
606
|
- `options.flash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Immediately flash firmware indicated by desiredFirmwareVersion
|
|
627
607
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
|
|
628
|
-
- `options.auth` **
|
|
608
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
629
609
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
630
610
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
631
611
|
|
|
@@ -633,7 +613,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
633
613
|
|
|
634
614
|
### unlockDeviceProductFirmware
|
|
635
615
|
|
|
636
|
-
[src/Particle.js:
|
|
616
|
+
[src/Particle.js:606-608](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L606-L608 "Source code on GitHub")
|
|
637
617
|
|
|
638
618
|
Mark device as receiving automatic firmware updates
|
|
639
619
|
|
|
@@ -642,7 +622,7 @@ Mark device as receiving automatic firmware updates
|
|
|
642
622
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
643
623
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
644
624
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device in this product ID or slug
|
|
645
|
-
- `options.auth` **
|
|
625
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
646
626
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
647
627
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
648
628
|
|
|
@@ -650,7 +630,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
650
630
|
|
|
651
631
|
### updateDevice
|
|
652
632
|
|
|
653
|
-
[src/Particle.js:
|
|
633
|
+
[src/Particle.js:627-639](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L627-L639 "Source code on GitHub")
|
|
654
634
|
|
|
655
635
|
Update multiple device attributes at the same time
|
|
656
636
|
|
|
@@ -666,7 +646,7 @@ Update multiple device attributes at the same time
|
|
|
666
646
|
Pass `null` to unlock firmware and go back to released firmware.
|
|
667
647
|
- `options.flash` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** (Product only) Immediately flash firmware indicated by desiredFirmwareVersion
|
|
668
648
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
669
|
-
- `options.auth` **
|
|
649
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
670
650
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
671
651
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
672
652
|
|
|
@@ -674,7 +654,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
674
654
|
|
|
675
655
|
### unprotectDevice
|
|
676
656
|
|
|
677
|
-
[src/Particle.js:
|
|
657
|
+
[src/Particle.js:659-675](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L659-L675 "Source code on GitHub")
|
|
678
658
|
|
|
679
659
|
Disable device protection.
|
|
680
660
|
|
|
@@ -690,7 +670,7 @@ Disable device protection.
|
|
|
690
670
|
- `options.deviceSignature` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Base64-encoded device signature. Mandatory if `action` is `confirm`,
|
|
691
671
|
- `options.devicePublicKeyFingerprint` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Base64-encoded fingerprint of the device public key.
|
|
692
672
|
Mandatory if `action` is `confirm`,
|
|
693
|
-
- `options.auth` **
|
|
673
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor.
|
|
694
674
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/value pairs to send as headers.
|
|
695
675
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
696
676
|
|
|
@@ -698,7 +678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
698
678
|
|
|
699
679
|
### provisionDevice
|
|
700
680
|
|
|
701
|
-
[src/Particle.js:
|
|
681
|
+
[src/Particle.js:686-694](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L686-L694 "Source code on GitHub")
|
|
702
682
|
|
|
703
683
|
Provision a new device for products that allow self-provisioning
|
|
704
684
|
|
|
@@ -706,7 +686,7 @@ Provision a new device for products that allow self-provisioning
|
|
|
706
686
|
|
|
707
687
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
708
688
|
- `options.productId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Product ID where to create this device
|
|
709
|
-
- `options.auth` **
|
|
689
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
710
690
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
711
691
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
712
692
|
|
|
@@ -714,7 +694,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
714
694
|
|
|
715
695
|
### getClaimCode
|
|
716
696
|
|
|
717
|
-
[src/Particle.js:
|
|
697
|
+
[src/Particle.js:708-711](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L708-L711 "Source code on GitHub")
|
|
718
698
|
|
|
719
699
|
Generate a claim code to use in the device claiming process.
|
|
720
700
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -725,7 +705,7 @@ customer of the product.
|
|
|
725
705
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
726
706
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** ICCID of the SIM card used in the Electron
|
|
727
707
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
728
|
-
- `options.auth` **
|
|
708
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
729
709
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
730
710
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
731
711
|
|
|
@@ -733,7 +713,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
733
713
|
|
|
734
714
|
### getVariable
|
|
735
715
|
|
|
736
|
-
[src/Particle.js:
|
|
716
|
+
[src/Particle.js:733-739](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L733-L739 "Source code on GitHub")
|
|
737
717
|
|
|
738
718
|
Get the value of a device variable
|
|
739
719
|
|
|
@@ -743,7 +723,7 @@ Get the value of a device variable
|
|
|
743
723
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
744
724
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Variable name
|
|
745
725
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
746
|
-
- `options.auth` **
|
|
726
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
747
727
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
748
728
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
749
729
|
|
|
@@ -751,7 +731,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
751
731
|
|
|
752
732
|
### flashDevice
|
|
753
733
|
|
|
754
|
-
[src/Particle.js:
|
|
734
|
+
[src/Particle.js:753-764](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L753-L764 "Source code on GitHub")
|
|
755
735
|
|
|
756
736
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
757
737
|
|
|
@@ -762,7 +742,7 @@ Compile and flash application firmware to a device. Pass a pre-compiled binary t
|
|
|
762
742
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Flash device in this product ID or slug
|
|
763
743
|
- `options.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object containing files to be compiled and flashed. Keys should be the filenames, including relative path, and the values should be a path or Buffer of the file contents in Node, or a File or Blob in the browser.
|
|
764
744
|
- `options.targetVersion` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** System firmware version to compile against (optional, default `latest`)
|
|
765
|
-
- `options.auth` **
|
|
745
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
766
746
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
767
747
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
768
748
|
|
|
@@ -770,7 +750,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
770
750
|
|
|
771
751
|
### flashTinker
|
|
772
752
|
|
|
773
|
-
[src/Particle.js:
|
|
753
|
+
[src/Particle.js:775-790](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L775-L790 "Source code on GitHub")
|
|
774
754
|
|
|
775
755
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
776
756
|
|
|
@@ -778,7 +758,7 @@ DEPRECATED: Flash the Tinker application to a device. Instead compile and flash
|
|
|
778
758
|
|
|
779
759
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
780
760
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
781
|
-
- `options.auth` **
|
|
761
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
782
762
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
783
763
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
784
764
|
|
|
@@ -786,7 +766,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
786
766
|
|
|
787
767
|
### compileCode
|
|
788
768
|
|
|
789
|
-
[src/Particle.js:
|
|
769
|
+
[src/Particle.js:803-821](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L803-L821 "Source code on GitHub")
|
|
790
770
|
|
|
791
771
|
Compile firmware using the Particle Cloud
|
|
792
772
|
|
|
@@ -796,7 +776,7 @@ Compile firmware using the Particle Cloud
|
|
|
796
776
|
- `options.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object containing files to be compiled. Keys should be the filenames, including relative path, and the values should be a path or Buffer of the file contents in Node, or a File or Blob in the browser.
|
|
797
777
|
- `options.platformId` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Platform id number of the device you are compiling for. Common values are 0=Core, 6=Photon, 10=Electron.
|
|
798
778
|
- `options.targetVersion` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** System firmware version to compile against (optional, default `latest`)
|
|
799
|
-
- `options.auth` **
|
|
779
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
800
780
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
801
781
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
802
782
|
|
|
@@ -804,7 +784,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
804
784
|
|
|
805
785
|
### downloadFirmwareBinary
|
|
806
786
|
|
|
807
|
-
[src/Particle.js:
|
|
787
|
+
[src/Particle.js:832-841](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L832-L841 "Source code on GitHub")
|
|
808
788
|
|
|
809
789
|
Download a firmware binary
|
|
810
790
|
|
|
@@ -812,7 +792,7 @@ Download a firmware binary
|
|
|
812
792
|
|
|
813
793
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
814
794
|
- `options.binaryId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Binary ID received from a successful compile call
|
|
815
|
-
- `options.auth` **
|
|
795
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
816
796
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
817
797
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
818
798
|
|
|
@@ -820,7 +800,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
820
800
|
|
|
821
801
|
### sendPublicKey
|
|
822
802
|
|
|
823
|
-
[src/Particle.js:
|
|
803
|
+
[src/Particle.js:854-868](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L854-L868 "Source code on GitHub")
|
|
824
804
|
|
|
825
805
|
Send a new device public key to the Particle Cloud
|
|
826
806
|
|
|
@@ -830,7 +810,7 @@ Send a new device public key to the Particle Cloud
|
|
|
830
810
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID or Name
|
|
831
811
|
- `options.key` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** Public key contents
|
|
832
812
|
- `options.algorithm` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Algorithm used to generate the public key. Valid values are `rsa` or `ecc`. (optional, default `rsa`)
|
|
833
|
-
- `options.auth` **
|
|
813
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
834
814
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
835
815
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
836
816
|
|
|
@@ -838,7 +818,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
838
818
|
|
|
839
819
|
### callFunction
|
|
840
820
|
|
|
841
|
-
[src/Particle.js:
|
|
821
|
+
[src/Particle.js:882-887](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L882-L887 "Source code on GitHub")
|
|
842
822
|
|
|
843
823
|
Call a device function
|
|
844
824
|
|
|
@@ -849,7 +829,7 @@ Call a device function
|
|
|
849
829
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Function name
|
|
850
830
|
- `options.argument` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Function argument
|
|
851
831
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Device in this product ID or slug
|
|
852
|
-
- `options.auth` **
|
|
832
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
853
833
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
854
834
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
855
835
|
|
|
@@ -857,7 +837,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
857
837
|
|
|
858
838
|
### getEventStream
|
|
859
839
|
|
|
860
|
-
[src/Particle.js:925
|
|
840
|
+
[src/Particle.js:900-925](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L900-L925 "Source code on GitHub")
|
|
861
841
|
|
|
862
842
|
Get a stream of events
|
|
863
843
|
|
|
@@ -868,14 +848,14 @@ Get a stream of events
|
|
|
868
848
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Event Name
|
|
869
849
|
- `options.org` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Organization Slug
|
|
870
850
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Events for this product ID or slug
|
|
871
|
-
- `options.auth` **
|
|
851
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
872
852
|
|
|
873
853
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If the promise resolves, the resolution value will be an EventStream object that will
|
|
874
854
|
emit 'event' events.
|
|
875
855
|
|
|
876
856
|
### publishEvent
|
|
877
857
|
|
|
878
|
-
[src/Particle.js:
|
|
858
|
+
[src/Particle.js:939-943](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L939-L943 "Source code on GitHub")
|
|
879
859
|
|
|
880
860
|
Publish a event to the Particle Cloud
|
|
881
861
|
|
|
@@ -886,7 +866,7 @@ Publish a event to the Particle Cloud
|
|
|
886
866
|
- `options.data` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Event data
|
|
887
867
|
- `options.isPrivate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should the event be publicly available?
|
|
888
868
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Event for this product ID or slug
|
|
889
|
-
- `options.auth` **
|
|
869
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
890
870
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
891
871
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
892
872
|
|
|
@@ -894,7 +874,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
894
874
|
|
|
895
875
|
### Hook
|
|
896
876
|
|
|
897
|
-
[src/Particle.js:
|
|
877
|
+
[src/Particle.js:974-996](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L974-L996 "Source code on GitHub")
|
|
898
878
|
|
|
899
879
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
900
880
|
|
|
@@ -915,7 +895,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
915
895
|
**Properties**
|
|
916
896
|
|
|
917
897
|
- `method` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Type of web request triggered by the Webhook (GET, POST, PUT, or DELETE)
|
|
918
|
-
- `auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Auth data like `{
|
|
898
|
+
- `auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Auth data like `{ user: 'me', pass: '1234' }` for basic auth or `{ bearer: 'token' }` to send with the Webhook request
|
|
919
899
|
- `headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Additional headers to add to the Webhook like `{ 'X-ONE': '1', X-TWO: '2' }`
|
|
920
900
|
- `query` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Query params to add to the Webhook request like `{ foo: 'foo', bar: 'bar' }`
|
|
921
901
|
- `json` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** JSON data to send with the Webhook request - sets `Content-Type` to `application/json`
|
|
@@ -927,7 +907,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
927
907
|
|
|
928
908
|
### createWebhook
|
|
929
909
|
|
|
930
|
-
[src/Particle.js:
|
|
910
|
+
[src/Particle.js:974-996](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L974-L996 "Source code on GitHub")
|
|
931
911
|
|
|
932
912
|
Create a webhook
|
|
933
913
|
|
|
@@ -941,7 +921,7 @@ Create a webhook
|
|
|
941
921
|
- `options.noDefaults` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Don't include default event data in the webhook request
|
|
942
922
|
- `options.hook` **Hook?** Webhook configuration settings
|
|
943
923
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhook for this product ID or slug
|
|
944
|
-
- `options.auth` **
|
|
924
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
945
925
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
946
926
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
947
927
|
|
|
@@ -949,7 +929,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
949
929
|
|
|
950
930
|
### deleteWebhook
|
|
951
931
|
|
|
952
|
-
[src/Particle.js:
|
|
932
|
+
[src/Particle.js:1008-1011](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1008-L1011 "Source code on GitHub")
|
|
953
933
|
|
|
954
934
|
Delete a webhook
|
|
955
935
|
|
|
@@ -958,7 +938,7 @@ Delete a webhook
|
|
|
958
938
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
959
939
|
- `options.hookId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Webhook ID
|
|
960
940
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhook for this product ID or slug
|
|
961
|
-
- `options.auth` **
|
|
941
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
962
942
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
963
943
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
964
944
|
|
|
@@ -966,7 +946,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
966
946
|
|
|
967
947
|
### listWebhooks
|
|
968
948
|
|
|
969
|
-
[src/Particle.js:
|
|
949
|
+
[src/Particle.js:1022-1025](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1022-L1025 "Source code on GitHub")
|
|
970
950
|
|
|
971
951
|
List all webhooks owned by the account or product
|
|
972
952
|
|
|
@@ -974,7 +954,7 @@ List all webhooks owned by the account or product
|
|
|
974
954
|
|
|
975
955
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
976
956
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Webhooks for this product ID or slug
|
|
977
|
-
- `options.auth` **
|
|
957
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
978
958
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
979
959
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
980
960
|
|
|
@@ -982,7 +962,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
982
962
|
|
|
983
963
|
### createIntegration
|
|
984
964
|
|
|
985
|
-
[src/Particle.js:
|
|
965
|
+
[src/Particle.js:1042-1046](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1042-L1046 "Source code on GitHub")
|
|
986
966
|
|
|
987
967
|
Create an integration to send events to an external service
|
|
988
968
|
|
|
@@ -995,7 +975,7 @@ See the API docs for details <https://docs.particle.io/reference/api/#integratio
|
|
|
995
975
|
- `options.settings` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Settings specific to that integration type
|
|
996
976
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Trigger integration only for this device ID or Name
|
|
997
977
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
|
|
998
|
-
- `options.auth` **
|
|
978
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
999
979
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1000
980
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1001
981
|
|
|
@@ -1003,7 +983,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1003
983
|
|
|
1004
984
|
### editIntegration
|
|
1005
985
|
|
|
1006
|
-
[src/Particle.js:
|
|
986
|
+
[src/Particle.js:1064-1068](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1064-L1068 "Source code on GitHub")
|
|
1007
987
|
|
|
1008
988
|
Edit an integration to send events to an external service
|
|
1009
989
|
|
|
@@ -1017,7 +997,7 @@ See the API docs for details <https://docs.particle.io/reference/api/#integratio
|
|
|
1017
997
|
- `options.settings` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Change the settings specific to that integration type
|
|
1018
998
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Trigger integration only for this device ID or Name
|
|
1019
999
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
|
|
1020
|
-
- `options.auth` **
|
|
1000
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1021
1001
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1022
1002
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1023
1003
|
|
|
@@ -1025,7 +1005,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1025
1005
|
|
|
1026
1006
|
### deleteIntegration
|
|
1027
1007
|
|
|
1028
|
-
[src/Particle.js:
|
|
1008
|
+
[src/Particle.js:1081-1084](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1081-L1084 "Source code on GitHub")
|
|
1029
1009
|
|
|
1030
1010
|
Delete an integration to send events to an external service
|
|
1031
1011
|
|
|
@@ -1034,7 +1014,7 @@ Delete an integration to send events to an external service
|
|
|
1034
1014
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1035
1015
|
- `options.integrationId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The integration to remove
|
|
1036
1016
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integration for this product ID or slug
|
|
1037
|
-
- `options.auth` **
|
|
1017
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1038
1018
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1039
1019
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1040
1020
|
|
|
@@ -1042,7 +1022,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1042
1022
|
|
|
1043
1023
|
### listIntegrations
|
|
1044
1024
|
|
|
1045
|
-
[src/Particle.js:
|
|
1025
|
+
[src/Particle.js:1095-1098](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1095-L1098 "Source code on GitHub")
|
|
1046
1026
|
|
|
1047
1027
|
List all integrations owned by the account or product
|
|
1048
1028
|
|
|
@@ -1050,7 +1030,7 @@ List all integrations owned by the account or product
|
|
|
1050
1030
|
|
|
1051
1031
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1052
1032
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Integrations for this product ID or slug
|
|
1053
|
-
- `options.auth` **
|
|
1033
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1054
1034
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1055
1035
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1056
1036
|
|
|
@@ -1058,14 +1038,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1058
1038
|
|
|
1059
1039
|
### getUserInfo
|
|
1060
1040
|
|
|
1061
|
-
[src/Particle.js:
|
|
1041
|
+
[src/Particle.js:1108-1110](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1108-L1110 "Source code on GitHub")
|
|
1062
1042
|
|
|
1063
1043
|
Get details about the current user
|
|
1064
1044
|
|
|
1065
1045
|
**Parameters**
|
|
1066
1046
|
|
|
1067
1047
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1068
|
-
- `options.auth` **
|
|
1048
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1069
1049
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1070
1050
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1071
1051
|
|
|
@@ -1073,7 +1053,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1073
1053
|
|
|
1074
1054
|
### setUserInfo
|
|
1075
1055
|
|
|
1076
|
-
[src/Particle.js:
|
|
1056
|
+
[src/Particle.js:1121-1124](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1121-L1124 "Source code on GitHub")
|
|
1077
1057
|
|
|
1078
1058
|
Set details on the current user
|
|
1079
1059
|
|
|
@@ -1081,7 +1061,7 @@ Set details on the current user
|
|
|
1081
1061
|
|
|
1082
1062
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1083
1063
|
- `options.accountInfo` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Set user's extended info fields (name, business account, company name, etc)
|
|
1084
|
-
- `options.auth` **
|
|
1064
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1085
1065
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1086
1066
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1087
1067
|
|
|
@@ -1089,7 +1069,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1089
1069
|
|
|
1090
1070
|
### changeUsername
|
|
1091
1071
|
|
|
1092
|
-
[src/Particle.js:
|
|
1072
|
+
[src/Particle.js:1137-1145](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1137-L1145 "Source code on GitHub")
|
|
1093
1073
|
|
|
1094
1074
|
Change username (i.e, email)
|
|
1095
1075
|
|
|
@@ -1099,7 +1079,7 @@ Change username (i.e, email)
|
|
|
1099
1079
|
- `options.currentPassword` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current password
|
|
1100
1080
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** New email
|
|
1101
1081
|
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
1102
|
-
- `options.auth` **
|
|
1082
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1103
1083
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1104
1084
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1105
1085
|
|
|
@@ -1107,7 +1087,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1107
1087
|
|
|
1108
1088
|
### changeUserPassword
|
|
1109
1089
|
|
|
1110
|
-
[src/Particle.js:
|
|
1090
|
+
[src/Particle.js:1158-1166](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1158-L1166 "Source code on GitHub")
|
|
1111
1091
|
|
|
1112
1092
|
Change user's password
|
|
1113
1093
|
|
|
@@ -1117,7 +1097,7 @@ Change user's password
|
|
|
1117
1097
|
- `options.currentPassword` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current password
|
|
1118
1098
|
- `options.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** New password
|
|
1119
1099
|
- `options.invalidateTokens` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Should all tokens be invalidated (optional, default `false`)
|
|
1120
|
-
- `options.auth` **
|
|
1100
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1121
1101
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1122
1102
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1123
1103
|
|
|
@@ -1125,7 +1105,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1125
1105
|
|
|
1126
1106
|
### listSIMs
|
|
1127
1107
|
|
|
1128
|
-
[src/Particle.js:
|
|
1108
|
+
[src/Particle.js:1182-1186](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1182-L1186 "Source code on GitHub")
|
|
1129
1109
|
|
|
1130
1110
|
List SIM cards owned by a user or product
|
|
1131
1111
|
|
|
@@ -1138,7 +1118,7 @@ List SIM cards owned by a user or product
|
|
|
1138
1118
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Current page of results
|
|
1139
1119
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (Product only) Records per page
|
|
1140
1120
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1141
|
-
- `options.auth` **
|
|
1121
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1142
1122
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1143
1123
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1144
1124
|
|
|
@@ -1146,7 +1126,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1146
1126
|
|
|
1147
1127
|
### getSIMDataUsage
|
|
1148
1128
|
|
|
1149
|
-
[src/Particle.js:
|
|
1129
|
+
[src/Particle.js:1198-1204](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1198-L1204 "Source code on GitHub")
|
|
1150
1130
|
|
|
1151
1131
|
Get data usage for one SIM card for the current billing period
|
|
1152
1132
|
|
|
@@ -1155,7 +1135,7 @@ Get data usage for one SIM card for the current billing period
|
|
|
1155
1135
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1156
1136
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1157
1137
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM card for this product ID or slug
|
|
1158
|
-
- `options.auth` **
|
|
1138
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1159
1139
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1160
1140
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1161
1141
|
|
|
@@ -1163,7 +1143,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1163
1143
|
|
|
1164
1144
|
### getFleetDataUsage
|
|
1165
1145
|
|
|
1166
|
-
[src/Particle.js:
|
|
1146
|
+
[src/Particle.js:1215-1222](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1215-L1222 "Source code on GitHub")
|
|
1167
1147
|
|
|
1168
1148
|
Get data usage for all SIM cards in a product the current billing period
|
|
1169
1149
|
|
|
@@ -1171,7 +1151,7 @@ Get data usage for all SIM cards in a product the current billing period
|
|
|
1171
1151
|
|
|
1172
1152
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1173
1153
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** SIM cards for this product ID or slug
|
|
1174
|
-
- `options.auth` **
|
|
1154
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1175
1155
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1176
1156
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1177
1157
|
|
|
@@ -1179,7 +1159,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1179
1159
|
|
|
1180
1160
|
### checkSIM
|
|
1181
1161
|
|
|
1182
|
-
[src/Particle.js:
|
|
1162
|
+
[src/Particle.js:1233-1235](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1233-L1235 "Source code on GitHub")
|
|
1183
1163
|
|
|
1184
1164
|
Check SIM status
|
|
1185
1165
|
|
|
@@ -1187,7 +1167,7 @@ Check SIM status
|
|
|
1187
1167
|
|
|
1188
1168
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1189
1169
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1190
|
-
- `options.auth` **
|
|
1170
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1191
1171
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1192
1172
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1193
1173
|
|
|
@@ -1195,7 +1175,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1195
1175
|
|
|
1196
1176
|
### activateSIM
|
|
1197
1177
|
|
|
1198
|
-
[src/Particle.js:
|
|
1178
|
+
[src/Particle.js:1250-1260](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1250-L1260 "Source code on GitHub")
|
|
1199
1179
|
|
|
1200
1180
|
Activate and add SIM cards to an account or product
|
|
1201
1181
|
|
|
@@ -1207,7 +1187,7 @@ Activate and add SIM cards to an account or product
|
|
|
1207
1187
|
- `options.country` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ISO country code for the SIM cards
|
|
1208
1188
|
- `options.promoCode` **any?**
|
|
1209
1189
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1210
|
-
- `options.auth` **
|
|
1190
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1211
1191
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1212
1192
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1213
1193
|
|
|
@@ -1215,7 +1195,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1215
1195
|
|
|
1216
1196
|
### deactivateSIM
|
|
1217
1197
|
|
|
1218
|
-
[src/Particle.js:
|
|
1198
|
+
[src/Particle.js:1272-1276](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1272-L1276 "Source code on GitHub")
|
|
1219
1199
|
|
|
1220
1200
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1221
1201
|
|
|
@@ -1224,7 +1204,7 @@ Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
|
1224
1204
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1225
1205
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1226
1206
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1227
|
-
- `options.auth` **
|
|
1207
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1228
1208
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1229
1209
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1230
1210
|
|
|
@@ -1232,7 +1212,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1232
1212
|
|
|
1233
1213
|
### reactivateSIM
|
|
1234
1214
|
|
|
1235
|
-
[src/Particle.js:
|
|
1215
|
+
[src/Particle.js:1289-1293](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1289-L1293 "Source code on GitHub")
|
|
1236
1216
|
|
|
1237
1217
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1238
1218
|
|
|
@@ -1242,7 +1222,7 @@ Reactivate a SIM card the was deactivated or unpause a SIM card that was automat
|
|
|
1242
1222
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1243
1223
|
- `options.mbLimit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** New monthly data limit. Necessary if unpausing a SIM card
|
|
1244
1224
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1245
|
-
- `options.auth` **
|
|
1225
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1246
1226
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1247
1227
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1248
1228
|
|
|
@@ -1250,7 +1230,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1250
1230
|
|
|
1251
1231
|
### updateSIM
|
|
1252
1232
|
|
|
1253
|
-
[src/Particle.js:
|
|
1233
|
+
[src/Particle.js:1306-1310](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1306-L1310 "Source code on GitHub")
|
|
1254
1234
|
|
|
1255
1235
|
Update SIM card data limit
|
|
1256
1236
|
|
|
@@ -1260,7 +1240,7 @@ Update SIM card data limit
|
|
|
1260
1240
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1261
1241
|
- `options.mbLimit` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Data limit in megabyte for the SIM card
|
|
1262
1242
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1263
|
-
- `options.auth` **
|
|
1243
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1264
1244
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1265
1245
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1266
1246
|
|
|
@@ -1268,7 +1248,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1268
1248
|
|
|
1269
1249
|
### removeSIM
|
|
1270
1250
|
|
|
1271
|
-
[src/Particle.js:
|
|
1251
|
+
[src/Particle.js:1322-1325](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1322-L1325 "Source code on GitHub")
|
|
1272
1252
|
|
|
1273
1253
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1274
1254
|
|
|
@@ -1277,7 +1257,7 @@ Remove a SIM card from an account so it can be activated by a different account
|
|
|
1277
1257
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1278
1258
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ICCID of the SIM card
|
|
1279
1259
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** SIM cards for this product ID or slug
|
|
1280
|
-
- `options.auth` **
|
|
1260
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1281
1261
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1282
1262
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1283
1263
|
|
|
@@ -1285,7 +1265,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1285
1265
|
|
|
1286
1266
|
### listBuildTargets
|
|
1287
1267
|
|
|
1288
|
-
[src/Particle.js:
|
|
1268
|
+
[src/Particle.js:1336-1339](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1336-L1339 "Source code on GitHub")
|
|
1289
1269
|
|
|
1290
1270
|
List valid build targets to be used for compiling
|
|
1291
1271
|
|
|
@@ -1293,7 +1273,7 @@ List valid build targets to be used for compiling
|
|
|
1293
1273
|
|
|
1294
1274
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1295
1275
|
- `options.onlyFeatured` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Only list featured build targets (optional, default `false`)
|
|
1296
|
-
- `options.auth` **
|
|
1276
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1297
1277
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1298
1278
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1299
1279
|
|
|
@@ -1301,7 +1281,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1301
1281
|
|
|
1302
1282
|
### listLibraries
|
|
1303
1283
|
|
|
1304
|
-
[src/Particle.js:
|
|
1284
|
+
[src/Particle.js:1365-1382](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1365-L1382 "Source code on GitHub")
|
|
1305
1285
|
|
|
1306
1286
|
List firmware libraries
|
|
1307
1287
|
|
|
@@ -1323,7 +1303,7 @@ List firmware libraries
|
|
|
1323
1303
|
\- 'verified' - list only verified libraries
|
|
1324
1304
|
\- 'featured' - list only featured libraries
|
|
1325
1305
|
- `options.excludeScopes` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** list of scopes to exclude
|
|
1326
|
-
- `options.auth` **
|
|
1306
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1327
1307
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1328
1308
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1329
1309
|
|
|
@@ -1331,7 +1311,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1331
1311
|
|
|
1332
1312
|
### getLibrary
|
|
1333
1313
|
|
|
1334
|
-
[src/Particle.js:
|
|
1314
|
+
[src/Particle.js:1398-1406](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1398-L1406 "Source code on GitHub")
|
|
1335
1315
|
|
|
1336
1316
|
Get firmware library details
|
|
1337
1317
|
|
|
@@ -1340,7 +1320,7 @@ Get firmware library details
|
|
|
1340
1320
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1341
1321
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to fetch
|
|
1342
1322
|
- `options.version` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the library to fetch (default: latest)
|
|
1343
|
-
- `options.auth` **
|
|
1323
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1344
1324
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1345
1325
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1346
1326
|
|
|
@@ -1348,7 +1328,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1348
1328
|
|
|
1349
1329
|
### getLibraryVersions
|
|
1350
1330
|
|
|
1351
|
-
[src/Particle.js:
|
|
1331
|
+
[src/Particle.js:1419-1427](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1419-L1427 "Source code on GitHub")
|
|
1352
1332
|
|
|
1353
1333
|
Firmware library details for each version
|
|
1354
1334
|
|
|
@@ -1358,7 +1338,7 @@ Firmware library details for each version
|
|
|
1358
1338
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to fetch
|
|
1359
1339
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Page index (default, first page)
|
|
1360
1340
|
- `options.limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Number of items per page
|
|
1361
|
-
- `options.auth` **
|
|
1341
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1362
1342
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1363
1343
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1364
1344
|
|
|
@@ -1366,7 +1346,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1366
1346
|
|
|
1367
1347
|
### contributeLibrary
|
|
1368
1348
|
|
|
1369
|
-
[src/Particle.js:
|
|
1349
|
+
[src/Particle.js:1439-1452](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1439-L1452 "Source code on GitHub")
|
|
1370
1350
|
|
|
1371
1351
|
Contribute a new library version from a compressed archive
|
|
1372
1352
|
|
|
@@ -1375,7 +1355,7 @@ Contribute a new library version from a compressed archive
|
|
|
1375
1355
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1376
1356
|
- `options.archive` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** Compressed archive file containing the library sources
|
|
1377
1357
|
Either a path or Buffer of the file contents in Node, or a File or Blob in the browser.
|
|
1378
|
-
- `options.auth` **
|
|
1358
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1379
1359
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1380
1360
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1381
1361
|
|
|
@@ -1383,7 +1363,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1383
1363
|
|
|
1384
1364
|
### publishLibrary
|
|
1385
1365
|
|
|
1386
|
-
[src/Particle.js:
|
|
1366
|
+
[src/Particle.js:1463-1472](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1463-L1472 "Source code on GitHub")
|
|
1387
1367
|
|
|
1388
1368
|
Publish the latest version of a library to the public
|
|
1389
1369
|
|
|
@@ -1391,7 +1371,7 @@ Publish the latest version of a library to the public
|
|
|
1391
1371
|
|
|
1392
1372
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1393
1373
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to publish
|
|
1394
|
-
- `options.auth` **
|
|
1374
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1395
1375
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1396
1376
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1397
1377
|
|
|
@@ -1399,7 +1379,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1399
1379
|
|
|
1400
1380
|
### deleteLibrary
|
|
1401
1381
|
|
|
1402
|
-
[src/Particle.js:
|
|
1382
|
+
[src/Particle.js:1484-1492](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1484-L1492 "Source code on GitHub")
|
|
1403
1383
|
|
|
1404
1384
|
Delete one version of a library or an entire private library
|
|
1405
1385
|
|
|
@@ -1408,7 +1388,7 @@ Delete one version of a library or an entire private library
|
|
|
1408
1388
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1409
1389
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the library to remove
|
|
1410
1390
|
- `options.force` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Key to force deleting a public library
|
|
1411
|
-
- `options.auth` **
|
|
1391
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1412
1392
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1413
1393
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1414
1394
|
|
|
@@ -1416,7 +1396,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1416
1396
|
|
|
1417
1397
|
### downloadFile
|
|
1418
1398
|
|
|
1419
|
-
[src/Particle.js:
|
|
1399
|
+
[src/Particle.js:1502-1504](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1502-L1504 "Source code on GitHub")
|
|
1420
1400
|
|
|
1421
1401
|
Download an external file that may not be on the API
|
|
1422
1402
|
|
|
@@ -1431,7 +1411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1431
1411
|
|
|
1432
1412
|
### listOAuthClients
|
|
1433
1413
|
|
|
1434
|
-
[src/Particle.js:
|
|
1414
|
+
[src/Particle.js:1515-1518](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1515-L1518 "Source code on GitHub")
|
|
1435
1415
|
|
|
1436
1416
|
List OAuth client created by the account
|
|
1437
1417
|
|
|
@@ -1439,7 +1419,7 @@ List OAuth client created by the account
|
|
|
1439
1419
|
|
|
1440
1420
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1441
1421
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** List clients for this product ID or slug
|
|
1442
|
-
- `options.auth` **
|
|
1422
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1443
1423
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1444
1424
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1445
1425
|
|
|
@@ -1447,7 +1427,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1447
1427
|
|
|
1448
1428
|
### createOAuthClient
|
|
1449
1429
|
|
|
1450
|
-
[src/Particle.js:
|
|
1430
|
+
[src/Particle.js:1533-1537](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1533-L1537 "Source code on GitHub")
|
|
1451
1431
|
|
|
1452
1432
|
Create an OAuth client
|
|
1453
1433
|
|
|
@@ -1459,7 +1439,7 @@ Create an OAuth client
|
|
|
1459
1439
|
- `options.redirect_uri` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** URL to redirect after OAuth flow. Only for type web.
|
|
1460
1440
|
- `options.scope` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Limits what the access tokens created by this client can do.
|
|
1461
1441
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Create client for this product ID or slug
|
|
1462
|
-
- `options.auth` **
|
|
1442
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1463
1443
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1464
1444
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1465
1445
|
|
|
@@ -1467,7 +1447,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1467
1447
|
|
|
1468
1448
|
### updateOAuthClient
|
|
1469
1449
|
|
|
1470
|
-
[src/Particle.js:
|
|
1450
|
+
[src/Particle.js:1551-1555](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1551-L1555 "Source code on GitHub")
|
|
1471
1451
|
|
|
1472
1452
|
Update an OAuth client
|
|
1473
1453
|
|
|
@@ -1478,7 +1458,7 @@ Update an OAuth client
|
|
|
1478
1458
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New Name of the OAuth client
|
|
1479
1459
|
- `options.scope` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** New scope of the OAuth client
|
|
1480
1460
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Update client linked to this product ID or slug
|
|
1481
|
-
- `options.auth` **
|
|
1461
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1482
1462
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1483
1463
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1484
1464
|
|
|
@@ -1486,7 +1466,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1486
1466
|
|
|
1487
1467
|
### deleteOAuthClient
|
|
1488
1468
|
|
|
1489
|
-
[src/Particle.js:
|
|
1469
|
+
[src/Particle.js:1567-1570](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1567-L1570 "Source code on GitHub")
|
|
1490
1470
|
|
|
1491
1471
|
Delete an OAuth client
|
|
1492
1472
|
|
|
@@ -1495,7 +1475,7 @@ Delete an OAuth client
|
|
|
1495
1475
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1496
1476
|
- `options.clientId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The OAuth client to update
|
|
1497
1477
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** OAuth client linked to this product ID or slug
|
|
1498
|
-
- `options.auth` **
|
|
1478
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1499
1479
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1500
1480
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1501
1481
|
|
|
@@ -1503,14 +1483,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1503
1483
|
|
|
1504
1484
|
### listProducts
|
|
1505
1485
|
|
|
1506
|
-
[src/Particle.js:
|
|
1486
|
+
[src/Particle.js:1580-1582](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1580-L1582 "Source code on GitHub")
|
|
1507
1487
|
|
|
1508
1488
|
List products the account has access to
|
|
1509
1489
|
|
|
1510
1490
|
**Parameters**
|
|
1511
1491
|
|
|
1512
1492
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1513
|
-
- `options.auth` **
|
|
1493
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1514
1494
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1515
1495
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1516
1496
|
|
|
@@ -1518,7 +1498,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1518
1498
|
|
|
1519
1499
|
### getProduct
|
|
1520
1500
|
|
|
1521
|
-
[src/Particle.js:
|
|
1501
|
+
[src/Particle.js:1593-1595](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1593-L1595 "Source code on GitHub")
|
|
1522
1502
|
|
|
1523
1503
|
Get detailed information about a product
|
|
1524
1504
|
|
|
@@ -1526,7 +1506,7 @@ Get detailed information about a product
|
|
|
1526
1506
|
|
|
1527
1507
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1528
1508
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Product ID or slug
|
|
1529
|
-
- `options.auth` **
|
|
1509
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1530
1510
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1531
1511
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1532
1512
|
|
|
@@ -1534,7 +1514,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1534
1514
|
|
|
1535
1515
|
### listProductFirmware
|
|
1536
1516
|
|
|
1537
|
-
[src/Particle.js:
|
|
1517
|
+
[src/Particle.js:1606-1608](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1606-L1608 "Source code on GitHub")
|
|
1538
1518
|
|
|
1539
1519
|
List product firmware versions
|
|
1540
1520
|
|
|
@@ -1542,7 +1522,7 @@ List product firmware versions
|
|
|
1542
1522
|
|
|
1543
1523
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1544
1524
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1545
|
-
- `options.auth` **
|
|
1525
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1546
1526
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1547
1527
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1548
1528
|
|
|
@@ -1550,7 +1530,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1550
1530
|
|
|
1551
1531
|
### uploadProductFirmware
|
|
1552
1532
|
|
|
1553
|
-
[src/Particle.js:
|
|
1533
|
+
[src/Particle.js:1624-1640](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1624-L1640 "Source code on GitHub")
|
|
1554
1534
|
|
|
1555
1535
|
List product firmware versions
|
|
1556
1536
|
|
|
@@ -1563,7 +1543,7 @@ List product firmware versions
|
|
|
1563
1543
|
- `options.title` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Short identifier for the new firmware
|
|
1564
1544
|
- `options.description` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Longer description for the new firmware
|
|
1565
1545
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1566
|
-
- `options.auth` **
|
|
1546
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1567
1547
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1568
1548
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1569
1549
|
|
|
@@ -1571,7 +1551,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1571
1551
|
|
|
1572
1552
|
### getProductFirmware
|
|
1573
1553
|
|
|
1574
|
-
[src/Particle.js:
|
|
1554
|
+
[src/Particle.js:1652-1659](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1652-L1659 "Source code on GitHub")
|
|
1575
1555
|
|
|
1576
1556
|
Get information about a product firmware version
|
|
1577
1557
|
|
|
@@ -1580,7 +1560,7 @@ Get information about a product firmware version
|
|
|
1580
1560
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1581
1561
|
- `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of firmware
|
|
1582
1562
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1583
|
-
- `options.auth` **
|
|
1563
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1584
1564
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1585
1565
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1586
1566
|
|
|
@@ -1588,7 +1568,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1588
1568
|
|
|
1589
1569
|
### updateProductFirmware
|
|
1590
1570
|
|
|
1591
|
-
[src/Particle.js:
|
|
1571
|
+
[src/Particle.js:1673-1676](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1673-L1676 "Source code on GitHub")
|
|
1592
1572
|
|
|
1593
1573
|
Update information for a product firmware version
|
|
1594
1574
|
|
|
@@ -1599,7 +1579,7 @@ Update information for a product firmware version
|
|
|
1599
1579
|
- `options.title` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New title
|
|
1600
1580
|
- `options.description` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** New description
|
|
1601
1581
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1602
|
-
- `options.auth` **
|
|
1582
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1603
1583
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1604
1584
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1605
1585
|
|
|
@@ -1607,7 +1587,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1607
1587
|
|
|
1608
1588
|
### downloadProductFirmware
|
|
1609
1589
|
|
|
1610
|
-
[src/Particle.js:
|
|
1590
|
+
[src/Particle.js:1688-1697](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1688-L1697 "Source code on GitHub")
|
|
1611
1591
|
|
|
1612
1592
|
Download a product firmware binary
|
|
1613
1593
|
|
|
@@ -1616,7 +1596,7 @@ Download a product firmware binary
|
|
|
1616
1596
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1617
1597
|
- `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
|
|
1618
1598
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1619
|
-
- `options.auth` **
|
|
1599
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1620
1600
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1621
1601
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1622
1602
|
|
|
@@ -1624,7 +1604,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1624
1604
|
|
|
1625
1605
|
### releaseProductFirmware
|
|
1626
1606
|
|
|
1627
|
-
[src/Particle.js:
|
|
1607
|
+
[src/Particle.js:1709-1712](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1709-L1712 "Source code on GitHub")
|
|
1628
1608
|
|
|
1629
1609
|
Release a product firmware version as the default version
|
|
1630
1610
|
|
|
@@ -1633,7 +1613,7 @@ Release a product firmware version as the default version
|
|
|
1633
1613
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1634
1614
|
- `options.version` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Version number of new firmware
|
|
1635
1615
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firmware for this product ID or slug
|
|
1636
|
-
- `options.auth` **
|
|
1616
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1637
1617
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1638
1618
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1639
1619
|
|
|
@@ -1641,7 +1621,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1641
1621
|
|
|
1642
1622
|
### listTeamMembers
|
|
1643
1623
|
|
|
1644
|
-
[src/Particle.js:
|
|
1624
|
+
[src/Particle.js:1723-1730](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1723-L1730 "Source code on GitHub")
|
|
1645
1625
|
|
|
1646
1626
|
List product team members
|
|
1647
1627
|
|
|
@@ -1649,7 +1629,7 @@ List product team members
|
|
|
1649
1629
|
|
|
1650
1630
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1651
1631
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
|
|
1652
|
-
- `options.auth` **
|
|
1632
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1653
1633
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1654
1634
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1655
1635
|
|
|
@@ -1657,7 +1637,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1657
1637
|
|
|
1658
1638
|
### inviteTeamMember
|
|
1659
1639
|
|
|
1660
|
-
[src/Particle.js:
|
|
1640
|
+
[src/Particle.js:1742-1750](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1742-L1750 "Source code on GitHub")
|
|
1661
1641
|
|
|
1662
1642
|
Invite Particle user to a product team
|
|
1663
1643
|
|
|
@@ -1666,7 +1646,7 @@ Invite Particle user to a product team
|
|
|
1666
1646
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1667
1647
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
|
|
1668
1648
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
|
|
1669
|
-
- `options.auth` **
|
|
1649
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1670
1650
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1671
1651
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1672
1652
|
|
|
@@ -1674,7 +1654,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1674
1654
|
|
|
1675
1655
|
### removeTeamMember
|
|
1676
1656
|
|
|
1677
|
-
[src/Particle.js:
|
|
1657
|
+
[src/Particle.js:1762-1769](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1762-L1769 "Source code on GitHub")
|
|
1678
1658
|
|
|
1679
1659
|
Remove Particle user to a product team
|
|
1680
1660
|
|
|
@@ -1683,7 +1663,7 @@ Remove Particle user to a product team
|
|
|
1683
1663
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1684
1664
|
- `options.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Username for the Particle account
|
|
1685
1665
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Team for this product ID or slug
|
|
1686
|
-
- `options.auth` **
|
|
1666
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1687
1667
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1688
1668
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1689
1669
|
|
|
@@ -1691,7 +1671,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1691
1671
|
|
|
1692
1672
|
### lookupSerialNumber
|
|
1693
1673
|
|
|
1694
|
-
[src/Particle.js:
|
|
1674
|
+
[src/Particle.js:1780-1787](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1780-L1787 "Source code on GitHub")
|
|
1695
1675
|
|
|
1696
1676
|
Fetch details about a serial number
|
|
1697
1677
|
|
|
@@ -1699,7 +1679,7 @@ Fetch details about a serial number
|
|
|
1699
1679
|
|
|
1700
1680
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1701
1681
|
- `options.serialNumber` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The serial number printed on the barcode of the device packaging
|
|
1702
|
-
- `options.auth` **
|
|
1682
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1703
1683
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1704
1684
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1705
1685
|
|
|
@@ -1707,7 +1687,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1707
1687
|
|
|
1708
1688
|
### createMeshNetwork
|
|
1709
1689
|
|
|
1710
|
-
[src/Particle.js:
|
|
1690
|
+
[src/Particle.js:1800-1808](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1800-L1808 "Source code on GitHub")
|
|
1711
1691
|
|
|
1712
1692
|
Create a mesh network
|
|
1713
1693
|
|
|
@@ -1717,7 +1697,7 @@ Create a mesh network
|
|
|
1717
1697
|
- `options.name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network name
|
|
1718
1698
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Gateway device ID
|
|
1719
1699
|
- `options.iccid` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** ICCID of the active SIM card (only for cellular gateway devices)
|
|
1720
|
-
- `options.auth` **
|
|
1700
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1721
1701
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1722
1702
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1723
1703
|
|
|
@@ -1725,7 +1705,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1725
1705
|
|
|
1726
1706
|
### removeMeshNetwork
|
|
1727
1707
|
|
|
1728
|
-
[src/Particle.js:
|
|
1708
|
+
[src/Particle.js:1819-1821](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1819-L1821 "Source code on GitHub")
|
|
1729
1709
|
|
|
1730
1710
|
Remove a mesh network.
|
|
1731
1711
|
|
|
@@ -1733,7 +1713,7 @@ Remove a mesh network.
|
|
|
1733
1713
|
|
|
1734
1714
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1735
1715
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1736
|
-
- `options.auth` **
|
|
1716
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1737
1717
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1738
1718
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1739
1719
|
|
|
@@ -1741,7 +1721,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1741
1721
|
|
|
1742
1722
|
### listMeshNetworks
|
|
1743
1723
|
|
|
1744
|
-
[src/Particle.js:
|
|
1724
|
+
[src/Particle.js:1833-1836](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1833-L1836 "Source code on GitHub")
|
|
1745
1725
|
|
|
1746
1726
|
List all mesh networks
|
|
1747
1727
|
|
|
@@ -1750,7 +1730,7 @@ List all mesh networks
|
|
|
1750
1730
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1751
1731
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Current page of results
|
|
1752
1732
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Records per page
|
|
1753
|
-
- `options.auth` **
|
|
1733
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1754
1734
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1755
1735
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1756
1736
|
|
|
@@ -1758,7 +1738,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1758
1738
|
|
|
1759
1739
|
### getMeshNetwork
|
|
1760
1740
|
|
|
1761
|
-
[src/Particle.js:
|
|
1741
|
+
[src/Particle.js:1847-1849](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1847-L1849 "Source code on GitHub")
|
|
1762
1742
|
|
|
1763
1743
|
Get information about a mesh network.
|
|
1764
1744
|
|
|
@@ -1766,7 +1746,7 @@ Get information about a mesh network.
|
|
|
1766
1746
|
|
|
1767
1747
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1768
1748
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1769
|
-
- `options.auth` **
|
|
1749
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1770
1750
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1771
1751
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1772
1752
|
|
|
@@ -1774,7 +1754,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1774
1754
|
|
|
1775
1755
|
### updateMeshNetwork
|
|
1776
1756
|
|
|
1777
|
-
[src/Particle.js:
|
|
1757
|
+
[src/Particle.js:1862-1870](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1862-L1870 "Source code on GitHub")
|
|
1778
1758
|
|
|
1779
1759
|
Modify a mesh network.
|
|
1780
1760
|
|
|
@@ -1784,7 +1764,7 @@ Modify a mesh network.
|
|
|
1784
1764
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1785
1765
|
- `options.action` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 'add-device', 'remove-device', 'gateway-enable' or 'gateway-disable'
|
|
1786
1766
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
1787
|
-
- `options.auth` **
|
|
1767
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1788
1768
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1789
1769
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1790
1770
|
|
|
@@ -1792,7 +1772,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1792
1772
|
|
|
1793
1773
|
### addMeshNetworkDevice
|
|
1794
1774
|
|
|
1795
|
-
[src/Particle.js:
|
|
1775
|
+
[src/Particle.js:1882-1891](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1882-L1891 "Source code on GitHub")
|
|
1796
1776
|
|
|
1797
1777
|
Add a device to a mesh network.
|
|
1798
1778
|
|
|
@@ -1801,7 +1781,7 @@ Add a device to a mesh network.
|
|
|
1801
1781
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1802
1782
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Network ID or name
|
|
1803
1783
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
1804
|
-
- `options.auth` **
|
|
1784
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1805
1785
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1806
1786
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1807
1787
|
|
|
@@ -1809,7 +1789,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1809
1789
|
|
|
1810
1790
|
### removeMeshNetworkDevice
|
|
1811
1791
|
|
|
1812
|
-
[src/Particle.js:
|
|
1792
|
+
[src/Particle.js:1903-1919](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1903-L1919 "Source code on GitHub")
|
|
1813
1793
|
|
|
1814
1794
|
Remove a device from a mesh network.
|
|
1815
1795
|
|
|
@@ -1818,7 +1798,7 @@ Remove a device from a mesh network.
|
|
|
1818
1798
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1819
1799
|
- `options.networkId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Network ID or name
|
|
1820
1800
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID
|
|
1821
|
-
- `options.auth` **
|
|
1801
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1822
1802
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1823
1803
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1824
1804
|
|
|
@@ -1826,7 +1806,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1826
1806
|
|
|
1827
1807
|
### listMeshNetworkDevices
|
|
1828
1808
|
|
|
1829
|
-
[src/Particle.js:
|
|
1809
|
+
[src/Particle.js:1933-1942](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1933-L1942 "Source code on GitHub")
|
|
1830
1810
|
|
|
1831
1811
|
List all devices of a mesh network.
|
|
1832
1812
|
|
|
@@ -1837,7 +1817,7 @@ List all devices of a mesh network.
|
|
|
1837
1817
|
- `options.role` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Device role: 'gateway' or 'node'
|
|
1838
1818
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Current page of results
|
|
1839
1819
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Records per page
|
|
1840
|
-
- `options.auth` **
|
|
1820
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1841
1821
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1842
1822
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
1843
1823
|
|
|
@@ -1845,14 +1825,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1845
1825
|
|
|
1846
1826
|
### getProductConfiguration
|
|
1847
1827
|
|
|
1848
|
-
[src/Particle.js:
|
|
1828
|
+
[src/Particle.js:1953-1960](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1953-L1960 "Source code on GitHub")
|
|
1849
1829
|
|
|
1850
1830
|
Get product configuration
|
|
1851
1831
|
|
|
1852
1832
|
**Parameters**
|
|
1853
1833
|
|
|
1854
1834
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1855
|
-
- `options.auth` **
|
|
1835
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1856
1836
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1857
1837
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
1858
1838
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -1861,14 +1841,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1861
1841
|
|
|
1862
1842
|
### getProductConfigurationSchema
|
|
1863
1843
|
|
|
1864
|
-
[src/Particle.js:
|
|
1844
|
+
[src/Particle.js:1971-1979](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1971-L1979 "Source code on GitHub")
|
|
1865
1845
|
|
|
1866
1846
|
Get product configuration schema
|
|
1867
1847
|
|
|
1868
1848
|
**Parameters**
|
|
1869
1849
|
|
|
1870
1850
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1871
|
-
- `options.auth` **
|
|
1851
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1872
1852
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1873
1853
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers. (optional, default `{}`)
|
|
1874
1854
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
@@ -1877,14 +1857,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1877
1857
|
|
|
1878
1858
|
### getProductDeviceConfiguration
|
|
1879
1859
|
|
|
1880
|
-
[src/Particle.js:
|
|
1860
|
+
[src/Particle.js:1991-1998](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L1991-L1998 "Source code on GitHub")
|
|
1881
1861
|
|
|
1882
1862
|
Get product device's configuration
|
|
1883
1863
|
|
|
1884
1864
|
**Parameters**
|
|
1885
1865
|
|
|
1886
1866
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1887
|
-
- `options.auth` **
|
|
1867
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1888
1868
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1889
1869
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1890
1870
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -1894,14 +1874,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1894
1874
|
|
|
1895
1875
|
### getProductDeviceConfigurationSchema
|
|
1896
1876
|
|
|
1897
|
-
[src/Particle.js:
|
|
1877
|
+
[src/Particle.js:2010-2018](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2010-L2018 "Source code on GitHub")
|
|
1898
1878
|
|
|
1899
1879
|
Get product device's configuration schema
|
|
1900
1880
|
|
|
1901
1881
|
**Parameters**
|
|
1902
1882
|
|
|
1903
1883
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1904
|
-
- `options.auth` **
|
|
1884
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1905
1885
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1906
1886
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1907
1887
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -1911,14 +1891,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1911
1891
|
|
|
1912
1892
|
### setProductConfiguration
|
|
1913
1893
|
|
|
1914
|
-
[src/Particle.js:
|
|
1894
|
+
[src/Particle.js:2030-2038](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2030-L2038 "Source code on GitHub")
|
|
1915
1895
|
|
|
1916
1896
|
Set product configuration
|
|
1917
1897
|
|
|
1918
1898
|
**Parameters**
|
|
1919
1899
|
|
|
1920
1900
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1921
|
-
- `options.auth` **
|
|
1901
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1922
1902
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1923
1903
|
- `options.config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Product configuration to update
|
|
1924
1904
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -1928,14 +1908,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1928
1908
|
|
|
1929
1909
|
### setProductDeviceConfiguration
|
|
1930
1910
|
|
|
1931
|
-
[src/Particle.js:
|
|
1911
|
+
[src/Particle.js:2051-2059](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2051-L2059 "Source code on GitHub")
|
|
1932
1912
|
|
|
1933
1913
|
Set product configuration for a specific device within the product
|
|
1934
1914
|
|
|
1935
1915
|
**Parameters**
|
|
1936
1916
|
|
|
1937
1917
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1938
|
-
- `options.auth` **
|
|
1918
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1939
1919
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Config for this product ID or slug
|
|
1940
1920
|
- `options.deviceId` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Device ID to access
|
|
1941
1921
|
- `options.config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Product configuration to update
|
|
@@ -1946,14 +1926,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1946
1926
|
|
|
1947
1927
|
### getProductLocations
|
|
1948
1928
|
|
|
1949
|
-
[src/Particle.js:
|
|
1929
|
+
[src/Particle.js:2078-2095](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2078-L2095 "Source code on GitHub")
|
|
1950
1930
|
|
|
1951
1931
|
Query location for devices within a product
|
|
1952
1932
|
|
|
1953
1933
|
**Parameters**
|
|
1954
1934
|
|
|
1955
1935
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1956
|
-
- `options.auth` **
|
|
1936
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1957
1937
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Locations for this product ID or slug
|
|
1958
1938
|
- `options.dateRange` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Start and end date in ISO8601 format, separated by comma, to query
|
|
1959
1939
|
- `options.rectBl` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
|
|
@@ -1970,14 +1950,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1970
1950
|
|
|
1971
1951
|
### getProductDeviceLocations
|
|
1972
1952
|
|
|
1973
|
-
[src/Particle.js:
|
|
1953
|
+
[src/Particle.js:2112-2124](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2112-L2124 "Source code on GitHub")
|
|
1974
1954
|
|
|
1975
1955
|
Query location for one device within a product
|
|
1976
1956
|
|
|
1977
1957
|
**Parameters**
|
|
1978
1958
|
|
|
1979
1959
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
1980
|
-
- `options.auth` **
|
|
1960
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
1981
1961
|
- `options.product` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Locations for this product ID or slug
|
|
1982
1962
|
- `options.dateRange` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Start and end date in ISO8601 format, separated by comma, to query
|
|
1983
1963
|
- `options.rectBl` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
|
|
@@ -1990,7 +1970,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1990
1970
|
|
|
1991
1971
|
### executeLogic
|
|
1992
1972
|
|
|
1993
|
-
[src/Particle.js:
|
|
1973
|
+
[src/Particle.js:2140-2148](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2140-L2148 "Source code on GitHub")
|
|
1994
1974
|
|
|
1995
1975
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
1996
1976
|
|
|
@@ -1999,7 +1979,7 @@ NOTE: Any external interactions such as Particle.publish will actually occur whe
|
|
|
1999
1979
|
**Parameters**
|
|
2000
1980
|
|
|
2001
1981
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
2002
|
-
- `options.auth` **
|
|
1982
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2003
1983
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2004
1984
|
- `options.logic` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic "function" which will be executed once
|
|
2005
1985
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2009,7 +1989,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2009
1989
|
|
|
2010
1990
|
### createLogicFunction
|
|
2011
1991
|
|
|
2012
|
-
[src/Particle.js:
|
|
1992
|
+
[src/Particle.js:2168-2176](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2168-L2176 "Source code on GitHub")
|
|
2013
1993
|
|
|
2014
1994
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
2015
1995
|
|
|
@@ -2022,7 +2002,7 @@ according to the cron and start_at properties.
|
|
|
2022
2002
|
**Parameters**
|
|
2023
2003
|
|
|
2024
2004
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
2025
|
-
- `options.auth` **
|
|
2005
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2026
2006
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2027
2007
|
- `options.logicFunction` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic function object containing the function details.
|
|
2028
2008
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2032,14 +2012,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2032
2012
|
|
|
2033
2013
|
### getLogicFunction
|
|
2034
2014
|
|
|
2035
|
-
[src/Particle.js:
|
|
2015
|
+
[src/Particle.js:2190-2197](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2190-L2197 "Source code on GitHub")
|
|
2036
2016
|
|
|
2037
2017
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2038
2018
|
|
|
2039
2019
|
**Parameters**
|
|
2040
2020
|
|
|
2041
2021
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
2042
|
-
- `options.auth` **
|
|
2022
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2043
2023
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2044
2024
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
2045
2025
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2049,7 +2029,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2049
2029
|
|
|
2050
2030
|
### updateLogicFunction
|
|
2051
2031
|
|
|
2052
|
-
[src/Particle.js:
|
|
2032
|
+
[src/Particle.js:2214-2222](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2214-L2222 "Source code on GitHub")
|
|
2053
2033
|
|
|
2054
2034
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2055
2035
|
|
|
@@ -2058,7 +2038,7 @@ If you include an id on a logic trigger, it will update the logic trigger in pla
|
|
|
2058
2038
|
**Parameters**
|
|
2059
2039
|
|
|
2060
2040
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
2061
|
-
- `options.auth` **
|
|
2041
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2062
2042
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2063
2043
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
2064
2044
|
- `options.logicFunction` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The logic function object containing the logic function details.
|
|
@@ -2069,14 +2049,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2069
2049
|
|
|
2070
2050
|
### deleteLogicFunction
|
|
2071
2051
|
|
|
2072
|
-
[src/Particle.js:
|
|
2052
|
+
[src/Particle.js:2236-2243](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2236-L2243 "Source code on GitHub")
|
|
2073
2053
|
|
|
2074
2054
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2075
2055
|
|
|
2076
2056
|
**Parameters**
|
|
2077
2057
|
|
|
2078
2058
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
2079
|
-
- `options.auth` **
|
|
2059
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2080
2060
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2081
2061
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
2082
2062
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2086,14 +2066,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2086
2066
|
|
|
2087
2067
|
### listLogicFunctions
|
|
2088
2068
|
|
|
2089
|
-
[src/Particle.js:
|
|
2069
|
+
[src/Particle.js:2257-2267](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2257-L2267 "Source code on GitHub")
|
|
2090
2070
|
|
|
2091
2071
|
Lists all logic functions in the specified organization or sandbox.
|
|
2092
2072
|
|
|
2093
2073
|
**Parameters**
|
|
2094
2074
|
|
|
2095
2075
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
2096
|
-
- `options.auth` **
|
|
2076
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2097
2077
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2098
2078
|
- `options.todayStats` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Whether to include today's stats in the response
|
|
2099
2079
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2103,14 +2083,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2103
2083
|
|
|
2104
2084
|
### listLogicRuns
|
|
2105
2085
|
|
|
2106
|
-
[src/Particle.js:
|
|
2086
|
+
[src/Particle.js:2281-2288](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2281-L2288 "Source code on GitHub")
|
|
2107
2087
|
|
|
2108
2088
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2109
2089
|
|
|
2110
2090
|
**Parameters**
|
|
2111
2091
|
|
|
2112
2092
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2113
|
-
- `options.auth` **
|
|
2093
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2114
2094
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2115
2095
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function for which to retrieve the logic runs.
|
|
2116
2096
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2120,14 +2100,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2120
2100
|
|
|
2121
2101
|
### getLogicRun
|
|
2122
2102
|
|
|
2123
|
-
[src/Particle.js:
|
|
2103
|
+
[src/Particle.js:2303-2310](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2303-L2310 "Source code on GitHub")
|
|
2124
2104
|
|
|
2125
2105
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2126
2106
|
|
|
2127
2107
|
**Parameters**
|
|
2128
2108
|
|
|
2129
2109
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2130
|
-
- `options.auth` **
|
|
2110
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2131
2111
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2132
2112
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function for which to retrieve the logic run.
|
|
2133
2113
|
- `options.logicRunId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic run to retrieve.
|
|
@@ -2138,14 +2118,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2138
2118
|
|
|
2139
2119
|
### getLogicRunLogs
|
|
2140
2120
|
|
|
2141
|
-
[src/Particle.js:
|
|
2121
|
+
[src/Particle.js:2325-2332](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2325-L2332 "Source code on GitHub")
|
|
2142
2122
|
|
|
2143
2123
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2144
2124
|
|
|
2145
2125
|
**Parameters**
|
|
2146
2126
|
|
|
2147
2127
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2148
|
-
- `options.auth` **
|
|
2128
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2149
2129
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
|
|
2150
2130
|
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function for which to retrieve the logic run logs.
|
|
2151
2131
|
- `options.logicRunId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic run for which to retrieve the logs.
|
|
@@ -2156,14 +2136,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2156
2136
|
|
|
2157
2137
|
### createLedger
|
|
2158
2138
|
|
|
2159
|
-
[src/Particle.js:
|
|
2139
|
+
[src/Particle.js:2346-2354](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2346-L2354 "Source code on GitHub")
|
|
2160
2140
|
|
|
2161
2141
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
2162
2142
|
|
|
2163
2143
|
**Parameters**
|
|
2164
2144
|
|
|
2165
2145
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the ledger definition.
|
|
2166
|
-
- `options.auth` **
|
|
2146
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2167
2147
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2168
2148
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
2169
2149
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2173,14 +2153,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2173
2153
|
|
|
2174
2154
|
### getLedger
|
|
2175
2155
|
|
|
2176
|
-
[src/Particle.js:
|
|
2156
|
+
[src/Particle.js:2368-2375](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2368-L2375 "Source code on GitHub")
|
|
2177
2157
|
|
|
2178
2158
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2179
2159
|
|
|
2180
2160
|
**Parameters**
|
|
2181
2161
|
|
|
2182
2162
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger definition.
|
|
2183
|
-
- `options.auth` **
|
|
2163
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2184
2164
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2185
2165
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the ledger definition to retrieve.
|
|
2186
2166
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2190,14 +2170,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2190
2170
|
|
|
2191
2171
|
### updateLedger
|
|
2192
2172
|
|
|
2193
|
-
[src/Particle.js:
|
|
2173
|
+
[src/Particle.js:2390-2398](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2390-L2398 "Source code on GitHub")
|
|
2194
2174
|
|
|
2195
2175
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2196
2176
|
|
|
2197
2177
|
**Parameters**
|
|
2198
2178
|
|
|
2199
2179
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger definition.
|
|
2200
|
-
- `options.auth` **
|
|
2180
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2201
2181
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2202
2182
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to update.
|
|
2203
2183
|
- `options.ledger` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The ledger definition object.
|
|
@@ -2208,14 +2188,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2208
2188
|
|
|
2209
2189
|
### archiveLedger
|
|
2210
2190
|
|
|
2211
|
-
[src/Particle.js:
|
|
2191
|
+
[src/Particle.js:2412-2419](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2412-L2419 "Source code on GitHub")
|
|
2212
2192
|
|
|
2213
2193
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2214
2194
|
|
|
2215
2195
|
**Parameters**
|
|
2216
2196
|
|
|
2217
2197
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger definition.
|
|
2218
|
-
- `options.auth` **
|
|
2198
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2219
2199
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2220
2200
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger definition to archive.
|
|
2221
2201
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
@@ -2225,7 +2205,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2225
2205
|
|
|
2226
2206
|
### Scope
|
|
2227
2207
|
|
|
2228
|
-
[src/Particle.js:
|
|
2208
|
+
[src/Particle.js:2440-2453](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2440-L2453 "Source code on GitHub")
|
|
2229
2209
|
|
|
2230
2210
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
2231
2211
|
|
|
@@ -2243,14 +2223,14 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
2243
2223
|
|
|
2244
2224
|
### listLedgers
|
|
2245
2225
|
|
|
2246
|
-
[src/Particle.js:
|
|
2226
|
+
[src/Particle.js:2440-2453](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2440-L2453 "Source code on GitHub")
|
|
2247
2227
|
|
|
2248
2228
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
2249
2229
|
|
|
2250
2230
|
**Parameters**
|
|
2251
2231
|
|
|
2252
2232
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger definitions.
|
|
2253
|
-
- `options.auth` **
|
|
2233
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2254
2234
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2255
2235
|
- `options.scope` **Scope?** Filter to show only ledgers of the specified scope
|
|
2256
2236
|
- `options.page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page of results to display
|
|
@@ -2263,14 +2243,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2263
2243
|
|
|
2264
2244
|
### getLedgerInstance
|
|
2265
2245
|
|
|
2266
|
-
[src/Particle.js:
|
|
2246
|
+
[src/Particle.js:2468-2475](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2468-L2475 "Source code on GitHub")
|
|
2267
2247
|
|
|
2268
2248
|
Get ledger instance data.
|
|
2269
2249
|
|
|
2270
2250
|
**Parameters**
|
|
2271
2251
|
|
|
2272
2252
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
2273
|
-
- `options.auth` **
|
|
2253
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2274
2254
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2275
2255
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2276
2256
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2281,7 +2261,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2281
2261
|
|
|
2282
2262
|
### SetMode
|
|
2283
2263
|
|
|
2284
|
-
[src/Particle.js:
|
|
2264
|
+
[src/Particle.js:2496-2507](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2496-L2507 "Source code on GitHub")
|
|
2285
2265
|
|
|
2286
2266
|
Type: (`"Replace"` \| `"Merge"`)
|
|
2287
2267
|
|
|
@@ -2299,14 +2279,14 @@ Type: (`"Replace"` \| `"Merge"`)
|
|
|
2299
2279
|
|
|
2300
2280
|
### setLedgerInstance
|
|
2301
2281
|
|
|
2302
|
-
[src/Particle.js:
|
|
2282
|
+
[src/Particle.js:2496-2507](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2496-L2507 "Source code on GitHub")
|
|
2303
2283
|
|
|
2304
2284
|
Set ledger instance data.
|
|
2305
2285
|
|
|
2306
2286
|
**Parameters**
|
|
2307
2287
|
|
|
2308
2288
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the ledger instance.
|
|
2309
|
-
- `options.auth` **
|
|
2289
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2310
2290
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2311
2291
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2312
2292
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2319,14 +2299,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2319
2299
|
|
|
2320
2300
|
### deleteLedgerInstance
|
|
2321
2301
|
|
|
2322
|
-
[src/Particle.js:
|
|
2302
|
+
[src/Particle.js:2522-2529](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2522-L2529 "Source code on GitHub")
|
|
2323
2303
|
|
|
2324
2304
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2325
2305
|
|
|
2326
2306
|
**Parameters**
|
|
2327
2307
|
|
|
2328
2308
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for archiving the ledger instance.
|
|
2329
|
-
- `options.auth` **
|
|
2309
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2330
2310
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2331
2311
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
2332
2312
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2337,14 +2317,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2337
2317
|
|
|
2338
2318
|
### listLedgerInstances
|
|
2339
2319
|
|
|
2340
|
-
[src/Particle.js:
|
|
2320
|
+
[src/Particle.js:2545-2556](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2545-L2556 "Source code on GitHub")
|
|
2341
2321
|
|
|
2342
2322
|
Lists ledger instances in the specified organization or sandbox.
|
|
2343
2323
|
|
|
2344
2324
|
**Parameters**
|
|
2345
2325
|
|
|
2346
2326
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing ledger instances.
|
|
2347
|
-
- `options.auth` **
|
|
2327
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2348
2328
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The unique identifier of the organization.
|
|
2349
2329
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of the ledger instance to archive.
|
|
2350
2330
|
- `options.page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page of results to display
|
|
@@ -2356,14 +2336,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2356
2336
|
|
|
2357
2337
|
### listLedgerInstanceVersions
|
|
2358
2338
|
|
|
2359
|
-
[src/Particle.js:
|
|
2339
|
+
[src/Particle.js:2573-2584](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2573-L2584 "Source code on GitHub")
|
|
2360
2340
|
|
|
2361
2341
|
List ledger instance versions
|
|
2362
2342
|
|
|
2363
2343
|
**Parameters**
|
|
2364
2344
|
|
|
2365
2345
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
2366
|
-
- `options.auth` **
|
|
2346
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2367
2347
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2368
2348
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2369
2349
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2376,14 +2356,14 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2376
2356
|
|
|
2377
2357
|
### getLedgerInstanceVersion
|
|
2378
2358
|
|
|
2379
|
-
[src/Particle.js:
|
|
2359
|
+
[src/Particle.js:2600-2607](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2600-L2607 "Source code on GitHub")
|
|
2380
2360
|
|
|
2381
2361
|
Get specific ledger instance version
|
|
2382
2362
|
|
|
2383
2363
|
**Parameters**
|
|
2384
2364
|
|
|
2385
2365
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the ledger instance.
|
|
2386
|
-
- `options.auth` **
|
|
2366
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2387
2367
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The Organization ID or slug. If not provided, the request will go to your sandbox account.
|
|
2388
2368
|
- `options.ledgerName` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Ledger name.
|
|
2389
2369
|
- `options.scopeValue` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Scope value.
|
|
@@ -2395,7 +2375,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2395
2375
|
|
|
2396
2376
|
### listDeviceOsVersions
|
|
2397
2377
|
|
|
2398
|
-
[src/Particle.js:
|
|
2378
|
+
[src/Particle.js:2623-2638](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2623-L2638 "Source code on GitHub")
|
|
2399
2379
|
|
|
2400
2380
|
List Device OS versions
|
|
2401
2381
|
|
|
@@ -2406,7 +2386,7 @@ List Device OS versions
|
|
|
2406
2386
|
- `options.internalVersion` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Internal version number to filter Device OS versions
|
|
2407
2387
|
- `options.page` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Page number for pagination
|
|
2408
2388
|
- `options.perPage` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Number of items per page
|
|
2409
|
-
- `options.auth` **
|
|
2389
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2410
2390
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2411
2391
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2412
2392
|
|
|
@@ -2414,7 +2394,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2414
2394
|
|
|
2415
2395
|
### getDeviceOsVersion
|
|
2416
2396
|
|
|
2417
|
-
[src/Particle.js:
|
|
2397
|
+
[src/Particle.js:2652-2661](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2652-L2661 "Source code on GitHub")
|
|
2418
2398
|
|
|
2419
2399
|
Get a specific Device OS version
|
|
2420
2400
|
|
|
@@ -2423,7 +2403,7 @@ Get a specific Device OS version
|
|
|
2423
2403
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
2424
2404
|
- `options.version` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Version of the Device OS
|
|
2425
2405
|
- `options.platformId` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Optional platform ID to filter Device OS version
|
|
2426
|
-
- `options.auth` **
|
|
2406
|
+
- `options.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The access token. Can be ignored if provided in constructor
|
|
2427
2407
|
- `options.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2428
2408
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2429
2409
|
|
|
@@ -2431,20 +2411,20 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2431
2411
|
|
|
2432
2412
|
### setDefaultAuth
|
|
2433
2413
|
|
|
2434
|
-
[src/Particle.js:
|
|
2414
|
+
[src/Particle.js:2668-2674](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2668-L2674 "Source code on GitHub")
|
|
2435
2415
|
|
|
2436
2416
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2437
2417
|
|
|
2438
2418
|
**Parameters**
|
|
2439
2419
|
|
|
2440
|
-
- `auth` **
|
|
2420
|
+
- `auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The access token
|
|
2441
2421
|
|
|
2442
2422
|
|
|
2443
2423
|
- Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** When not auth string is provided
|
|
2444
2424
|
|
|
2445
2425
|
### get
|
|
2446
2426
|
|
|
2447
|
-
[src/Particle.js:
|
|
2427
|
+
[src/Particle.js:2724-2728](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2724-L2728 "Source code on GitHub")
|
|
2448
2428
|
|
|
2449
2429
|
Make a GET request
|
|
2450
2430
|
|
|
@@ -2452,7 +2432,7 @@ Make a GET request
|
|
|
2452
2432
|
|
|
2453
2433
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2454
2434
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2455
|
-
- `params.auth` **
|
|
2435
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2456
2436
|
- `params.headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2457
2437
|
- `params.query` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs of query params or a correctly formatted string
|
|
2458
2438
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2461,7 +2441,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2461
2441
|
|
|
2462
2442
|
### head
|
|
2463
2443
|
|
|
2464
|
-
[src/Particle.js:
|
|
2444
|
+
[src/Particle.js:2740-2744](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2740-L2744 "Source code on GitHub")
|
|
2465
2445
|
|
|
2466
2446
|
Make a HEAD request
|
|
2467
2447
|
|
|
@@ -2469,7 +2449,7 @@ Make a HEAD request
|
|
|
2469
2449
|
|
|
2470
2450
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2471
2451
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2472
|
-
- `params.auth` **
|
|
2452
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2473
2453
|
- `params.headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2474
2454
|
- `params.query` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs of query params or a correctly formatted string
|
|
2475
2455
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2478,7 +2458,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2478
2458
|
|
|
2479
2459
|
### post
|
|
2480
2460
|
|
|
2481
|
-
[src/Particle.js:
|
|
2461
|
+
[src/Particle.js:2756-2760](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2756-L2760 "Source code on GitHub")
|
|
2482
2462
|
|
|
2483
2463
|
Make a POST request
|
|
2484
2464
|
|
|
@@ -2486,7 +2466,7 @@ Make a POST request
|
|
|
2486
2466
|
|
|
2487
2467
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2488
2468
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2489
|
-
- `params.auth` **
|
|
2469
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2490
2470
|
- `params.headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2491
2471
|
- `params.data` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Request body
|
|
2492
2472
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2495,7 +2475,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2495
2475
|
|
|
2496
2476
|
### put
|
|
2497
2477
|
|
|
2498
|
-
[src/Particle.js:
|
|
2478
|
+
[src/Particle.js:2773-2777](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2773-L2777 "Source code on GitHub")
|
|
2499
2479
|
|
|
2500
2480
|
Make a PUT request
|
|
2501
2481
|
|
|
@@ -2503,7 +2483,7 @@ Make a PUT request
|
|
|
2503
2483
|
|
|
2504
2484
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2505
2485
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2506
|
-
- `params.auth` **
|
|
2486
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2507
2487
|
- `params.headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2508
2488
|
- `params.data` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Request body
|
|
2509
2489
|
- `params.query` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs of query params or a correctly formatted string
|
|
@@ -2513,7 +2493,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2513
2493
|
|
|
2514
2494
|
### delete
|
|
2515
2495
|
|
|
2516
|
-
[src/Particle.js:
|
|
2496
|
+
[src/Particle.js:2789-2793](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2789-L2793 "Source code on GitHub")
|
|
2517
2497
|
|
|
2518
2498
|
Make a DELETE request
|
|
2519
2499
|
|
|
@@ -2521,7 +2501,7 @@ Make a DELETE request
|
|
|
2521
2501
|
|
|
2522
2502
|
- `params` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
2523
2503
|
- `params.uri` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URI to request
|
|
2524
|
-
- `params.auth` **
|
|
2504
|
+
- `params.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization token to use
|
|
2525
2505
|
- `params.headers` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2526
2506
|
- `params.data` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))?** Request body
|
|
2527
2507
|
- `params.context` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** The invocation context, describing the tool and project
|
|
@@ -2530,7 +2510,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2530
2510
|
|
|
2531
2511
|
### request
|
|
2532
2512
|
|
|
2533
|
-
[src/Particle.js:
|
|
2513
|
+
[src/Particle.js:2810-2814](https://github.com/particle-iot/particle-api-js/blob/e0c96991dcdf3dba6b4deb195a660ba9d4ecaebc/src/Particle.js#L2810-L2814 "Source code on GitHub")
|
|
2534
2514
|
|
|
2535
2515
|
**Parameters**
|
|
2536
2516
|
|
|
@@ -2539,7 +2519,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2539
2519
|
- `args.method` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The method used to request the URI, should be in uppercase.
|
|
2540
2520
|
- `args.headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
|
|
2541
2521
|
- `args.data` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Arbitrary data to send as the body.
|
|
2542
|
-
- `args.auth` **
|
|
2522
|
+
- `args.auth` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Authorization
|
|
2543
2523
|
- `args.query` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Query parameters
|
|
2544
2524
|
- `args.form` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Form fields
|
|
2545
2525
|
- `args.files` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Array of file names and file content
|