particle-api-js 11.0.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 +3 -0
- package/dist/particle.min.js +1 -1
- package/dist/particle.min.js.map +1 -1
- package/docs/api.md +149 -133
- package/package.json +1 -1
- package/src/Particle.js +16 -0
- package/test/Particle.spec.js +11 -0
package/docs/api.md
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
- [createUser](#createuser)
|
|
15
15
|
- [verifyUser](#verifyuser)
|
|
16
16
|
- [resetPassword](#resetpassword)
|
|
17
|
+
- [deleteAccessToken](#deleteaccesstoken)
|
|
17
18
|
- [deleteCurrentAccessToken](#deletecurrentaccesstoken)
|
|
18
19
|
- [deleteActiveAccessTokens](#deleteactiveaccesstokens)
|
|
19
20
|
- [deleteUser](#deleteuser)
|
|
@@ -138,7 +139,7 @@
|
|
|
138
139
|
|
|
139
140
|
## Particle
|
|
140
141
|
|
|
141
|
-
[src/Particle.js:19-
|
|
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")
|
|
142
143
|
|
|
143
144
|
Particle Cloud API wrapper.
|
|
144
145
|
|
|
@@ -154,7 +155,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
154
155
|
|
|
155
156
|
### constructor
|
|
156
157
|
|
|
157
|
-
[src/Particle.js:32-41](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
158
159
|
|
|
159
160
|
Contructor for the Cloud API wrapper.
|
|
160
161
|
|
|
@@ -171,7 +172,7 @@ Create a new Particle object and call methods below on it.
|
|
|
171
172
|
|
|
172
173
|
### login
|
|
173
174
|
|
|
174
|
-
[src/Particle.js:78-95](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
175
176
|
|
|
176
177
|
Login to Particle Cloud using an existing Particle acccount.
|
|
177
178
|
|
|
@@ -188,7 +189,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
188
189
|
|
|
189
190
|
### sendOtp
|
|
190
191
|
|
|
191
|
-
[src/Particle.js:106-122](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
192
193
|
|
|
193
194
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
194
195
|
|
|
@@ -204,7 +205,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
204
205
|
|
|
205
206
|
### enableMfa
|
|
206
207
|
|
|
207
|
-
[src/Particle.js:132-134](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
208
209
|
|
|
209
210
|
Enable MFA on the currently logged in user
|
|
210
211
|
|
|
@@ -219,7 +220,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
219
220
|
|
|
220
221
|
### confirmMfa
|
|
221
222
|
|
|
222
|
-
[src/Particle.js:147-161](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
223
224
|
|
|
224
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.
|
|
225
226
|
|
|
@@ -237,7 +238,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
237
238
|
|
|
238
239
|
### disableMfa
|
|
239
240
|
|
|
240
|
-
[src/Particle.js:172-180](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
241
242
|
|
|
242
243
|
Disable MFA for the user.
|
|
243
244
|
|
|
@@ -253,7 +254,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
253
254
|
|
|
254
255
|
### createCustomer
|
|
255
256
|
|
|
256
|
-
[src/Particle.js:192-208](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
257
258
|
|
|
258
259
|
Create Customer for Product.
|
|
259
260
|
|
|
@@ -270,7 +271,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
270
271
|
|
|
271
272
|
### loginAsClientOwner
|
|
272
273
|
|
|
273
|
-
[src/Particle.js:217-231](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
274
275
|
|
|
275
276
|
Login to Particle Cloud using an OAuth client.
|
|
276
277
|
|
|
@@ -284,7 +285,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
284
285
|
|
|
285
286
|
### createUser
|
|
286
287
|
|
|
287
|
-
[src/Particle.js:244-256](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
288
289
|
|
|
289
290
|
Create a user account for the Particle Cloud
|
|
290
291
|
|
|
@@ -302,7 +303,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
302
303
|
|
|
303
304
|
### verifyUser
|
|
304
305
|
|
|
305
|
-
[src/Particle.js:266-273](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
306
307
|
|
|
307
308
|
Verify new user account via verification email
|
|
308
309
|
|
|
@@ -317,7 +318,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
317
318
|
|
|
318
319
|
### resetPassword
|
|
319
320
|
|
|
320
|
-
[src/Particle.js:283-290](https://github.com/particle-iot/particle-api-js/blob/
|
|
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")
|
|
321
322
|
|
|
322
323
|
Send reset password email for a Particle Cloud user account
|
|
323
324
|
|
|
@@ -330,9 +331,24 @@ Send reset password email for a Particle Cloud user account
|
|
|
330
331
|
|
|
331
332
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
332
333
|
|
|
334
|
+
### deleteAccessToken
|
|
335
|
+
|
|
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")
|
|
337
|
+
|
|
338
|
+
Revoke an access token
|
|
339
|
+
|
|
340
|
+
**Parameters**
|
|
341
|
+
|
|
342
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options for this API call
|
|
343
|
+
- `options.token` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Access token you wish to revoke
|
|
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.
|
|
345
|
+
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
346
|
+
|
|
347
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
348
|
+
|
|
333
349
|
### deleteCurrentAccessToken
|
|
334
350
|
|
|
335
|
-
[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")
|
|
336
352
|
|
|
337
353
|
Revoke the current session access token
|
|
338
354
|
|
|
@@ -347,7 +363,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
347
363
|
|
|
348
364
|
### deleteActiveAccessTokens
|
|
349
365
|
|
|
350
|
-
[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")
|
|
351
367
|
|
|
352
368
|
Revoke all active access tokens
|
|
353
369
|
|
|
@@ -362,7 +378,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
362
378
|
|
|
363
379
|
### deleteUser
|
|
364
380
|
|
|
365
|
-
[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")
|
|
366
382
|
|
|
367
383
|
Delete the current user
|
|
368
384
|
|
|
@@ -378,7 +394,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
378
394
|
|
|
379
395
|
### trackingIdentity
|
|
380
396
|
|
|
381
|
-
[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")
|
|
382
398
|
|
|
383
399
|
Retrieves the information that is used to identify the current login for tracking.
|
|
384
400
|
|
|
@@ -395,7 +411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
395
411
|
|
|
396
412
|
### listDevices
|
|
397
413
|
|
|
398
|
-
[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")
|
|
399
415
|
|
|
400
416
|
List devices claimed to the account or product
|
|
401
417
|
|
|
@@ -418,7 +434,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
418
434
|
|
|
419
435
|
### getDevice
|
|
420
436
|
|
|
421
|
-
[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")
|
|
422
438
|
|
|
423
439
|
Get detailed informationa about a device
|
|
424
440
|
|
|
@@ -435,7 +451,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
435
451
|
|
|
436
452
|
### claimDevice
|
|
437
453
|
|
|
438
|
-
[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")
|
|
439
455
|
|
|
440
456
|
Claim a device to the account. The device must be online and unclaimed.
|
|
441
457
|
|
|
@@ -452,7 +468,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
452
468
|
|
|
453
469
|
### addDeviceToProduct
|
|
454
470
|
|
|
455
|
-
[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")
|
|
456
472
|
|
|
457
473
|
Add a device to a product or move device out of quarantine.
|
|
458
474
|
|
|
@@ -471,7 +487,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
471
487
|
|
|
472
488
|
### removeDevice
|
|
473
489
|
|
|
474
|
-
[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")
|
|
475
491
|
|
|
476
492
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
477
493
|
|
|
@@ -489,7 +505,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
489
505
|
|
|
490
506
|
### removeDeviceOwner
|
|
491
507
|
|
|
492
|
-
[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")
|
|
493
509
|
|
|
494
510
|
Unclaim a product device its the owner, but keep it in the product
|
|
495
511
|
|
|
@@ -506,7 +522,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
506
522
|
|
|
507
523
|
### renameDevice
|
|
508
524
|
|
|
509
|
-
[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")
|
|
510
526
|
|
|
511
527
|
Rename a device
|
|
512
528
|
|
|
@@ -524,7 +540,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
524
540
|
|
|
525
541
|
### signalDevice
|
|
526
542
|
|
|
527
|
-
[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")
|
|
528
544
|
|
|
529
545
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
530
546
|
|
|
@@ -542,7 +558,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
542
558
|
|
|
543
559
|
### setDeviceNotes
|
|
544
560
|
|
|
545
|
-
[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")
|
|
546
562
|
|
|
547
563
|
Store some notes about device
|
|
548
564
|
|
|
@@ -560,7 +576,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
560
576
|
|
|
561
577
|
### markAsDevelopmentDevice
|
|
562
578
|
|
|
563
|
-
[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")
|
|
564
580
|
|
|
565
581
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
566
582
|
|
|
@@ -578,7 +594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
578
594
|
|
|
579
595
|
### lockDeviceProductFirmware
|
|
580
596
|
|
|
581
|
-
[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")
|
|
582
598
|
|
|
583
599
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
584
600
|
|
|
@@ -597,7 +613,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
597
613
|
|
|
598
614
|
### unlockDeviceProductFirmware
|
|
599
615
|
|
|
600
|
-
[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")
|
|
601
617
|
|
|
602
618
|
Mark device as receiving automatic firmware updates
|
|
603
619
|
|
|
@@ -614,7 +630,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
614
630
|
|
|
615
631
|
### updateDevice
|
|
616
632
|
|
|
617
|
-
[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")
|
|
618
634
|
|
|
619
635
|
Update multiple device attributes at the same time
|
|
620
636
|
|
|
@@ -638,7 +654,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
638
654
|
|
|
639
655
|
### unprotectDevice
|
|
640
656
|
|
|
641
|
-
[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")
|
|
642
658
|
|
|
643
659
|
Disable device protection.
|
|
644
660
|
|
|
@@ -662,7 +678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
662
678
|
|
|
663
679
|
### provisionDevice
|
|
664
680
|
|
|
665
|
-
[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")
|
|
666
682
|
|
|
667
683
|
Provision a new device for products that allow self-provisioning
|
|
668
684
|
|
|
@@ -678,7 +694,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
678
694
|
|
|
679
695
|
### getClaimCode
|
|
680
696
|
|
|
681
|
-
[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")
|
|
682
698
|
|
|
683
699
|
Generate a claim code to use in the device claiming process.
|
|
684
700
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -697,7 +713,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
697
713
|
|
|
698
714
|
### getVariable
|
|
699
715
|
|
|
700
|
-
[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")
|
|
701
717
|
|
|
702
718
|
Get the value of a device variable
|
|
703
719
|
|
|
@@ -715,7 +731,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
715
731
|
|
|
716
732
|
### flashDevice
|
|
717
733
|
|
|
718
|
-
[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")
|
|
719
735
|
|
|
720
736
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
721
737
|
|
|
@@ -734,7 +750,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
734
750
|
|
|
735
751
|
### flashTinker
|
|
736
752
|
|
|
737
|
-
[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")
|
|
738
754
|
|
|
739
755
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
740
756
|
|
|
@@ -750,7 +766,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
750
766
|
|
|
751
767
|
### compileCode
|
|
752
768
|
|
|
753
|
-
[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")
|
|
754
770
|
|
|
755
771
|
Compile firmware using the Particle Cloud
|
|
756
772
|
|
|
@@ -768,7 +784,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
768
784
|
|
|
769
785
|
### downloadFirmwareBinary
|
|
770
786
|
|
|
771
|
-
[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")
|
|
772
788
|
|
|
773
789
|
Download a firmware binary
|
|
774
790
|
|
|
@@ -784,7 +800,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
784
800
|
|
|
785
801
|
### sendPublicKey
|
|
786
802
|
|
|
787
|
-
[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")
|
|
788
804
|
|
|
789
805
|
Send a new device public key to the Particle Cloud
|
|
790
806
|
|
|
@@ -802,7 +818,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
802
818
|
|
|
803
819
|
### callFunction
|
|
804
820
|
|
|
805
|
-
[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")
|
|
806
822
|
|
|
807
823
|
Call a device function
|
|
808
824
|
|
|
@@ -821,7 +837,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
821
837
|
|
|
822
838
|
### getEventStream
|
|
823
839
|
|
|
824
|
-
[src/Particle.js:
|
|
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")
|
|
825
841
|
|
|
826
842
|
Get a stream of events
|
|
827
843
|
|
|
@@ -839,7 +855,7 @@ emit 'event' events.
|
|
|
839
855
|
|
|
840
856
|
### publishEvent
|
|
841
857
|
|
|
842
|
-
[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")
|
|
843
859
|
|
|
844
860
|
Publish a event to the Particle Cloud
|
|
845
861
|
|
|
@@ -858,7 +874,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
858
874
|
|
|
859
875
|
### Hook
|
|
860
876
|
|
|
861
|
-
[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")
|
|
862
878
|
|
|
863
879
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
864
880
|
|
|
@@ -891,7 +907,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
891
907
|
|
|
892
908
|
### createWebhook
|
|
893
909
|
|
|
894
|
-
[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")
|
|
895
911
|
|
|
896
912
|
Create a webhook
|
|
897
913
|
|
|
@@ -913,7 +929,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
913
929
|
|
|
914
930
|
### deleteWebhook
|
|
915
931
|
|
|
916
|
-
[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")
|
|
917
933
|
|
|
918
934
|
Delete a webhook
|
|
919
935
|
|
|
@@ -930,7 +946,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
930
946
|
|
|
931
947
|
### listWebhooks
|
|
932
948
|
|
|
933
|
-
[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")
|
|
934
950
|
|
|
935
951
|
List all webhooks owned by the account or product
|
|
936
952
|
|
|
@@ -946,7 +962,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
946
962
|
|
|
947
963
|
### createIntegration
|
|
948
964
|
|
|
949
|
-
[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")
|
|
950
966
|
|
|
951
967
|
Create an integration to send events to an external service
|
|
952
968
|
|
|
@@ -967,7 +983,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
967
983
|
|
|
968
984
|
### editIntegration
|
|
969
985
|
|
|
970
|
-
[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")
|
|
971
987
|
|
|
972
988
|
Edit an integration to send events to an external service
|
|
973
989
|
|
|
@@ -989,7 +1005,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
989
1005
|
|
|
990
1006
|
### deleteIntegration
|
|
991
1007
|
|
|
992
|
-
[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")
|
|
993
1009
|
|
|
994
1010
|
Delete an integration to send events to an external service
|
|
995
1011
|
|
|
@@ -1006,7 +1022,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1006
1022
|
|
|
1007
1023
|
### listIntegrations
|
|
1008
1024
|
|
|
1009
|
-
[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")
|
|
1010
1026
|
|
|
1011
1027
|
List all integrations owned by the account or product
|
|
1012
1028
|
|
|
@@ -1022,7 +1038,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1022
1038
|
|
|
1023
1039
|
### getUserInfo
|
|
1024
1040
|
|
|
1025
|
-
[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")
|
|
1026
1042
|
|
|
1027
1043
|
Get details about the current user
|
|
1028
1044
|
|
|
@@ -1037,7 +1053,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1037
1053
|
|
|
1038
1054
|
### setUserInfo
|
|
1039
1055
|
|
|
1040
|
-
[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")
|
|
1041
1057
|
|
|
1042
1058
|
Set details on the current user
|
|
1043
1059
|
|
|
@@ -1053,7 +1069,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1053
1069
|
|
|
1054
1070
|
### changeUsername
|
|
1055
1071
|
|
|
1056
|
-
[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")
|
|
1057
1073
|
|
|
1058
1074
|
Change username (i.e, email)
|
|
1059
1075
|
|
|
@@ -1071,7 +1087,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1071
1087
|
|
|
1072
1088
|
### changeUserPassword
|
|
1073
1089
|
|
|
1074
|
-
[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")
|
|
1075
1091
|
|
|
1076
1092
|
Change user's password
|
|
1077
1093
|
|
|
@@ -1089,7 +1105,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1089
1105
|
|
|
1090
1106
|
### listSIMs
|
|
1091
1107
|
|
|
1092
|
-
[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")
|
|
1093
1109
|
|
|
1094
1110
|
List SIM cards owned by a user or product
|
|
1095
1111
|
|
|
@@ -1110,7 +1126,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1110
1126
|
|
|
1111
1127
|
### getSIMDataUsage
|
|
1112
1128
|
|
|
1113
|
-
[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")
|
|
1114
1130
|
|
|
1115
1131
|
Get data usage for one SIM card for the current billing period
|
|
1116
1132
|
|
|
@@ -1127,7 +1143,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1127
1143
|
|
|
1128
1144
|
### getFleetDataUsage
|
|
1129
1145
|
|
|
1130
|
-
[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")
|
|
1131
1147
|
|
|
1132
1148
|
Get data usage for all SIM cards in a product the current billing period
|
|
1133
1149
|
|
|
@@ -1143,7 +1159,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1143
1159
|
|
|
1144
1160
|
### checkSIM
|
|
1145
1161
|
|
|
1146
|
-
[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")
|
|
1147
1163
|
|
|
1148
1164
|
Check SIM status
|
|
1149
1165
|
|
|
@@ -1159,7 +1175,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1159
1175
|
|
|
1160
1176
|
### activateSIM
|
|
1161
1177
|
|
|
1162
|
-
[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")
|
|
1163
1179
|
|
|
1164
1180
|
Activate and add SIM cards to an account or product
|
|
1165
1181
|
|
|
@@ -1179,7 +1195,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1179
1195
|
|
|
1180
1196
|
### deactivateSIM
|
|
1181
1197
|
|
|
1182
|
-
[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")
|
|
1183
1199
|
|
|
1184
1200
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1185
1201
|
|
|
@@ -1196,7 +1212,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1196
1212
|
|
|
1197
1213
|
### reactivateSIM
|
|
1198
1214
|
|
|
1199
|
-
[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")
|
|
1200
1216
|
|
|
1201
1217
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1202
1218
|
|
|
@@ -1214,7 +1230,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1214
1230
|
|
|
1215
1231
|
### updateSIM
|
|
1216
1232
|
|
|
1217
|
-
[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")
|
|
1218
1234
|
|
|
1219
1235
|
Update SIM card data limit
|
|
1220
1236
|
|
|
@@ -1232,7 +1248,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1232
1248
|
|
|
1233
1249
|
### removeSIM
|
|
1234
1250
|
|
|
1235
|
-
[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")
|
|
1236
1252
|
|
|
1237
1253
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1238
1254
|
|
|
@@ -1249,7 +1265,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1249
1265
|
|
|
1250
1266
|
### listBuildTargets
|
|
1251
1267
|
|
|
1252
|
-
[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")
|
|
1253
1269
|
|
|
1254
1270
|
List valid build targets to be used for compiling
|
|
1255
1271
|
|
|
@@ -1265,7 +1281,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1265
1281
|
|
|
1266
1282
|
### listLibraries
|
|
1267
1283
|
|
|
1268
|
-
[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")
|
|
1269
1285
|
|
|
1270
1286
|
List firmware libraries
|
|
1271
1287
|
|
|
@@ -1295,7 +1311,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1295
1311
|
|
|
1296
1312
|
### getLibrary
|
|
1297
1313
|
|
|
1298
|
-
[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")
|
|
1299
1315
|
|
|
1300
1316
|
Get firmware library details
|
|
1301
1317
|
|
|
@@ -1312,7 +1328,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1312
1328
|
|
|
1313
1329
|
### getLibraryVersions
|
|
1314
1330
|
|
|
1315
|
-
[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")
|
|
1316
1332
|
|
|
1317
1333
|
Firmware library details for each version
|
|
1318
1334
|
|
|
@@ -1330,7 +1346,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1330
1346
|
|
|
1331
1347
|
### contributeLibrary
|
|
1332
1348
|
|
|
1333
|
-
[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")
|
|
1334
1350
|
|
|
1335
1351
|
Contribute a new library version from a compressed archive
|
|
1336
1352
|
|
|
@@ -1347,7 +1363,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1347
1363
|
|
|
1348
1364
|
### publishLibrary
|
|
1349
1365
|
|
|
1350
|
-
[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")
|
|
1351
1367
|
|
|
1352
1368
|
Publish the latest version of a library to the public
|
|
1353
1369
|
|
|
@@ -1363,7 +1379,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1363
1379
|
|
|
1364
1380
|
### deleteLibrary
|
|
1365
1381
|
|
|
1366
|
-
[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")
|
|
1367
1383
|
|
|
1368
1384
|
Delete one version of a library or an entire private library
|
|
1369
1385
|
|
|
@@ -1380,7 +1396,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1380
1396
|
|
|
1381
1397
|
### downloadFile
|
|
1382
1398
|
|
|
1383
|
-
[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")
|
|
1384
1400
|
|
|
1385
1401
|
Download an external file that may not be on the API
|
|
1386
1402
|
|
|
@@ -1395,7 +1411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1395
1411
|
|
|
1396
1412
|
### listOAuthClients
|
|
1397
1413
|
|
|
1398
|
-
[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")
|
|
1399
1415
|
|
|
1400
1416
|
List OAuth client created by the account
|
|
1401
1417
|
|
|
@@ -1411,7 +1427,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1411
1427
|
|
|
1412
1428
|
### createOAuthClient
|
|
1413
1429
|
|
|
1414
|
-
[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")
|
|
1415
1431
|
|
|
1416
1432
|
Create an OAuth client
|
|
1417
1433
|
|
|
@@ -1431,7 +1447,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1431
1447
|
|
|
1432
1448
|
### updateOAuthClient
|
|
1433
1449
|
|
|
1434
|
-
[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")
|
|
1435
1451
|
|
|
1436
1452
|
Update an OAuth client
|
|
1437
1453
|
|
|
@@ -1450,7 +1466,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1450
1466
|
|
|
1451
1467
|
### deleteOAuthClient
|
|
1452
1468
|
|
|
1453
|
-
[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")
|
|
1454
1470
|
|
|
1455
1471
|
Delete an OAuth client
|
|
1456
1472
|
|
|
@@ -1467,7 +1483,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1467
1483
|
|
|
1468
1484
|
### listProducts
|
|
1469
1485
|
|
|
1470
|
-
[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")
|
|
1471
1487
|
|
|
1472
1488
|
List products the account has access to
|
|
1473
1489
|
|
|
@@ -1482,7 +1498,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1482
1498
|
|
|
1483
1499
|
### getProduct
|
|
1484
1500
|
|
|
1485
|
-
[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")
|
|
1486
1502
|
|
|
1487
1503
|
Get detailed information about a product
|
|
1488
1504
|
|
|
@@ -1498,7 +1514,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1498
1514
|
|
|
1499
1515
|
### listProductFirmware
|
|
1500
1516
|
|
|
1501
|
-
[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")
|
|
1502
1518
|
|
|
1503
1519
|
List product firmware versions
|
|
1504
1520
|
|
|
@@ -1514,7 +1530,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1514
1530
|
|
|
1515
1531
|
### uploadProductFirmware
|
|
1516
1532
|
|
|
1517
|
-
[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")
|
|
1518
1534
|
|
|
1519
1535
|
List product firmware versions
|
|
1520
1536
|
|
|
@@ -1535,7 +1551,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1535
1551
|
|
|
1536
1552
|
### getProductFirmware
|
|
1537
1553
|
|
|
1538
|
-
[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")
|
|
1539
1555
|
|
|
1540
1556
|
Get information about a product firmware version
|
|
1541
1557
|
|
|
@@ -1552,7 +1568,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1552
1568
|
|
|
1553
1569
|
### updateProductFirmware
|
|
1554
1570
|
|
|
1555
|
-
[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")
|
|
1556
1572
|
|
|
1557
1573
|
Update information for a product firmware version
|
|
1558
1574
|
|
|
@@ -1571,7 +1587,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1571
1587
|
|
|
1572
1588
|
### downloadProductFirmware
|
|
1573
1589
|
|
|
1574
|
-
[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")
|
|
1575
1591
|
|
|
1576
1592
|
Download a product firmware binary
|
|
1577
1593
|
|
|
@@ -1588,7 +1604,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1588
1604
|
|
|
1589
1605
|
### releaseProductFirmware
|
|
1590
1606
|
|
|
1591
|
-
[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")
|
|
1592
1608
|
|
|
1593
1609
|
Release a product firmware version as the default version
|
|
1594
1610
|
|
|
@@ -1605,7 +1621,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1605
1621
|
|
|
1606
1622
|
### listTeamMembers
|
|
1607
1623
|
|
|
1608
|
-
[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")
|
|
1609
1625
|
|
|
1610
1626
|
List product team members
|
|
1611
1627
|
|
|
@@ -1621,7 +1637,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1621
1637
|
|
|
1622
1638
|
### inviteTeamMember
|
|
1623
1639
|
|
|
1624
|
-
[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")
|
|
1625
1641
|
|
|
1626
1642
|
Invite Particle user to a product team
|
|
1627
1643
|
|
|
@@ -1638,7 +1654,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1638
1654
|
|
|
1639
1655
|
### removeTeamMember
|
|
1640
1656
|
|
|
1641
|
-
[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")
|
|
1642
1658
|
|
|
1643
1659
|
Remove Particle user to a product team
|
|
1644
1660
|
|
|
@@ -1655,7 +1671,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1655
1671
|
|
|
1656
1672
|
### lookupSerialNumber
|
|
1657
1673
|
|
|
1658
|
-
[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")
|
|
1659
1675
|
|
|
1660
1676
|
Fetch details about a serial number
|
|
1661
1677
|
|
|
@@ -1671,7 +1687,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1671
1687
|
|
|
1672
1688
|
### createMeshNetwork
|
|
1673
1689
|
|
|
1674
|
-
[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")
|
|
1675
1691
|
|
|
1676
1692
|
Create a mesh network
|
|
1677
1693
|
|
|
@@ -1689,7 +1705,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1689
1705
|
|
|
1690
1706
|
### removeMeshNetwork
|
|
1691
1707
|
|
|
1692
|
-
[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")
|
|
1693
1709
|
|
|
1694
1710
|
Remove a mesh network.
|
|
1695
1711
|
|
|
@@ -1705,7 +1721,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1705
1721
|
|
|
1706
1722
|
### listMeshNetworks
|
|
1707
1723
|
|
|
1708
|
-
[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")
|
|
1709
1725
|
|
|
1710
1726
|
List all mesh networks
|
|
1711
1727
|
|
|
@@ -1722,7 +1738,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1722
1738
|
|
|
1723
1739
|
### getMeshNetwork
|
|
1724
1740
|
|
|
1725
|
-
[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")
|
|
1726
1742
|
|
|
1727
1743
|
Get information about a mesh network.
|
|
1728
1744
|
|
|
@@ -1738,7 +1754,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1738
1754
|
|
|
1739
1755
|
### updateMeshNetwork
|
|
1740
1756
|
|
|
1741
|
-
[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")
|
|
1742
1758
|
|
|
1743
1759
|
Modify a mesh network.
|
|
1744
1760
|
|
|
@@ -1756,7 +1772,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1756
1772
|
|
|
1757
1773
|
### addMeshNetworkDevice
|
|
1758
1774
|
|
|
1759
|
-
[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")
|
|
1760
1776
|
|
|
1761
1777
|
Add a device to a mesh network.
|
|
1762
1778
|
|
|
@@ -1773,7 +1789,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1773
1789
|
|
|
1774
1790
|
### removeMeshNetworkDevice
|
|
1775
1791
|
|
|
1776
|
-
[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")
|
|
1777
1793
|
|
|
1778
1794
|
Remove a device from a mesh network.
|
|
1779
1795
|
|
|
@@ -1790,7 +1806,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1790
1806
|
|
|
1791
1807
|
### listMeshNetworkDevices
|
|
1792
1808
|
|
|
1793
|
-
[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")
|
|
1794
1810
|
|
|
1795
1811
|
List all devices of a mesh network.
|
|
1796
1812
|
|
|
@@ -1809,7 +1825,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1809
1825
|
|
|
1810
1826
|
### getProductConfiguration
|
|
1811
1827
|
|
|
1812
|
-
[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")
|
|
1813
1829
|
|
|
1814
1830
|
Get product configuration
|
|
1815
1831
|
|
|
@@ -1825,7 +1841,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1825
1841
|
|
|
1826
1842
|
### getProductConfigurationSchema
|
|
1827
1843
|
|
|
1828
|
-
[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")
|
|
1829
1845
|
|
|
1830
1846
|
Get product configuration schema
|
|
1831
1847
|
|
|
@@ -1841,7 +1857,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1841
1857
|
|
|
1842
1858
|
### getProductDeviceConfiguration
|
|
1843
1859
|
|
|
1844
|
-
[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")
|
|
1845
1861
|
|
|
1846
1862
|
Get product device's configuration
|
|
1847
1863
|
|
|
@@ -1858,7 +1874,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1858
1874
|
|
|
1859
1875
|
### getProductDeviceConfigurationSchema
|
|
1860
1876
|
|
|
1861
|
-
[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")
|
|
1862
1878
|
|
|
1863
1879
|
Get product device's configuration schema
|
|
1864
1880
|
|
|
@@ -1875,7 +1891,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1875
1891
|
|
|
1876
1892
|
### setProductConfiguration
|
|
1877
1893
|
|
|
1878
|
-
[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")
|
|
1879
1895
|
|
|
1880
1896
|
Set product configuration
|
|
1881
1897
|
|
|
@@ -1892,7 +1908,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1892
1908
|
|
|
1893
1909
|
### setProductDeviceConfiguration
|
|
1894
1910
|
|
|
1895
|
-
[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")
|
|
1896
1912
|
|
|
1897
1913
|
Set product configuration for a specific device within the product
|
|
1898
1914
|
|
|
@@ -1910,7 +1926,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1910
1926
|
|
|
1911
1927
|
### getProductLocations
|
|
1912
1928
|
|
|
1913
|
-
[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")
|
|
1914
1930
|
|
|
1915
1931
|
Query location for devices within a product
|
|
1916
1932
|
|
|
@@ -1934,7 +1950,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1934
1950
|
|
|
1935
1951
|
### getProductDeviceLocations
|
|
1936
1952
|
|
|
1937
|
-
[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")
|
|
1938
1954
|
|
|
1939
1955
|
Query location for one device within a product
|
|
1940
1956
|
|
|
@@ -1954,7 +1970,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1954
1970
|
|
|
1955
1971
|
### executeLogic
|
|
1956
1972
|
|
|
1957
|
-
[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")
|
|
1958
1974
|
|
|
1959
1975
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
1960
1976
|
|
|
@@ -1973,7 +1989,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1973
1989
|
|
|
1974
1990
|
### createLogicFunction
|
|
1975
1991
|
|
|
1976
|
-
[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")
|
|
1977
1993
|
|
|
1978
1994
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
1979
1995
|
|
|
@@ -1996,7 +2012,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1996
2012
|
|
|
1997
2013
|
### getLogicFunction
|
|
1998
2014
|
|
|
1999
|
-
[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")
|
|
2000
2016
|
|
|
2001
2017
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2002
2018
|
|
|
@@ -2013,7 +2029,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2013
2029
|
|
|
2014
2030
|
### updateLogicFunction
|
|
2015
2031
|
|
|
2016
|
-
[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")
|
|
2017
2033
|
|
|
2018
2034
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2019
2035
|
|
|
@@ -2033,7 +2049,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2033
2049
|
|
|
2034
2050
|
### deleteLogicFunction
|
|
2035
2051
|
|
|
2036
|
-
[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")
|
|
2037
2053
|
|
|
2038
2054
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2039
2055
|
|
|
@@ -2050,7 +2066,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2050
2066
|
|
|
2051
2067
|
### listLogicFunctions
|
|
2052
2068
|
|
|
2053
|
-
[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")
|
|
2054
2070
|
|
|
2055
2071
|
Lists all logic functions in the specified organization or sandbox.
|
|
2056
2072
|
|
|
@@ -2067,7 +2083,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2067
2083
|
|
|
2068
2084
|
### listLogicRuns
|
|
2069
2085
|
|
|
2070
|
-
[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")
|
|
2071
2087
|
|
|
2072
2088
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2073
2089
|
|
|
@@ -2084,7 +2100,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2084
2100
|
|
|
2085
2101
|
### getLogicRun
|
|
2086
2102
|
|
|
2087
|
-
[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")
|
|
2088
2104
|
|
|
2089
2105
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2090
2106
|
|
|
@@ -2102,7 +2118,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2102
2118
|
|
|
2103
2119
|
### getLogicRunLogs
|
|
2104
2120
|
|
|
2105
|
-
[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")
|
|
2106
2122
|
|
|
2107
2123
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2108
2124
|
|
|
@@ -2120,7 +2136,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2120
2136
|
|
|
2121
2137
|
### createLedger
|
|
2122
2138
|
|
|
2123
|
-
[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")
|
|
2124
2140
|
|
|
2125
2141
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
2126
2142
|
|
|
@@ -2137,7 +2153,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2137
2153
|
|
|
2138
2154
|
### getLedger
|
|
2139
2155
|
|
|
2140
|
-
[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")
|
|
2141
2157
|
|
|
2142
2158
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2143
2159
|
|
|
@@ -2154,7 +2170,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2154
2170
|
|
|
2155
2171
|
### updateLedger
|
|
2156
2172
|
|
|
2157
|
-
[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")
|
|
2158
2174
|
|
|
2159
2175
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2160
2176
|
|
|
@@ -2172,7 +2188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2172
2188
|
|
|
2173
2189
|
### archiveLedger
|
|
2174
2190
|
|
|
2175
|
-
[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")
|
|
2176
2192
|
|
|
2177
2193
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2178
2194
|
|
|
@@ -2189,7 +2205,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2189
2205
|
|
|
2190
2206
|
### Scope
|
|
2191
2207
|
|
|
2192
|
-
[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")
|
|
2193
2209
|
|
|
2194
2210
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
2195
2211
|
|
|
@@ -2207,7 +2223,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
2207
2223
|
|
|
2208
2224
|
### listLedgers
|
|
2209
2225
|
|
|
2210
|
-
[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")
|
|
2211
2227
|
|
|
2212
2228
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
2213
2229
|
|
|
@@ -2227,7 +2243,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2227
2243
|
|
|
2228
2244
|
### getLedgerInstance
|
|
2229
2245
|
|
|
2230
|
-
[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")
|
|
2231
2247
|
|
|
2232
2248
|
Get ledger instance data.
|
|
2233
2249
|
|
|
@@ -2245,7 +2261,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2245
2261
|
|
|
2246
2262
|
### SetMode
|
|
2247
2263
|
|
|
2248
|
-
[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")
|
|
2249
2265
|
|
|
2250
2266
|
Type: (`"Replace"` \| `"Merge"`)
|
|
2251
2267
|
|
|
@@ -2263,7 +2279,7 @@ Type: (`"Replace"` \| `"Merge"`)
|
|
|
2263
2279
|
|
|
2264
2280
|
### setLedgerInstance
|
|
2265
2281
|
|
|
2266
|
-
[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")
|
|
2267
2283
|
|
|
2268
2284
|
Set ledger instance data.
|
|
2269
2285
|
|
|
@@ -2283,7 +2299,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2283
2299
|
|
|
2284
2300
|
### deleteLedgerInstance
|
|
2285
2301
|
|
|
2286
|
-
[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")
|
|
2287
2303
|
|
|
2288
2304
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2289
2305
|
|
|
@@ -2301,7 +2317,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2301
2317
|
|
|
2302
2318
|
### listLedgerInstances
|
|
2303
2319
|
|
|
2304
|
-
[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")
|
|
2305
2321
|
|
|
2306
2322
|
Lists ledger instances in the specified organization or sandbox.
|
|
2307
2323
|
|
|
@@ -2320,7 +2336,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2320
2336
|
|
|
2321
2337
|
### listLedgerInstanceVersions
|
|
2322
2338
|
|
|
2323
|
-
[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")
|
|
2324
2340
|
|
|
2325
2341
|
List ledger instance versions
|
|
2326
2342
|
|
|
@@ -2340,7 +2356,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2340
2356
|
|
|
2341
2357
|
### getLedgerInstanceVersion
|
|
2342
2358
|
|
|
2343
|
-
[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")
|
|
2344
2360
|
|
|
2345
2361
|
Get specific ledger instance version
|
|
2346
2362
|
|
|
@@ -2359,7 +2375,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2359
2375
|
|
|
2360
2376
|
### listDeviceOsVersions
|
|
2361
2377
|
|
|
2362
|
-
[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")
|
|
2363
2379
|
|
|
2364
2380
|
List Device OS versions
|
|
2365
2381
|
|
|
@@ -2378,7 +2394,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2378
2394
|
|
|
2379
2395
|
### getDeviceOsVersion
|
|
2380
2396
|
|
|
2381
|
-
[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")
|
|
2382
2398
|
|
|
2383
2399
|
Get a specific Device OS version
|
|
2384
2400
|
|
|
@@ -2395,7 +2411,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2395
2411
|
|
|
2396
2412
|
### setDefaultAuth
|
|
2397
2413
|
|
|
2398
|
-
[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")
|
|
2399
2415
|
|
|
2400
2416
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2401
2417
|
|
|
@@ -2408,7 +2424,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
2408
2424
|
|
|
2409
2425
|
### get
|
|
2410
2426
|
|
|
2411
|
-
[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")
|
|
2412
2428
|
|
|
2413
2429
|
Make a GET request
|
|
2414
2430
|
|
|
@@ -2425,7 +2441,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2425
2441
|
|
|
2426
2442
|
### head
|
|
2427
2443
|
|
|
2428
|
-
[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")
|
|
2429
2445
|
|
|
2430
2446
|
Make a HEAD request
|
|
2431
2447
|
|
|
@@ -2442,7 +2458,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2442
2458
|
|
|
2443
2459
|
### post
|
|
2444
2460
|
|
|
2445
|
-
[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")
|
|
2446
2462
|
|
|
2447
2463
|
Make a POST request
|
|
2448
2464
|
|
|
@@ -2459,7 +2475,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2459
2475
|
|
|
2460
2476
|
### put
|
|
2461
2477
|
|
|
2462
|
-
[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")
|
|
2463
2479
|
|
|
2464
2480
|
Make a PUT request
|
|
2465
2481
|
|
|
@@ -2477,7 +2493,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2477
2493
|
|
|
2478
2494
|
### delete
|
|
2479
2495
|
|
|
2480
|
-
[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")
|
|
2481
2497
|
|
|
2482
2498
|
Make a DELETE request
|
|
2483
2499
|
|
|
@@ -2494,7 +2510,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2494
2510
|
|
|
2495
2511
|
### request
|
|
2496
2512
|
|
|
2497
|
-
[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")
|
|
2498
2514
|
|
|
2499
2515
|
**Parameters**
|
|
2500
2516
|
|