particle-api-js 10.5.0 → 10.5.1
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 +133 -133
- package/package.json +1 -1
- package/src/Agent.js +4 -2
package/docs/api.md
CHANGED
|
@@ -138,7 +138,7 @@
|
|
|
138
138
|
|
|
139
139
|
## Particle
|
|
140
140
|
|
|
141
|
-
[src/Particle.js:20-2799](https://github.com/particle-iot/particle-api-js/blob/
|
|
141
|
+
[src/Particle.js:20-2799](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L20-L2799 "Source code on GitHub")
|
|
142
142
|
|
|
143
143
|
Particle Cloud API wrapper.
|
|
144
144
|
|
|
@@ -154,7 +154,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
154
154
|
|
|
155
155
|
### constructor
|
|
156
156
|
|
|
157
|
-
[src/Particle.js:33-42](https://github.com/particle-iot/particle-api-js/blob/
|
|
157
|
+
[src/Particle.js:33-42](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L33-L42 "Source code on GitHub")
|
|
158
158
|
|
|
159
159
|
Contructor for the Cloud API wrapper.
|
|
160
160
|
|
|
@@ -171,7 +171,7 @@ Create a new Particle object and call methods below on it.
|
|
|
171
171
|
|
|
172
172
|
### login
|
|
173
173
|
|
|
174
|
-
[src/Particle.js:79-96](https://github.com/particle-iot/particle-api-js/blob/
|
|
174
|
+
[src/Particle.js:79-96](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L79-L96 "Source code on GitHub")
|
|
175
175
|
|
|
176
176
|
Login to Particle Cloud using an existing Particle acccount.
|
|
177
177
|
|
|
@@ -188,7 +188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
188
188
|
|
|
189
189
|
### sendOtp
|
|
190
190
|
|
|
191
|
-
[src/Particle.js:107-123](https://github.com/particle-iot/particle-api-js/blob/
|
|
191
|
+
[src/Particle.js:107-123](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L107-L123 "Source code on GitHub")
|
|
192
192
|
|
|
193
193
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
194
194
|
|
|
@@ -204,7 +204,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
204
204
|
|
|
205
205
|
### enableMfa
|
|
206
206
|
|
|
207
|
-
[src/Particle.js:133-135](https://github.com/particle-iot/particle-api-js/blob/
|
|
207
|
+
[src/Particle.js:133-135](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L133-L135 "Source code on GitHub")
|
|
208
208
|
|
|
209
209
|
Enable MFA on the currently logged in user
|
|
210
210
|
|
|
@@ -219,7 +219,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
219
219
|
|
|
220
220
|
### confirmMfa
|
|
221
221
|
|
|
222
|
-
[src/Particle.js:148-162](https://github.com/particle-iot/particle-api-js/blob/
|
|
222
|
+
[src/Particle.js:148-162](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L148-L162 "Source code on GitHub")
|
|
223
223
|
|
|
224
224
|
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
225
|
|
|
@@ -237,7 +237,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
237
237
|
|
|
238
238
|
### disableMfa
|
|
239
239
|
|
|
240
|
-
[src/Particle.js:173-181](https://github.com/particle-iot/particle-api-js/blob/
|
|
240
|
+
[src/Particle.js:173-181](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L173-L181 "Source code on GitHub")
|
|
241
241
|
|
|
242
242
|
Disable MFA for the user.
|
|
243
243
|
|
|
@@ -253,7 +253,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
253
253
|
|
|
254
254
|
### createCustomer
|
|
255
255
|
|
|
256
|
-
[src/Particle.js:193-209](https://github.com/particle-iot/particle-api-js/blob/
|
|
256
|
+
[src/Particle.js:193-209](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L193-L209 "Source code on GitHub")
|
|
257
257
|
|
|
258
258
|
Create Customer for Product.
|
|
259
259
|
|
|
@@ -270,7 +270,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
270
270
|
|
|
271
271
|
### loginAsClientOwner
|
|
272
272
|
|
|
273
|
-
[src/Particle.js:218-232](https://github.com/particle-iot/particle-api-js/blob/
|
|
273
|
+
[src/Particle.js:218-232](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L218-L232 "Source code on GitHub")
|
|
274
274
|
|
|
275
275
|
Login to Particle Cloud using an OAuth client.
|
|
276
276
|
|
|
@@ -284,7 +284,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
284
284
|
|
|
285
285
|
### createUser
|
|
286
286
|
|
|
287
|
-
[src/Particle.js:245-257](https://github.com/particle-iot/particle-api-js/blob/
|
|
287
|
+
[src/Particle.js:245-257](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L245-L257 "Source code on GitHub")
|
|
288
288
|
|
|
289
289
|
Create a user account for the Particle Cloud
|
|
290
290
|
|
|
@@ -302,7 +302,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
302
302
|
|
|
303
303
|
### verifyUser
|
|
304
304
|
|
|
305
|
-
[src/Particle.js:267-274](https://github.com/particle-iot/particle-api-js/blob/
|
|
305
|
+
[src/Particle.js:267-274](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L267-L274 "Source code on GitHub")
|
|
306
306
|
|
|
307
307
|
Verify new user account via verification email
|
|
308
308
|
|
|
@@ -317,7 +317,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
317
317
|
|
|
318
318
|
### resetPassword
|
|
319
319
|
|
|
320
|
-
[src/Particle.js:284-291](https://github.com/particle-iot/particle-api-js/blob/
|
|
320
|
+
[src/Particle.js:284-291](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L284-L291 "Source code on GitHub")
|
|
321
321
|
|
|
322
322
|
Send reset password email for a Particle Cloud user account
|
|
323
323
|
|
|
@@ -332,7 +332,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
332
332
|
|
|
333
333
|
### deleteAccessToken
|
|
334
334
|
|
|
335
|
-
[src/Particle.js:303-311](https://github.com/particle-iot/particle-api-js/blob/
|
|
335
|
+
[src/Particle.js:303-311](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L303-L311 "Source code on GitHub")
|
|
336
336
|
|
|
337
337
|
Revoke an access token
|
|
338
338
|
|
|
@@ -349,7 +349,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
349
349
|
|
|
350
350
|
### deleteCurrentAccessToken
|
|
351
351
|
|
|
352
|
-
[src/Particle.js:321-328](https://github.com/particle-iot/particle-api-js/blob/
|
|
352
|
+
[src/Particle.js:321-328](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L321-L328 "Source code on GitHub")
|
|
353
353
|
|
|
354
354
|
Revoke the current session access token
|
|
355
355
|
|
|
@@ -364,7 +364,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
364
364
|
|
|
365
365
|
### deleteActiveAccessTokens
|
|
366
366
|
|
|
367
|
-
[src/Particle.js:338-345](https://github.com/particle-iot/particle-api-js/blob/
|
|
367
|
+
[src/Particle.js:338-345](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L338-L345 "Source code on GitHub")
|
|
368
368
|
|
|
369
369
|
Revoke all active access tokens
|
|
370
370
|
|
|
@@ -379,7 +379,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
379
379
|
|
|
380
380
|
### deleteUser
|
|
381
381
|
|
|
382
|
-
[src/Particle.js:356-364](https://github.com/particle-iot/particle-api-js/blob/
|
|
382
|
+
[src/Particle.js:356-364](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L356-L364 "Source code on GitHub")
|
|
383
383
|
|
|
384
384
|
Delete the current user
|
|
385
385
|
|
|
@@ -395,7 +395,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
395
395
|
|
|
396
396
|
### listAccessTokens
|
|
397
397
|
|
|
398
|
-
[src/Particle.js:376-384](https://github.com/particle-iot/particle-api-js/blob/
|
|
398
|
+
[src/Particle.js:376-384](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L376-L384 "Source code on GitHub")
|
|
399
399
|
|
|
400
400
|
List all valid access tokens for a Particle Cloud account
|
|
401
401
|
|
|
@@ -412,7 +412,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
412
412
|
|
|
413
413
|
### trackingIdentity
|
|
414
414
|
|
|
415
|
-
[src/Particle.js:396-404](https://github.com/particle-iot/particle-api-js/blob/
|
|
415
|
+
[src/Particle.js:396-404](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L396-L404 "Source code on GitHub")
|
|
416
416
|
|
|
417
417
|
Retrieves the information that is used to identify the current login for tracking.
|
|
418
418
|
|
|
@@ -429,7 +429,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
429
429
|
|
|
430
430
|
### listDevices
|
|
431
431
|
|
|
432
|
-
[src/Particle.js:422-441](https://github.com/particle-iot/particle-api-js/blob/
|
|
432
|
+
[src/Particle.js:422-441](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L422-L441 "Source code on GitHub")
|
|
433
433
|
|
|
434
434
|
List devices claimed to the account or product
|
|
435
435
|
|
|
@@ -452,7 +452,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
452
452
|
|
|
453
453
|
### getDevice
|
|
454
454
|
|
|
455
|
-
[src/Particle.js:453-456](https://github.com/particle-iot/particle-api-js/blob/
|
|
455
|
+
[src/Particle.js:453-456](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L453-L456 "Source code on GitHub")
|
|
456
456
|
|
|
457
457
|
Get detailed informationa about a device
|
|
458
458
|
|
|
@@ -469,7 +469,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
469
469
|
|
|
470
470
|
### claimDevice
|
|
471
471
|
|
|
472
|
-
[src/Particle.js:468-479](https://github.com/particle-iot/particle-api-js/blob/
|
|
472
|
+
[src/Particle.js:468-479](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L468-L479 "Source code on GitHub")
|
|
473
473
|
|
|
474
474
|
Claim a device to the account. The device must be online and unclaimed.
|
|
475
475
|
|
|
@@ -486,7 +486,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
486
486
|
|
|
487
487
|
### addDeviceToProduct
|
|
488
488
|
|
|
489
|
-
[src/Particle.js:493-511](https://github.com/particle-iot/particle-api-js/blob/
|
|
489
|
+
[src/Particle.js:493-511](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L493-L511 "Source code on GitHub")
|
|
490
490
|
|
|
491
491
|
Add a device to a product or move device out of quarantine.
|
|
492
492
|
|
|
@@ -505,7 +505,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
505
505
|
|
|
506
506
|
### removeDevice
|
|
507
507
|
|
|
508
|
-
[src/Particle.js:524-528](https://github.com/particle-iot/particle-api-js/blob/
|
|
508
|
+
[src/Particle.js:524-528](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L524-L528 "Source code on GitHub")
|
|
509
509
|
|
|
510
510
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
511
511
|
|
|
@@ -523,7 +523,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
523
523
|
|
|
524
524
|
### removeDeviceOwner
|
|
525
525
|
|
|
526
|
-
[src/Particle.js:540-543](https://github.com/particle-iot/particle-api-js/blob/
|
|
526
|
+
[src/Particle.js:540-543](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L540-L543 "Source code on GitHub")
|
|
527
527
|
|
|
528
528
|
Unclaim a product device its the owner, but keep it in the product
|
|
529
529
|
|
|
@@ -540,7 +540,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
540
540
|
|
|
541
541
|
### renameDevice
|
|
542
542
|
|
|
543
|
-
[src/Particle.js:556-558](https://github.com/particle-iot/particle-api-js/blob/
|
|
543
|
+
[src/Particle.js:556-558](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L556-L558 "Source code on GitHub")
|
|
544
544
|
|
|
545
545
|
Rename a device
|
|
546
546
|
|
|
@@ -558,7 +558,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
558
558
|
|
|
559
559
|
### signalDevice
|
|
560
560
|
|
|
561
|
-
[src/Particle.js:571-573](https://github.com/particle-iot/particle-api-js/blob/
|
|
561
|
+
[src/Particle.js:571-573](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L571-L573 "Source code on GitHub")
|
|
562
562
|
|
|
563
563
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
564
564
|
|
|
@@ -576,7 +576,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
576
576
|
|
|
577
577
|
### setDeviceNotes
|
|
578
578
|
|
|
579
|
-
[src/Particle.js:586-588](https://github.com/particle-iot/particle-api-js/blob/
|
|
579
|
+
[src/Particle.js:586-588](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L586-L588 "Source code on GitHub")
|
|
580
580
|
|
|
581
581
|
Store some notes about device
|
|
582
582
|
|
|
@@ -594,7 +594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
594
594
|
|
|
595
595
|
### markAsDevelopmentDevice
|
|
596
596
|
|
|
597
|
-
[src/Particle.js:601-603](https://github.com/particle-iot/particle-api-js/blob/
|
|
597
|
+
[src/Particle.js:601-603](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L601-L603 "Source code on GitHub")
|
|
598
598
|
|
|
599
599
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
600
600
|
|
|
@@ -612,7 +612,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
612
612
|
|
|
613
613
|
### lockDeviceProductFirmware
|
|
614
614
|
|
|
615
|
-
[src/Particle.js:617-619](https://github.com/particle-iot/particle-api-js/blob/
|
|
615
|
+
[src/Particle.js:617-619](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L617-L619 "Source code on GitHub")
|
|
616
616
|
|
|
617
617
|
Mark device as being used in development of a product, so it opts out of automatic firmware updates
|
|
618
618
|
|
|
@@ -631,7 +631,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
631
631
|
|
|
632
632
|
### unlockDeviceProductFirmware
|
|
633
633
|
|
|
634
|
-
[src/Particle.js:631-633](https://github.com/particle-iot/particle-api-js/blob/
|
|
634
|
+
[src/Particle.js:631-633](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L631-L633 "Source code on GitHub")
|
|
635
635
|
|
|
636
636
|
Mark device as receiving automatic firmware updates
|
|
637
637
|
|
|
@@ -648,7 +648,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
648
648
|
|
|
649
649
|
### updateDevice
|
|
650
650
|
|
|
651
|
-
[src/Particle.js:652-664](https://github.com/particle-iot/particle-api-js/blob/
|
|
651
|
+
[src/Particle.js:652-664](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L652-L664 "Source code on GitHub")
|
|
652
652
|
|
|
653
653
|
Update multiple device attributes at the same time
|
|
654
654
|
|
|
@@ -672,7 +672,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
672
672
|
|
|
673
673
|
### unprotectDevice
|
|
674
674
|
|
|
675
|
-
[src/Particle.js:684-700](https://github.com/particle-iot/particle-api-js/blob/
|
|
675
|
+
[src/Particle.js:684-700](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L684-L700 "Source code on GitHub")
|
|
676
676
|
|
|
677
677
|
Disable device protection.
|
|
678
678
|
|
|
@@ -696,7 +696,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
696
696
|
|
|
697
697
|
### provisionDevice
|
|
698
698
|
|
|
699
|
-
[src/Particle.js:711-719](https://github.com/particle-iot/particle-api-js/blob/
|
|
699
|
+
[src/Particle.js:711-719](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L711-L719 "Source code on GitHub")
|
|
700
700
|
|
|
701
701
|
Provision a new device for products that allow self-provisioning
|
|
702
702
|
|
|
@@ -712,7 +712,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
712
712
|
|
|
713
713
|
### getClaimCode
|
|
714
714
|
|
|
715
|
-
[src/Particle.js:733-736](https://github.com/particle-iot/particle-api-js/blob/
|
|
715
|
+
[src/Particle.js:733-736](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L733-L736 "Source code on GitHub")
|
|
716
716
|
|
|
717
717
|
Generate a claim code to use in the device claiming process.
|
|
718
718
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -731,7 +731,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
731
731
|
|
|
732
732
|
### getVariable
|
|
733
733
|
|
|
734
|
-
[src/Particle.js:758-764](https://github.com/particle-iot/particle-api-js/blob/
|
|
734
|
+
[src/Particle.js:758-764](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L758-L764 "Source code on GitHub")
|
|
735
735
|
|
|
736
736
|
Get the value of a device variable
|
|
737
737
|
|
|
@@ -749,7 +749,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
749
749
|
|
|
750
750
|
### flashDevice
|
|
751
751
|
|
|
752
|
-
[src/Particle.js:778-789](https://github.com/particle-iot/particle-api-js/blob/
|
|
752
|
+
[src/Particle.js:778-789](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L778-L789 "Source code on GitHub")
|
|
753
753
|
|
|
754
754
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
755
755
|
|
|
@@ -768,7 +768,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
768
768
|
|
|
769
769
|
### flashTinker
|
|
770
770
|
|
|
771
|
-
[src/Particle.js:800-815](https://github.com/particle-iot/particle-api-js/blob/
|
|
771
|
+
[src/Particle.js:800-815](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L800-L815 "Source code on GitHub")
|
|
772
772
|
|
|
773
773
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
774
774
|
|
|
@@ -784,7 +784,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
784
784
|
|
|
785
785
|
### compileCode
|
|
786
786
|
|
|
787
|
-
[src/Particle.js:828-846](https://github.com/particle-iot/particle-api-js/blob/
|
|
787
|
+
[src/Particle.js:828-846](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L828-L846 "Source code on GitHub")
|
|
788
788
|
|
|
789
789
|
Compile firmware using the Particle Cloud
|
|
790
790
|
|
|
@@ -802,7 +802,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
802
802
|
|
|
803
803
|
### downloadFirmwareBinary
|
|
804
804
|
|
|
805
|
-
[src/Particle.js:857-866](https://github.com/particle-iot/particle-api-js/blob/
|
|
805
|
+
[src/Particle.js:857-866](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L857-L866 "Source code on GitHub")
|
|
806
806
|
|
|
807
807
|
Download a firmware binary
|
|
808
808
|
|
|
@@ -818,7 +818,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
818
818
|
|
|
819
819
|
### sendPublicKey
|
|
820
820
|
|
|
821
|
-
[src/Particle.js:879-893](https://github.com/particle-iot/particle-api-js/blob/
|
|
821
|
+
[src/Particle.js:879-893](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L879-L893 "Source code on GitHub")
|
|
822
822
|
|
|
823
823
|
Send a new device public key to the Particle Cloud
|
|
824
824
|
|
|
@@ -836,7 +836,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
836
836
|
|
|
837
837
|
### callFunction
|
|
838
838
|
|
|
839
|
-
[src/Particle.js:907-912](https://github.com/particle-iot/particle-api-js/blob/
|
|
839
|
+
[src/Particle.js:907-912](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L907-L912 "Source code on GitHub")
|
|
840
840
|
|
|
841
841
|
Call a device function
|
|
842
842
|
|
|
@@ -855,7 +855,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
855
855
|
|
|
856
856
|
### getEventStream
|
|
857
857
|
|
|
858
|
-
[src/Particle.js:925-950](https://github.com/particle-iot/particle-api-js/blob/
|
|
858
|
+
[src/Particle.js:925-950](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L925-L950 "Source code on GitHub")
|
|
859
859
|
|
|
860
860
|
Get a stream of events
|
|
861
861
|
|
|
@@ -873,7 +873,7 @@ emit 'event' events.
|
|
|
873
873
|
|
|
874
874
|
### publishEvent
|
|
875
875
|
|
|
876
|
-
[src/Particle.js:964-968](https://github.com/particle-iot/particle-api-js/blob/
|
|
876
|
+
[src/Particle.js:964-968](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L964-L968 "Source code on GitHub")
|
|
877
877
|
|
|
878
878
|
Publish a event to the Particle Cloud
|
|
879
879
|
|
|
@@ -892,7 +892,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
892
892
|
|
|
893
893
|
### Hook
|
|
894
894
|
|
|
895
|
-
[src/Particle.js:999-1021](https://github.com/particle-iot/particle-api-js/blob/
|
|
895
|
+
[src/Particle.js:999-1021](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L999-L1021 "Source code on GitHub")
|
|
896
896
|
|
|
897
897
|
Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
898
898
|
|
|
@@ -925,7 +925,7 @@ Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
|
|
|
925
925
|
|
|
926
926
|
### createWebhook
|
|
927
927
|
|
|
928
|
-
[src/Particle.js:999-1021](https://github.com/particle-iot/particle-api-js/blob/
|
|
928
|
+
[src/Particle.js:999-1021](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L999-L1021 "Source code on GitHub")
|
|
929
929
|
|
|
930
930
|
Create a webhook
|
|
931
931
|
|
|
@@ -947,7 +947,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
947
947
|
|
|
948
948
|
### deleteWebhook
|
|
949
949
|
|
|
950
|
-
[src/Particle.js:1033-1036](https://github.com/particle-iot/particle-api-js/blob/
|
|
950
|
+
[src/Particle.js:1033-1036](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1033-L1036 "Source code on GitHub")
|
|
951
951
|
|
|
952
952
|
Delete a webhook
|
|
953
953
|
|
|
@@ -964,7 +964,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
964
964
|
|
|
965
965
|
### listWebhooks
|
|
966
966
|
|
|
967
|
-
[src/Particle.js:1047-1050](https://github.com/particle-iot/particle-api-js/blob/
|
|
967
|
+
[src/Particle.js:1047-1050](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1047-L1050 "Source code on GitHub")
|
|
968
968
|
|
|
969
969
|
List all webhooks owned by the account or product
|
|
970
970
|
|
|
@@ -980,7 +980,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
980
980
|
|
|
981
981
|
### createIntegration
|
|
982
982
|
|
|
983
|
-
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/
|
|
983
|
+
[src/Particle.js:1067-1071](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1067-L1071 "Source code on GitHub")
|
|
984
984
|
|
|
985
985
|
Create an integration to send events to an external service
|
|
986
986
|
|
|
@@ -1001,7 +1001,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1001
1001
|
|
|
1002
1002
|
### editIntegration
|
|
1003
1003
|
|
|
1004
|
-
[src/Particle.js:1089-1093](https://github.com/particle-iot/particle-api-js/blob/
|
|
1004
|
+
[src/Particle.js:1089-1093](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1089-L1093 "Source code on GitHub")
|
|
1005
1005
|
|
|
1006
1006
|
Edit an integration to send events to an external service
|
|
1007
1007
|
|
|
@@ -1023,7 +1023,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1023
1023
|
|
|
1024
1024
|
### deleteIntegration
|
|
1025
1025
|
|
|
1026
|
-
[src/Particle.js:1106-1109](https://github.com/particle-iot/particle-api-js/blob/
|
|
1026
|
+
[src/Particle.js:1106-1109](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1106-L1109 "Source code on GitHub")
|
|
1027
1027
|
|
|
1028
1028
|
Delete an integration to send events to an external service
|
|
1029
1029
|
|
|
@@ -1040,7 +1040,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1040
1040
|
|
|
1041
1041
|
### listIntegrations
|
|
1042
1042
|
|
|
1043
|
-
[src/Particle.js:1120-1123](https://github.com/particle-iot/particle-api-js/blob/
|
|
1043
|
+
[src/Particle.js:1120-1123](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1120-L1123 "Source code on GitHub")
|
|
1044
1044
|
|
|
1045
1045
|
List all integrations owned by the account or product
|
|
1046
1046
|
|
|
@@ -1056,7 +1056,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1056
1056
|
|
|
1057
1057
|
### getUserInfo
|
|
1058
1058
|
|
|
1059
|
-
[src/Particle.js:1133-1135](https://github.com/particle-iot/particle-api-js/blob/
|
|
1059
|
+
[src/Particle.js:1133-1135](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1133-L1135 "Source code on GitHub")
|
|
1060
1060
|
|
|
1061
1061
|
Get details about the current user
|
|
1062
1062
|
|
|
@@ -1071,7 +1071,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1071
1071
|
|
|
1072
1072
|
### setUserInfo
|
|
1073
1073
|
|
|
1074
|
-
[src/Particle.js:1146-1149](https://github.com/particle-iot/particle-api-js/blob/
|
|
1074
|
+
[src/Particle.js:1146-1149](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1146-L1149 "Source code on GitHub")
|
|
1075
1075
|
|
|
1076
1076
|
Set details on the current user
|
|
1077
1077
|
|
|
@@ -1087,7 +1087,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1087
1087
|
|
|
1088
1088
|
### changeUsername
|
|
1089
1089
|
|
|
1090
|
-
[src/Particle.js:1162-1170](https://github.com/particle-iot/particle-api-js/blob/
|
|
1090
|
+
[src/Particle.js:1162-1170](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1162-L1170 "Source code on GitHub")
|
|
1091
1091
|
|
|
1092
1092
|
Change username (i.e, email)
|
|
1093
1093
|
|
|
@@ -1105,7 +1105,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1105
1105
|
|
|
1106
1106
|
### changeUserPassword
|
|
1107
1107
|
|
|
1108
|
-
[src/Particle.js:1183-1191](https://github.com/particle-iot/particle-api-js/blob/
|
|
1108
|
+
[src/Particle.js:1183-1191](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1183-L1191 "Source code on GitHub")
|
|
1109
1109
|
|
|
1110
1110
|
Change user's password
|
|
1111
1111
|
|
|
@@ -1123,7 +1123,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1123
1123
|
|
|
1124
1124
|
### listSIMs
|
|
1125
1125
|
|
|
1126
|
-
[src/Particle.js:1207-1211](https://github.com/particle-iot/particle-api-js/blob/
|
|
1126
|
+
[src/Particle.js:1207-1211](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1207-L1211 "Source code on GitHub")
|
|
1127
1127
|
|
|
1128
1128
|
List SIM cards owned by a user or product
|
|
1129
1129
|
|
|
@@ -1144,7 +1144,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1144
1144
|
|
|
1145
1145
|
### getSIMDataUsage
|
|
1146
1146
|
|
|
1147
|
-
[src/Particle.js:1223-1229](https://github.com/particle-iot/particle-api-js/blob/
|
|
1147
|
+
[src/Particle.js:1223-1229](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1223-L1229 "Source code on GitHub")
|
|
1148
1148
|
|
|
1149
1149
|
Get data usage for one SIM card for the current billing period
|
|
1150
1150
|
|
|
@@ -1161,7 +1161,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1161
1161
|
|
|
1162
1162
|
### getFleetDataUsage
|
|
1163
1163
|
|
|
1164
|
-
[src/Particle.js:1240-1247](https://github.com/particle-iot/particle-api-js/blob/
|
|
1164
|
+
[src/Particle.js:1240-1247](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1240-L1247 "Source code on GitHub")
|
|
1165
1165
|
|
|
1166
1166
|
Get data usage for all SIM cards in a product the current billing period
|
|
1167
1167
|
|
|
@@ -1177,7 +1177,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1177
1177
|
|
|
1178
1178
|
### checkSIM
|
|
1179
1179
|
|
|
1180
|
-
[src/Particle.js:1258-1260](https://github.com/particle-iot/particle-api-js/blob/
|
|
1180
|
+
[src/Particle.js:1258-1260](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1258-L1260 "Source code on GitHub")
|
|
1181
1181
|
|
|
1182
1182
|
Check SIM status
|
|
1183
1183
|
|
|
@@ -1193,7 +1193,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1193
1193
|
|
|
1194
1194
|
### activateSIM
|
|
1195
1195
|
|
|
1196
|
-
[src/Particle.js:1275-1285](https://github.com/particle-iot/particle-api-js/blob/
|
|
1196
|
+
[src/Particle.js:1275-1285](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1275-L1285 "Source code on GitHub")
|
|
1197
1197
|
|
|
1198
1198
|
Activate and add SIM cards to an account or product
|
|
1199
1199
|
|
|
@@ -1213,7 +1213,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1213
1213
|
|
|
1214
1214
|
### deactivateSIM
|
|
1215
1215
|
|
|
1216
|
-
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/
|
|
1216
|
+
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1297-L1301 "Source code on GitHub")
|
|
1217
1217
|
|
|
1218
1218
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1219
1219
|
|
|
@@ -1230,7 +1230,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1230
1230
|
|
|
1231
1231
|
### reactivateSIM
|
|
1232
1232
|
|
|
1233
|
-
[src/Particle.js:1314-1318](https://github.com/particle-iot/particle-api-js/blob/
|
|
1233
|
+
[src/Particle.js:1314-1318](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1314-L1318 "Source code on GitHub")
|
|
1234
1234
|
|
|
1235
1235
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1236
1236
|
|
|
@@ -1248,7 +1248,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1248
1248
|
|
|
1249
1249
|
### updateSIM
|
|
1250
1250
|
|
|
1251
|
-
[src/Particle.js:1331-1335](https://github.com/particle-iot/particle-api-js/blob/
|
|
1251
|
+
[src/Particle.js:1331-1335](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1331-L1335 "Source code on GitHub")
|
|
1252
1252
|
|
|
1253
1253
|
Update SIM card data limit
|
|
1254
1254
|
|
|
@@ -1266,7 +1266,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1266
1266
|
|
|
1267
1267
|
### removeSIM
|
|
1268
1268
|
|
|
1269
|
-
[src/Particle.js:1347-1350](https://github.com/particle-iot/particle-api-js/blob/
|
|
1269
|
+
[src/Particle.js:1347-1350](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1347-L1350 "Source code on GitHub")
|
|
1270
1270
|
|
|
1271
1271
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1272
1272
|
|
|
@@ -1283,7 +1283,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1283
1283
|
|
|
1284
1284
|
### listBuildTargets
|
|
1285
1285
|
|
|
1286
|
-
[src/Particle.js:1361-1364](https://github.com/particle-iot/particle-api-js/blob/
|
|
1286
|
+
[src/Particle.js:1361-1364](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1361-L1364 "Source code on GitHub")
|
|
1287
1287
|
|
|
1288
1288
|
List valid build targets to be used for compiling
|
|
1289
1289
|
|
|
@@ -1299,7 +1299,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1299
1299
|
|
|
1300
1300
|
### listLibraries
|
|
1301
1301
|
|
|
1302
|
-
[src/Particle.js:1390-1407](https://github.com/particle-iot/particle-api-js/blob/
|
|
1302
|
+
[src/Particle.js:1390-1407](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1390-L1407 "Source code on GitHub")
|
|
1303
1303
|
|
|
1304
1304
|
List firmware libraries
|
|
1305
1305
|
|
|
@@ -1329,7 +1329,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1329
1329
|
|
|
1330
1330
|
### getLibrary
|
|
1331
1331
|
|
|
1332
|
-
[src/Particle.js:1423-1431](https://github.com/particle-iot/particle-api-js/blob/
|
|
1332
|
+
[src/Particle.js:1423-1431](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1423-L1431 "Source code on GitHub")
|
|
1333
1333
|
|
|
1334
1334
|
Get firmware library details
|
|
1335
1335
|
|
|
@@ -1346,7 +1346,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1346
1346
|
|
|
1347
1347
|
### getLibraryVersions
|
|
1348
1348
|
|
|
1349
|
-
[src/Particle.js:1444-1452](https://github.com/particle-iot/particle-api-js/blob/
|
|
1349
|
+
[src/Particle.js:1444-1452](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1444-L1452 "Source code on GitHub")
|
|
1350
1350
|
|
|
1351
1351
|
Firmware library details for each version
|
|
1352
1352
|
|
|
@@ -1364,7 +1364,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1364
1364
|
|
|
1365
1365
|
### contributeLibrary
|
|
1366
1366
|
|
|
1367
|
-
[src/Particle.js:1464-1477](https://github.com/particle-iot/particle-api-js/blob/
|
|
1367
|
+
[src/Particle.js:1464-1477](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1464-L1477 "Source code on GitHub")
|
|
1368
1368
|
|
|
1369
1369
|
Contribute a new library version from a compressed archive
|
|
1370
1370
|
|
|
@@ -1381,7 +1381,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1381
1381
|
|
|
1382
1382
|
### publishLibrary
|
|
1383
1383
|
|
|
1384
|
-
[src/Particle.js:1488-1497](https://github.com/particle-iot/particle-api-js/blob/
|
|
1384
|
+
[src/Particle.js:1488-1497](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1488-L1497 "Source code on GitHub")
|
|
1385
1385
|
|
|
1386
1386
|
Publish the latest version of a library to the public
|
|
1387
1387
|
|
|
@@ -1397,7 +1397,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1397
1397
|
|
|
1398
1398
|
### deleteLibrary
|
|
1399
1399
|
|
|
1400
|
-
[src/Particle.js:1509-1517](https://github.com/particle-iot/particle-api-js/blob/
|
|
1400
|
+
[src/Particle.js:1509-1517](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1509-L1517 "Source code on GitHub")
|
|
1401
1401
|
|
|
1402
1402
|
Delete one version of a library or an entire private library
|
|
1403
1403
|
|
|
@@ -1414,7 +1414,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1414
1414
|
|
|
1415
1415
|
### downloadFile
|
|
1416
1416
|
|
|
1417
|
-
[src/Particle.js:1527-1529](https://github.com/particle-iot/particle-api-js/blob/
|
|
1417
|
+
[src/Particle.js:1527-1529](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1527-L1529 "Source code on GitHub")
|
|
1418
1418
|
|
|
1419
1419
|
Download an external file that may not be on the API
|
|
1420
1420
|
|
|
@@ -1429,7 +1429,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1429
1429
|
|
|
1430
1430
|
### listOAuthClients
|
|
1431
1431
|
|
|
1432
|
-
[src/Particle.js:1540-1543](https://github.com/particle-iot/particle-api-js/blob/
|
|
1432
|
+
[src/Particle.js:1540-1543](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1540-L1543 "Source code on GitHub")
|
|
1433
1433
|
|
|
1434
1434
|
List OAuth client created by the account
|
|
1435
1435
|
|
|
@@ -1445,7 +1445,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1445
1445
|
|
|
1446
1446
|
### createOAuthClient
|
|
1447
1447
|
|
|
1448
|
-
[src/Particle.js:1558-1562](https://github.com/particle-iot/particle-api-js/blob/
|
|
1448
|
+
[src/Particle.js:1558-1562](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1558-L1562 "Source code on GitHub")
|
|
1449
1449
|
|
|
1450
1450
|
Create an OAuth client
|
|
1451
1451
|
|
|
@@ -1465,7 +1465,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1465
1465
|
|
|
1466
1466
|
### updateOAuthClient
|
|
1467
1467
|
|
|
1468
|
-
[src/Particle.js:1576-1580](https://github.com/particle-iot/particle-api-js/blob/
|
|
1468
|
+
[src/Particle.js:1576-1580](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1576-L1580 "Source code on GitHub")
|
|
1469
1469
|
|
|
1470
1470
|
Update an OAuth client
|
|
1471
1471
|
|
|
@@ -1484,7 +1484,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1484
1484
|
|
|
1485
1485
|
### deleteOAuthClient
|
|
1486
1486
|
|
|
1487
|
-
[src/Particle.js:1592-1595](https://github.com/particle-iot/particle-api-js/blob/
|
|
1487
|
+
[src/Particle.js:1592-1595](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1592-L1595 "Source code on GitHub")
|
|
1488
1488
|
|
|
1489
1489
|
Delete an OAuth client
|
|
1490
1490
|
|
|
@@ -1501,7 +1501,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1501
1501
|
|
|
1502
1502
|
### listProducts
|
|
1503
1503
|
|
|
1504
|
-
[src/Particle.js:1605-1607](https://github.com/particle-iot/particle-api-js/blob/
|
|
1504
|
+
[src/Particle.js:1605-1607](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1605-L1607 "Source code on GitHub")
|
|
1505
1505
|
|
|
1506
1506
|
List products the account has access to
|
|
1507
1507
|
|
|
@@ -1516,7 +1516,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1516
1516
|
|
|
1517
1517
|
### getProduct
|
|
1518
1518
|
|
|
1519
|
-
[src/Particle.js:1618-1620](https://github.com/particle-iot/particle-api-js/blob/
|
|
1519
|
+
[src/Particle.js:1618-1620](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1618-L1620 "Source code on GitHub")
|
|
1520
1520
|
|
|
1521
1521
|
Get detailed information about a product
|
|
1522
1522
|
|
|
@@ -1532,7 +1532,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1532
1532
|
|
|
1533
1533
|
### listProductFirmware
|
|
1534
1534
|
|
|
1535
|
-
[src/Particle.js:1631-1633](https://github.com/particle-iot/particle-api-js/blob/
|
|
1535
|
+
[src/Particle.js:1631-1633](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1631-L1633 "Source code on GitHub")
|
|
1536
1536
|
|
|
1537
1537
|
List product firmware versions
|
|
1538
1538
|
|
|
@@ -1548,7 +1548,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1548
1548
|
|
|
1549
1549
|
### uploadProductFirmware
|
|
1550
1550
|
|
|
1551
|
-
[src/Particle.js:1649-1665](https://github.com/particle-iot/particle-api-js/blob/
|
|
1551
|
+
[src/Particle.js:1649-1665](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1649-L1665 "Source code on GitHub")
|
|
1552
1552
|
|
|
1553
1553
|
List product firmware versions
|
|
1554
1554
|
|
|
@@ -1569,7 +1569,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1569
1569
|
|
|
1570
1570
|
### getProductFirmware
|
|
1571
1571
|
|
|
1572
|
-
[src/Particle.js:1677-1684](https://github.com/particle-iot/particle-api-js/blob/
|
|
1572
|
+
[src/Particle.js:1677-1684](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1677-L1684 "Source code on GitHub")
|
|
1573
1573
|
|
|
1574
1574
|
Get information about a product firmware version
|
|
1575
1575
|
|
|
@@ -1586,7 +1586,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1586
1586
|
|
|
1587
1587
|
### updateProductFirmware
|
|
1588
1588
|
|
|
1589
|
-
[src/Particle.js:1698-1701](https://github.com/particle-iot/particle-api-js/blob/
|
|
1589
|
+
[src/Particle.js:1698-1701](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1698-L1701 "Source code on GitHub")
|
|
1590
1590
|
|
|
1591
1591
|
Update information for a product firmware version
|
|
1592
1592
|
|
|
@@ -1605,7 +1605,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1605
1605
|
|
|
1606
1606
|
### downloadProductFirmware
|
|
1607
1607
|
|
|
1608
|
-
[src/Particle.js:1713-1722](https://github.com/particle-iot/particle-api-js/blob/
|
|
1608
|
+
[src/Particle.js:1713-1722](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1713-L1722 "Source code on GitHub")
|
|
1609
1609
|
|
|
1610
1610
|
Download a product firmware binary
|
|
1611
1611
|
|
|
@@ -1622,7 +1622,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1622
1622
|
|
|
1623
1623
|
### releaseProductFirmware
|
|
1624
1624
|
|
|
1625
|
-
[src/Particle.js:1734-1737](https://github.com/particle-iot/particle-api-js/blob/
|
|
1625
|
+
[src/Particle.js:1734-1737](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1734-L1737 "Source code on GitHub")
|
|
1626
1626
|
|
|
1627
1627
|
Release a product firmware version as the default version
|
|
1628
1628
|
|
|
@@ -1639,7 +1639,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1639
1639
|
|
|
1640
1640
|
### listTeamMembers
|
|
1641
1641
|
|
|
1642
|
-
[src/Particle.js:1748-1755](https://github.com/particle-iot/particle-api-js/blob/
|
|
1642
|
+
[src/Particle.js:1748-1755](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1748-L1755 "Source code on GitHub")
|
|
1643
1643
|
|
|
1644
1644
|
List product team members
|
|
1645
1645
|
|
|
@@ -1655,7 +1655,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1655
1655
|
|
|
1656
1656
|
### inviteTeamMember
|
|
1657
1657
|
|
|
1658
|
-
[src/Particle.js:1767-1775](https://github.com/particle-iot/particle-api-js/blob/
|
|
1658
|
+
[src/Particle.js:1767-1775](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1767-L1775 "Source code on GitHub")
|
|
1659
1659
|
|
|
1660
1660
|
Invite Particle user to a product team
|
|
1661
1661
|
|
|
@@ -1672,7 +1672,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1672
1672
|
|
|
1673
1673
|
### removeTeamMember
|
|
1674
1674
|
|
|
1675
|
-
[src/Particle.js:1787-1794](https://github.com/particle-iot/particle-api-js/blob/
|
|
1675
|
+
[src/Particle.js:1787-1794](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1787-L1794 "Source code on GitHub")
|
|
1676
1676
|
|
|
1677
1677
|
Remove Particle user to a product team
|
|
1678
1678
|
|
|
@@ -1689,7 +1689,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1689
1689
|
|
|
1690
1690
|
### lookupSerialNumber
|
|
1691
1691
|
|
|
1692
|
-
[src/Particle.js:1805-1812](https://github.com/particle-iot/particle-api-js/blob/
|
|
1692
|
+
[src/Particle.js:1805-1812](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1805-L1812 "Source code on GitHub")
|
|
1693
1693
|
|
|
1694
1694
|
Fetch details about a serial number
|
|
1695
1695
|
|
|
@@ -1705,7 +1705,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1705
1705
|
|
|
1706
1706
|
### createMeshNetwork
|
|
1707
1707
|
|
|
1708
|
-
[src/Particle.js:1825-1833](https://github.com/particle-iot/particle-api-js/blob/
|
|
1708
|
+
[src/Particle.js:1825-1833](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1825-L1833 "Source code on GitHub")
|
|
1709
1709
|
|
|
1710
1710
|
Create a mesh network
|
|
1711
1711
|
|
|
@@ -1723,7 +1723,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1723
1723
|
|
|
1724
1724
|
### removeMeshNetwork
|
|
1725
1725
|
|
|
1726
|
-
[src/Particle.js:1844-1846](https://github.com/particle-iot/particle-api-js/blob/
|
|
1726
|
+
[src/Particle.js:1844-1846](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1844-L1846 "Source code on GitHub")
|
|
1727
1727
|
|
|
1728
1728
|
Remove a mesh network.
|
|
1729
1729
|
|
|
@@ -1739,7 +1739,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1739
1739
|
|
|
1740
1740
|
### listMeshNetworks
|
|
1741
1741
|
|
|
1742
|
-
[src/Particle.js:1858-1861](https://github.com/particle-iot/particle-api-js/blob/
|
|
1742
|
+
[src/Particle.js:1858-1861](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1858-L1861 "Source code on GitHub")
|
|
1743
1743
|
|
|
1744
1744
|
List all mesh networks
|
|
1745
1745
|
|
|
@@ -1756,7 +1756,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1756
1756
|
|
|
1757
1757
|
### getMeshNetwork
|
|
1758
1758
|
|
|
1759
|
-
[src/Particle.js:1872-1874](https://github.com/particle-iot/particle-api-js/blob/
|
|
1759
|
+
[src/Particle.js:1872-1874](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1872-L1874 "Source code on GitHub")
|
|
1760
1760
|
|
|
1761
1761
|
Get information about a mesh network.
|
|
1762
1762
|
|
|
@@ -1772,7 +1772,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1772
1772
|
|
|
1773
1773
|
### updateMeshNetwork
|
|
1774
1774
|
|
|
1775
|
-
[src/Particle.js:1887-1895](https://github.com/particle-iot/particle-api-js/blob/
|
|
1775
|
+
[src/Particle.js:1887-1895](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1887-L1895 "Source code on GitHub")
|
|
1776
1776
|
|
|
1777
1777
|
Modify a mesh network.
|
|
1778
1778
|
|
|
@@ -1790,7 +1790,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1790
1790
|
|
|
1791
1791
|
### addMeshNetworkDevice
|
|
1792
1792
|
|
|
1793
|
-
[src/Particle.js:1907-1916](https://github.com/particle-iot/particle-api-js/blob/
|
|
1793
|
+
[src/Particle.js:1907-1916](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1907-L1916 "Source code on GitHub")
|
|
1794
1794
|
|
|
1795
1795
|
Add a device to a mesh network.
|
|
1796
1796
|
|
|
@@ -1807,7 +1807,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1807
1807
|
|
|
1808
1808
|
### removeMeshNetworkDevice
|
|
1809
1809
|
|
|
1810
|
-
[src/Particle.js:1928-1944](https://github.com/particle-iot/particle-api-js/blob/
|
|
1810
|
+
[src/Particle.js:1928-1944](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1928-L1944 "Source code on GitHub")
|
|
1811
1811
|
|
|
1812
1812
|
Remove a device from a mesh network.
|
|
1813
1813
|
|
|
@@ -1824,7 +1824,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1824
1824
|
|
|
1825
1825
|
### listMeshNetworkDevices
|
|
1826
1826
|
|
|
1827
|
-
[src/Particle.js:1958-1967](https://github.com/particle-iot/particle-api-js/blob/
|
|
1827
|
+
[src/Particle.js:1958-1967](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1958-L1967 "Source code on GitHub")
|
|
1828
1828
|
|
|
1829
1829
|
List all devices of a mesh network.
|
|
1830
1830
|
|
|
@@ -1843,7 +1843,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1843
1843
|
|
|
1844
1844
|
### getProductConfiguration
|
|
1845
1845
|
|
|
1846
|
-
[src/Particle.js:1978-1985](https://github.com/particle-iot/particle-api-js/blob/
|
|
1846
|
+
[src/Particle.js:1978-1985](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1978-L1985 "Source code on GitHub")
|
|
1847
1847
|
|
|
1848
1848
|
Get product configuration
|
|
1849
1849
|
|
|
@@ -1859,7 +1859,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1859
1859
|
|
|
1860
1860
|
### getProductConfigurationSchema
|
|
1861
1861
|
|
|
1862
|
-
[src/Particle.js:1996-2004](https://github.com/particle-iot/particle-api-js/blob/
|
|
1862
|
+
[src/Particle.js:1996-2004](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L1996-L2004 "Source code on GitHub")
|
|
1863
1863
|
|
|
1864
1864
|
Get product configuration schema
|
|
1865
1865
|
|
|
@@ -1875,7 +1875,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1875
1875
|
|
|
1876
1876
|
### getProductDeviceConfiguration
|
|
1877
1877
|
|
|
1878
|
-
[src/Particle.js:2016-2023](https://github.com/particle-iot/particle-api-js/blob/
|
|
1878
|
+
[src/Particle.js:2016-2023](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2016-L2023 "Source code on GitHub")
|
|
1879
1879
|
|
|
1880
1880
|
Get product device's configuration
|
|
1881
1881
|
|
|
@@ -1892,7 +1892,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1892
1892
|
|
|
1893
1893
|
### getProductDeviceConfigurationSchema
|
|
1894
1894
|
|
|
1895
|
-
[src/Particle.js:2035-2043](https://github.com/particle-iot/particle-api-js/blob/
|
|
1895
|
+
[src/Particle.js:2035-2043](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2035-L2043 "Source code on GitHub")
|
|
1896
1896
|
|
|
1897
1897
|
Get product device's configuration schema
|
|
1898
1898
|
|
|
@@ -1909,7 +1909,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1909
1909
|
|
|
1910
1910
|
### setProductConfiguration
|
|
1911
1911
|
|
|
1912
|
-
[src/Particle.js:2055-2063](https://github.com/particle-iot/particle-api-js/blob/
|
|
1912
|
+
[src/Particle.js:2055-2063](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2055-L2063 "Source code on GitHub")
|
|
1913
1913
|
|
|
1914
1914
|
Set product configuration
|
|
1915
1915
|
|
|
@@ -1926,7 +1926,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1926
1926
|
|
|
1927
1927
|
### setProductDeviceConfiguration
|
|
1928
1928
|
|
|
1929
|
-
[src/Particle.js:2076-2084](https://github.com/particle-iot/particle-api-js/blob/
|
|
1929
|
+
[src/Particle.js:2076-2084](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2076-L2084 "Source code on GitHub")
|
|
1930
1930
|
|
|
1931
1931
|
Set product configuration for a specific device within the product
|
|
1932
1932
|
|
|
@@ -1944,7 +1944,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1944
1944
|
|
|
1945
1945
|
### getProductLocations
|
|
1946
1946
|
|
|
1947
|
-
[src/Particle.js:2103-2120](https://github.com/particle-iot/particle-api-js/blob/
|
|
1947
|
+
[src/Particle.js:2103-2120](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2103-L2120 "Source code on GitHub")
|
|
1948
1948
|
|
|
1949
1949
|
Query location for devices within a product
|
|
1950
1950
|
|
|
@@ -1968,7 +1968,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1968
1968
|
|
|
1969
1969
|
### getProductDeviceLocations
|
|
1970
1970
|
|
|
1971
|
-
[src/Particle.js:2137-2149](https://github.com/particle-iot/particle-api-js/blob/
|
|
1971
|
+
[src/Particle.js:2137-2149](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2137-L2149 "Source code on GitHub")
|
|
1972
1972
|
|
|
1973
1973
|
Query location for one device within a product
|
|
1974
1974
|
|
|
@@ -1988,7 +1988,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1988
1988
|
|
|
1989
1989
|
### executeLogic
|
|
1990
1990
|
|
|
1991
|
-
[src/Particle.js:2165-2173](https://github.com/particle-iot/particle-api-js/blob/
|
|
1991
|
+
[src/Particle.js:2165-2173](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2165-L2173 "Source code on GitHub")
|
|
1992
1992
|
|
|
1993
1993
|
Executes the provided logic function once and returns the result. No logs, runs, etc are saved
|
|
1994
1994
|
|
|
@@ -2007,7 +2007,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2007
2007
|
|
|
2008
2008
|
### createLogicFunction
|
|
2009
2009
|
|
|
2010
|
-
[src/Particle.js:2193-2201](https://github.com/particle-iot/particle-api-js/blob/
|
|
2010
|
+
[src/Particle.js:2193-2201](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2193-L2201 "Source code on GitHub")
|
|
2011
2011
|
|
|
2012
2012
|
Creates a new logic function in the specified organization or sandbox using the provided function data.
|
|
2013
2013
|
|
|
@@ -2030,7 +2030,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2030
2030
|
|
|
2031
2031
|
### getLogicFunction
|
|
2032
2032
|
|
|
2033
|
-
[src/Particle.js:2215-2222](https://github.com/particle-iot/particle-api-js/blob/
|
|
2033
|
+
[src/Particle.js:2215-2222](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2215-L2222 "Source code on GitHub")
|
|
2034
2034
|
|
|
2035
2035
|
Get a logic function in the specified organization or sandbox by logic function ID.
|
|
2036
2036
|
|
|
@@ -2047,7 +2047,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2047
2047
|
|
|
2048
2048
|
### updateLogicFunction
|
|
2049
2049
|
|
|
2050
|
-
[src/Particle.js:2239-2247](https://github.com/particle-iot/particle-api-js/blob/
|
|
2050
|
+
[src/Particle.js:2239-2247](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2239-L2247 "Source code on GitHub")
|
|
2051
2051
|
|
|
2052
2052
|
Updates an existing logic function in the specified organization or sandbox using the provided function data.
|
|
2053
2053
|
|
|
@@ -2067,7 +2067,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2067
2067
|
|
|
2068
2068
|
### deleteLogicFunction
|
|
2069
2069
|
|
|
2070
|
-
[src/Particle.js:2261-2268](https://github.com/particle-iot/particle-api-js/blob/
|
|
2070
|
+
[src/Particle.js:2261-2268](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2261-L2268 "Source code on GitHub")
|
|
2071
2071
|
|
|
2072
2072
|
Deletes a logic function in the specified organization or sandbox by logic function ID.
|
|
2073
2073
|
|
|
@@ -2084,7 +2084,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2084
2084
|
|
|
2085
2085
|
### listLogicFunctions
|
|
2086
2086
|
|
|
2087
|
-
[src/Particle.js:2282-2292](https://github.com/particle-iot/particle-api-js/blob/
|
|
2087
|
+
[src/Particle.js:2282-2292](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2282-L2292 "Source code on GitHub")
|
|
2088
2088
|
|
|
2089
2089
|
Lists all logic functions in the specified organization or sandbox.
|
|
2090
2090
|
|
|
@@ -2101,7 +2101,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2101
2101
|
|
|
2102
2102
|
### listLogicRuns
|
|
2103
2103
|
|
|
2104
|
-
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/
|
|
2104
|
+
[src/Particle.js:2306-2313](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2306-L2313 "Source code on GitHub")
|
|
2105
2105
|
|
|
2106
2106
|
Lists all logic runs for the specified logic function in the specified organization or sandbox.
|
|
2107
2107
|
|
|
@@ -2118,7 +2118,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2118
2118
|
|
|
2119
2119
|
### getLogicRun
|
|
2120
2120
|
|
|
2121
|
-
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/
|
|
2121
|
+
[src/Particle.js:2328-2335](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2328-L2335 "Source code on GitHub")
|
|
2122
2122
|
|
|
2123
2123
|
Retrieves a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2124
2124
|
|
|
@@ -2136,7 +2136,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2136
2136
|
|
|
2137
2137
|
### getLogicRunLogs
|
|
2138
2138
|
|
|
2139
|
-
[src/Particle.js:2350-2357](https://github.com/particle-iot/particle-api-js/blob/
|
|
2139
|
+
[src/Particle.js:2350-2357](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2350-L2357 "Source code on GitHub")
|
|
2140
2140
|
|
|
2141
2141
|
Retrieves the logs for a logic run by its ID for the specified logic function in the specified organization or sandbox.
|
|
2142
2142
|
|
|
@@ -2154,7 +2154,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2154
2154
|
|
|
2155
2155
|
### createLedger
|
|
2156
2156
|
|
|
2157
|
-
[src/Particle.js:2371-2379](https://github.com/particle-iot/particle-api-js/blob/
|
|
2157
|
+
[src/Particle.js:2371-2379](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2371-L2379 "Source code on GitHub")
|
|
2158
2158
|
|
|
2159
2159
|
Creates a new ledger definition in the specified organization or sandbox.
|
|
2160
2160
|
|
|
@@ -2171,7 +2171,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2171
2171
|
|
|
2172
2172
|
### getLedger
|
|
2173
2173
|
|
|
2174
|
-
[src/Particle.js:2393-2400](https://github.com/particle-iot/particle-api-js/blob/
|
|
2174
|
+
[src/Particle.js:2393-2400](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2393-L2400 "Source code on GitHub")
|
|
2175
2175
|
|
|
2176
2176
|
Get a ledger definition in the specified organization or sandbox by ledger name.
|
|
2177
2177
|
|
|
@@ -2188,7 +2188,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2188
2188
|
|
|
2189
2189
|
### updateLedger
|
|
2190
2190
|
|
|
2191
|
-
[src/Particle.js:2415-2423](https://github.com/particle-iot/particle-api-js/blob/
|
|
2191
|
+
[src/Particle.js:2415-2423](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2415-L2423 "Source code on GitHub")
|
|
2192
2192
|
|
|
2193
2193
|
Updates an existing ledger definition in the specified organization or sandbox.
|
|
2194
2194
|
|
|
@@ -2206,7 +2206,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2206
2206
|
|
|
2207
2207
|
### archiveLedger
|
|
2208
2208
|
|
|
2209
|
-
[src/Particle.js:2437-2444](https://github.com/particle-iot/particle-api-js/blob/
|
|
2209
|
+
[src/Particle.js:2437-2444](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2437-L2444 "Source code on GitHub")
|
|
2210
2210
|
|
|
2211
2211
|
Archives a ledger definition in the specified organization or sandbox by ledger name.
|
|
2212
2212
|
|
|
@@ -2223,7 +2223,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2223
2223
|
|
|
2224
2224
|
### Scope
|
|
2225
2225
|
|
|
2226
|
-
[src/Particle.js:2465-2478](https://github.com/particle-iot/particle-api-js/blob/
|
|
2226
|
+
[src/Particle.js:2465-2478](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2465-L2478 "Source code on GitHub")
|
|
2227
2227
|
|
|
2228
2228
|
Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
2229
2229
|
|
|
@@ -2241,7 +2241,7 @@ Type: (`"Owner"` \| `"Product"` \| `"Device"`)
|
|
|
2241
2241
|
|
|
2242
2242
|
### listLedgers
|
|
2243
2243
|
|
|
2244
|
-
[src/Particle.js:2465-2478](https://github.com/particle-iot/particle-api-js/blob/
|
|
2244
|
+
[src/Particle.js:2465-2478](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2465-L2478 "Source code on GitHub")
|
|
2245
2245
|
|
|
2246
2246
|
Lists all ledger definitions in the specified organization or sandbox.
|
|
2247
2247
|
|
|
@@ -2261,7 +2261,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2261
2261
|
|
|
2262
2262
|
### getLedgerInstance
|
|
2263
2263
|
|
|
2264
|
-
[src/Particle.js:2493-2500](https://github.com/particle-iot/particle-api-js/blob/
|
|
2264
|
+
[src/Particle.js:2493-2500](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2493-L2500 "Source code on GitHub")
|
|
2265
2265
|
|
|
2266
2266
|
Get ledger instance data.
|
|
2267
2267
|
|
|
@@ -2279,7 +2279,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2279
2279
|
|
|
2280
2280
|
### SetMode
|
|
2281
2281
|
|
|
2282
|
-
[src/Particle.js:2521-2532](https://github.com/particle-iot/particle-api-js/blob/
|
|
2282
|
+
[src/Particle.js:2521-2532](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2521-L2532 "Source code on GitHub")
|
|
2283
2283
|
|
|
2284
2284
|
Type: (`"Replace"` \| `"Merge"`)
|
|
2285
2285
|
|
|
@@ -2297,7 +2297,7 @@ Type: (`"Replace"` \| `"Merge"`)
|
|
|
2297
2297
|
|
|
2298
2298
|
### setLedgerInstance
|
|
2299
2299
|
|
|
2300
|
-
[src/Particle.js:2521-2532](https://github.com/particle-iot/particle-api-js/blob/
|
|
2300
|
+
[src/Particle.js:2521-2532](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2521-L2532 "Source code on GitHub")
|
|
2301
2301
|
|
|
2302
2302
|
Set ledger instance data.
|
|
2303
2303
|
|
|
@@ -2317,7 +2317,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2317
2317
|
|
|
2318
2318
|
### deleteLedgerInstance
|
|
2319
2319
|
|
|
2320
|
-
[src/Particle.js:2547-2554](https://github.com/particle-iot/particle-api-js/blob/
|
|
2320
|
+
[src/Particle.js:2547-2554](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2547-L2554 "Source code on GitHub")
|
|
2321
2321
|
|
|
2322
2322
|
Delete a ledger instance in the specified organization or sandbox by ledger name.
|
|
2323
2323
|
|
|
@@ -2335,7 +2335,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2335
2335
|
|
|
2336
2336
|
### listLedgerInstances
|
|
2337
2337
|
|
|
2338
|
-
[src/Particle.js:2570-2581](https://github.com/particle-iot/particle-api-js/blob/
|
|
2338
|
+
[src/Particle.js:2570-2581](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2570-L2581 "Source code on GitHub")
|
|
2339
2339
|
|
|
2340
2340
|
Lists ledger instances in the specified organization or sandbox.
|
|
2341
2341
|
|
|
@@ -2354,7 +2354,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2354
2354
|
|
|
2355
2355
|
### listLedgerInstanceVersions
|
|
2356
2356
|
|
|
2357
|
-
[src/Particle.js:2598-2609](https://github.com/particle-iot/particle-api-js/blob/
|
|
2357
|
+
[src/Particle.js:2598-2609](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2598-L2609 "Source code on GitHub")
|
|
2358
2358
|
|
|
2359
2359
|
List ledger instance versions
|
|
2360
2360
|
|
|
@@ -2374,7 +2374,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2374
2374
|
|
|
2375
2375
|
### getLedgerInstanceVersion
|
|
2376
2376
|
|
|
2377
|
-
[src/Particle.js:2625-2632](https://github.com/particle-iot/particle-api-js/blob/
|
|
2377
|
+
[src/Particle.js:2625-2632](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2625-L2632 "Source code on GitHub")
|
|
2378
2378
|
|
|
2379
2379
|
Get specific ledger instance version
|
|
2380
2380
|
|
|
@@ -2393,7 +2393,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2393
2393
|
|
|
2394
2394
|
### setDefaultAuth
|
|
2395
2395
|
|
|
2396
|
-
[src/Particle.js:2639-2647](https://github.com/particle-iot/particle-api-js/blob/
|
|
2396
|
+
[src/Particle.js:2639-2647](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2639-L2647 "Source code on GitHub")
|
|
2397
2397
|
|
|
2398
2398
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2399
2399
|
|
|
@@ -2406,7 +2406,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
2406
2406
|
|
|
2407
2407
|
### get
|
|
2408
2408
|
|
|
2409
|
-
[src/Particle.js:2697-2701](https://github.com/particle-iot/particle-api-js/blob/
|
|
2409
|
+
[src/Particle.js:2697-2701](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2697-L2701 "Source code on GitHub")
|
|
2410
2410
|
|
|
2411
2411
|
Make a GET request
|
|
2412
2412
|
|
|
@@ -2423,7 +2423,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2423
2423
|
|
|
2424
2424
|
### head
|
|
2425
2425
|
|
|
2426
|
-
[src/Particle.js:2713-2717](https://github.com/particle-iot/particle-api-js/blob/
|
|
2426
|
+
[src/Particle.js:2713-2717](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2713-L2717 "Source code on GitHub")
|
|
2427
2427
|
|
|
2428
2428
|
Make a HEAD request
|
|
2429
2429
|
|
|
@@ -2440,7 +2440,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2440
2440
|
|
|
2441
2441
|
### post
|
|
2442
2442
|
|
|
2443
|
-
[src/Particle.js:2729-2733](https://github.com/particle-iot/particle-api-js/blob/
|
|
2443
|
+
[src/Particle.js:2729-2733](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2729-L2733 "Source code on GitHub")
|
|
2444
2444
|
|
|
2445
2445
|
Make a POST request
|
|
2446
2446
|
|
|
@@ -2457,7 +2457,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2457
2457
|
|
|
2458
2458
|
### put
|
|
2459
2459
|
|
|
2460
|
-
[src/Particle.js:2746-2750](https://github.com/particle-iot/particle-api-js/blob/
|
|
2460
|
+
[src/Particle.js:2746-2750](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2746-L2750 "Source code on GitHub")
|
|
2461
2461
|
|
|
2462
2462
|
Make a PUT request
|
|
2463
2463
|
|
|
@@ -2475,7 +2475,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2475
2475
|
|
|
2476
2476
|
### delete
|
|
2477
2477
|
|
|
2478
|
-
[src/Particle.js:2762-2766](https://github.com/particle-iot/particle-api-js/blob/
|
|
2478
|
+
[src/Particle.js:2762-2766](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2762-L2766 "Source code on GitHub")
|
|
2479
2479
|
|
|
2480
2480
|
Make a DELETE request
|
|
2481
2481
|
|
|
@@ -2492,7 +2492,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2492
2492
|
|
|
2493
2493
|
### request
|
|
2494
2494
|
|
|
2495
|
-
[src/Particle.js:2783-2787](https://github.com/particle-iot/particle-api-js/blob/
|
|
2495
|
+
[src/Particle.js:2783-2787](https://github.com/particle-iot/particle-api-js/blob/70275e121b683426f66b1abbb71997109e4dd569/src/Particle.js#L2783-L2787 "Source code on GitHub")
|
|
2496
2496
|
|
|
2497
2497
|
**Parameters**
|
|
2498
2498
|
|