particle-api-js 10.1.0 → 10.2.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 +531 -531
- package/package.json +1 -1
- package/src/Particle.js +53 -53
- package/test/Particle.spec.js +47 -47
package/docs/api.md
CHANGED
|
@@ -104,14 +104,14 @@
|
|
|
104
104
|
- [setProductDeviceConfiguration](#setproductdeviceconfiguration)
|
|
105
105
|
- [getProductLocations](#getproductlocations)
|
|
106
106
|
- [getProductDeviceLocations](#getproductdevicelocations)
|
|
107
|
-
- [
|
|
108
|
-
- [
|
|
109
|
-
- [
|
|
110
|
-
- [
|
|
111
|
-
- [
|
|
112
|
-
- [
|
|
113
|
-
- [
|
|
114
|
-
- [
|
|
107
|
+
- [createLogicFunction](#createlogicfunction)
|
|
108
|
+
- [getLogicFunction](#getlogicfunction)
|
|
109
|
+
- [updateLogicFunction](#updatelogicfunction)
|
|
110
|
+
- [deleteLogicFunction](#deletelogicfunction)
|
|
111
|
+
- [listLogicFunctions](#listlogicfunctions)
|
|
112
|
+
- [listLogicRuns](#listlogicruns)
|
|
113
|
+
- [getLogicRun](#getlogicrun)
|
|
114
|
+
- [getLogicRunLogs](#getlogicrunlogs)
|
|
115
115
|
- [createLedger](#createledger)
|
|
116
116
|
- [getLedger](#getledger)
|
|
117
117
|
- [updateLedger](#updateledger)
|
|
@@ -230,14 +230,14 @@
|
|
|
230
230
|
- [setProductDeviceConfiguration](#setproductdeviceconfiguration-1)
|
|
231
231
|
- [getProductLocations](#getproductlocations-1)
|
|
232
232
|
- [getProductDeviceLocations](#getproductdevicelocations-1)
|
|
233
|
-
- [
|
|
234
|
-
- [
|
|
235
|
-
- [
|
|
236
|
-
- [
|
|
237
|
-
- [
|
|
238
|
-
- [
|
|
239
|
-
- [
|
|
240
|
-
- [
|
|
233
|
+
- [createLogicFunction](#createlogicfunction-1)
|
|
234
|
+
- [getLogicFunction](#getlogicfunction-1)
|
|
235
|
+
- [updateLogicFunction](#updatelogicfunction-1)
|
|
236
|
+
- [deleteLogicFunction](#deletelogicfunction-1)
|
|
237
|
+
- [listLogicFunctions](#listlogicfunctions-1)
|
|
238
|
+
- [listLogicRuns](#listlogicruns-1)
|
|
239
|
+
- [getLogicRun](#getlogicrun-1)
|
|
240
|
+
- [getLogicRunLogs](#getlogicrunlogs-1)
|
|
241
241
|
- [createLedger](#createledger-1)
|
|
242
242
|
- [getLedger](#getledger-1)
|
|
243
243
|
- [updateLedger](#updateledger-1)
|
|
@@ -356,14 +356,14 @@
|
|
|
356
356
|
- [setProductDeviceConfiguration](#setproductdeviceconfiguration-2)
|
|
357
357
|
- [getProductLocations](#getproductlocations-2)
|
|
358
358
|
- [getProductDeviceLocations](#getproductdevicelocations-2)
|
|
359
|
-
- [
|
|
360
|
-
- [
|
|
361
|
-
- [
|
|
362
|
-
- [
|
|
363
|
-
- [
|
|
364
|
-
- [
|
|
365
|
-
- [
|
|
366
|
-
- [
|
|
359
|
+
- [createLogicFunction](#createlogicfunction-2)
|
|
360
|
+
- [getLogicFunction](#getlogicfunction-2)
|
|
361
|
+
- [updateLogicFunction](#updatelogicfunction-2)
|
|
362
|
+
- [deleteLogicFunction](#deletelogicfunction-2)
|
|
363
|
+
- [listLogicFunctions](#listlogicfunctions-2)
|
|
364
|
+
- [listLogicRuns](#listlogicruns-2)
|
|
365
|
+
- [getLogicRun](#getlogicrun-2)
|
|
366
|
+
- [getLogicRunLogs](#getlogicrunlogs-2)
|
|
367
367
|
- [createLedger](#createledger-2)
|
|
368
368
|
- [getLedger](#getledger-2)
|
|
369
369
|
- [updateLedger](#updateledger-2)
|
|
@@ -383,7 +383,7 @@
|
|
|
383
383
|
|
|
384
384
|
## Particle
|
|
385
385
|
|
|
386
|
-
[src/Particle.js:23-2639](https://github.com/particle-iot/particle-api-js/blob/
|
|
386
|
+
[src/Particle.js:23-2639](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L23-L2639 "Source code on GitHub")
|
|
387
387
|
|
|
388
388
|
**Parameters**
|
|
389
389
|
|
|
@@ -391,7 +391,7 @@
|
|
|
391
391
|
|
|
392
392
|
### constructor
|
|
393
393
|
|
|
394
|
-
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/
|
|
394
|
+
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L31-L40 "Source code on GitHub")
|
|
395
395
|
|
|
396
396
|
Contructor for the Cloud API wrapper.
|
|
397
397
|
|
|
@@ -403,7 +403,7 @@ Create a new Particle object and call methods below on it.
|
|
|
403
403
|
|
|
404
404
|
### login
|
|
405
405
|
|
|
406
|
-
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/
|
|
406
|
+
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L77-L94 "Source code on GitHub")
|
|
407
407
|
|
|
408
408
|
Login to Particle Cloud using an existing Particle acccount.
|
|
409
409
|
|
|
@@ -420,7 +420,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
420
420
|
|
|
421
421
|
### sendOtp
|
|
422
422
|
|
|
423
|
-
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/
|
|
423
|
+
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L105-L121 "Source code on GitHub")
|
|
424
424
|
|
|
425
425
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
426
426
|
|
|
@@ -436,7 +436,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
436
436
|
|
|
437
437
|
### enableMfa
|
|
438
438
|
|
|
439
|
-
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/
|
|
439
|
+
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L131-L133 "Source code on GitHub")
|
|
440
440
|
|
|
441
441
|
Enable MFA on the currently logged in user
|
|
442
442
|
|
|
@@ -451,7 +451,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
451
451
|
|
|
452
452
|
### confirmMfa
|
|
453
453
|
|
|
454
|
-
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/
|
|
454
|
+
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L146-L160 "Source code on GitHub")
|
|
455
455
|
|
|
456
456
|
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.
|
|
457
457
|
|
|
@@ -469,7 +469,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
469
469
|
|
|
470
470
|
### disableMfa
|
|
471
471
|
|
|
472
|
-
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/
|
|
472
|
+
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L171-L179 "Source code on GitHub")
|
|
473
473
|
|
|
474
474
|
Disable MFA for the user.
|
|
475
475
|
|
|
@@ -485,7 +485,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
485
485
|
|
|
486
486
|
### createCustomer
|
|
487
487
|
|
|
488
|
-
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/
|
|
488
|
+
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L191-L207 "Source code on GitHub")
|
|
489
489
|
|
|
490
490
|
Create Customer for Product.
|
|
491
491
|
|
|
@@ -502,7 +502,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
502
502
|
|
|
503
503
|
### loginAsClientOwner
|
|
504
504
|
|
|
505
|
-
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/
|
|
505
|
+
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L216-L230 "Source code on GitHub")
|
|
506
506
|
|
|
507
507
|
Login to Particle Cloud using an OAuth client.
|
|
508
508
|
|
|
@@ -516,7 +516,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
516
516
|
|
|
517
517
|
### createUser
|
|
518
518
|
|
|
519
|
-
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/
|
|
519
|
+
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L242-L253 "Source code on GitHub")
|
|
520
520
|
|
|
521
521
|
Create a user account for the Particle Cloud
|
|
522
522
|
|
|
@@ -533,7 +533,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
533
533
|
|
|
534
534
|
### verifyUser
|
|
535
535
|
|
|
536
|
-
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/
|
|
536
|
+
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L263-L270 "Source code on GitHub")
|
|
537
537
|
|
|
538
538
|
Verify new user account via verification email
|
|
539
539
|
|
|
@@ -548,7 +548,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
548
548
|
|
|
549
549
|
### resetPassword
|
|
550
550
|
|
|
551
|
-
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/
|
|
551
|
+
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L280-L287 "Source code on GitHub")
|
|
552
552
|
|
|
553
553
|
Send reset password email for a Particle Cloud user account
|
|
554
554
|
|
|
@@ -563,7 +563,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
563
563
|
|
|
564
564
|
### deleteAccessToken
|
|
565
565
|
|
|
566
|
-
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/
|
|
566
|
+
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L299-L307 "Source code on GitHub")
|
|
567
567
|
|
|
568
568
|
Revoke an access token
|
|
569
569
|
|
|
@@ -580,7 +580,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
580
580
|
|
|
581
581
|
### deleteCurrentAccessToken
|
|
582
582
|
|
|
583
|
-
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/
|
|
583
|
+
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L317-L324 "Source code on GitHub")
|
|
584
584
|
|
|
585
585
|
Revoke the current session access token
|
|
586
586
|
|
|
@@ -595,7 +595,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
595
595
|
|
|
596
596
|
### deleteActiveAccessTokens
|
|
597
597
|
|
|
598
|
-
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/
|
|
598
|
+
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L334-L341 "Source code on GitHub")
|
|
599
599
|
|
|
600
600
|
Revoke all active access tokens
|
|
601
601
|
|
|
@@ -610,7 +610,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
610
610
|
|
|
611
611
|
### deleteUser
|
|
612
612
|
|
|
613
|
-
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/
|
|
613
|
+
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L352-L360 "Source code on GitHub")
|
|
614
614
|
|
|
615
615
|
Delete the current user
|
|
616
616
|
|
|
@@ -626,7 +626,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
626
626
|
|
|
627
627
|
### listAccessTokens
|
|
628
628
|
|
|
629
|
-
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/
|
|
629
|
+
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L372-L380 "Source code on GitHub")
|
|
630
630
|
|
|
631
631
|
List all valid access tokens for a Particle Cloud account
|
|
632
632
|
|
|
@@ -643,7 +643,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
643
643
|
|
|
644
644
|
### trackingIdentity
|
|
645
645
|
|
|
646
|
-
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/
|
|
646
|
+
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L392-L400 "Source code on GitHub")
|
|
647
647
|
|
|
648
648
|
Retrieves the information that is used to identify the current login for tracking.
|
|
649
649
|
|
|
@@ -660,7 +660,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
660
660
|
|
|
661
661
|
### listDevices
|
|
662
662
|
|
|
663
|
-
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/
|
|
663
|
+
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L418-L437 "Source code on GitHub")
|
|
664
664
|
|
|
665
665
|
List devices claimed to the account or product
|
|
666
666
|
|
|
@@ -683,7 +683,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
683
683
|
|
|
684
684
|
### getDevice
|
|
685
685
|
|
|
686
|
-
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/
|
|
686
|
+
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L449-L452 "Source code on GitHub")
|
|
687
687
|
|
|
688
688
|
Get detailed informationa about a device
|
|
689
689
|
|
|
@@ -700,7 +700,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
700
700
|
|
|
701
701
|
### claimDevice
|
|
702
702
|
|
|
703
|
-
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/
|
|
703
|
+
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L464-L475 "Source code on GitHub")
|
|
704
704
|
|
|
705
705
|
Claim a device to the account. The device must be online and unclaimed.
|
|
706
706
|
|
|
@@ -717,7 +717,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
717
717
|
|
|
718
718
|
### addDeviceToProduct
|
|
719
719
|
|
|
720
|
-
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/
|
|
720
|
+
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L489-L507 "Source code on GitHub")
|
|
721
721
|
|
|
722
722
|
Add a device to a product or move device out of quarantine.
|
|
723
723
|
|
|
@@ -736,7 +736,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
736
736
|
|
|
737
737
|
### removeDevice
|
|
738
738
|
|
|
739
|
-
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/
|
|
739
|
+
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L520-L524 "Source code on GitHub")
|
|
740
740
|
|
|
741
741
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
742
742
|
|
|
@@ -754,7 +754,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
754
754
|
|
|
755
755
|
### removeDeviceOwner
|
|
756
756
|
|
|
757
|
-
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/
|
|
757
|
+
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L536-L539 "Source code on GitHub")
|
|
758
758
|
|
|
759
759
|
Unclaim a product device its the owner, but keep it in the product
|
|
760
760
|
|
|
@@ -771,7 +771,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
771
771
|
|
|
772
772
|
### renameDevice
|
|
773
773
|
|
|
774
|
-
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/
|
|
774
|
+
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L552-L554 "Source code on GitHub")
|
|
775
775
|
|
|
776
776
|
Rename a device
|
|
777
777
|
|
|
@@ -789,7 +789,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
789
789
|
|
|
790
790
|
### signalDevice
|
|
791
791
|
|
|
792
|
-
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/
|
|
792
|
+
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L567-L569 "Source code on GitHub")
|
|
793
793
|
|
|
794
794
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
795
795
|
|
|
@@ -807,7 +807,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
807
807
|
|
|
808
808
|
### setDeviceNotes
|
|
809
809
|
|
|
810
|
-
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/
|
|
810
|
+
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L582-L584 "Source code on GitHub")
|
|
811
811
|
|
|
812
812
|
Store some notes about device
|
|
813
813
|
|
|
@@ -825,7 +825,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
825
825
|
|
|
826
826
|
### markAsDevelopmentDevice
|
|
827
827
|
|
|
828
|
-
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/
|
|
828
|
+
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L597-L599 "Source code on GitHub")
|
|
829
829
|
|
|
830
830
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
831
831
|
|
|
@@ -843,7 +843,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
843
843
|
|
|
844
844
|
### lockDeviceProductFirmware
|
|
845
845
|
|
|
846
|
-
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/
|
|
846
|
+
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L613-L615 "Source code on GitHub")
|
|
847
847
|
|
|
848
848
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
849
849
|
|
|
@@ -862,7 +862,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
862
862
|
|
|
863
863
|
### unlockDeviceProductFirmware
|
|
864
864
|
|
|
865
|
-
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/
|
|
865
|
+
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L627-L629 "Source code on GitHub")
|
|
866
866
|
|
|
867
867
|
Mark device as receiving automatic firmware updates
|
|
868
868
|
|
|
@@ -879,7 +879,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
879
879
|
|
|
880
880
|
### updateDevice
|
|
881
881
|
|
|
882
|
-
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/
|
|
882
|
+
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L648-L660 "Source code on GitHub")
|
|
883
883
|
|
|
884
884
|
Update multiple device attributes at the same time
|
|
885
885
|
|
|
@@ -903,7 +903,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
903
903
|
|
|
904
904
|
### provisionDevice
|
|
905
905
|
|
|
906
|
-
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/
|
|
906
|
+
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L671-L679 "Source code on GitHub")
|
|
907
907
|
|
|
908
908
|
Provision a new device for products that allow self-provisioning
|
|
909
909
|
|
|
@@ -919,7 +919,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
919
919
|
|
|
920
920
|
### getClaimCode
|
|
921
921
|
|
|
922
|
-
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/
|
|
922
|
+
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L693-L696 "Source code on GitHub")
|
|
923
923
|
|
|
924
924
|
Generate a claim code to use in the device claiming process.
|
|
925
925
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -938,7 +938,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
938
938
|
|
|
939
939
|
### getVariable
|
|
940
940
|
|
|
941
|
-
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/
|
|
941
|
+
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L728-L734 "Source code on GitHub")
|
|
942
942
|
|
|
943
943
|
Get the value of a device variable
|
|
944
944
|
|
|
@@ -956,7 +956,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
956
956
|
|
|
957
957
|
### flashDevice
|
|
958
958
|
|
|
959
|
-
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
959
|
+
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L748-L759 "Source code on GitHub")
|
|
960
960
|
|
|
961
961
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
962
962
|
|
|
@@ -975,7 +975,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
975
975
|
|
|
976
976
|
### flashTinker
|
|
977
977
|
|
|
978
|
-
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/
|
|
978
|
+
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L770-L785 "Source code on GitHub")
|
|
979
979
|
|
|
980
980
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
981
981
|
|
|
@@ -991,7 +991,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
991
991
|
|
|
992
992
|
### compileCode
|
|
993
993
|
|
|
994
|
-
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/
|
|
994
|
+
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L798-L816 "Source code on GitHub")
|
|
995
995
|
|
|
996
996
|
Compile firmware using the Particle Cloud
|
|
997
997
|
|
|
@@ -1009,7 +1009,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1009
1009
|
|
|
1010
1010
|
### downloadFirmwareBinary
|
|
1011
1011
|
|
|
1012
|
-
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/
|
|
1012
|
+
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L827-L836 "Source code on GitHub")
|
|
1013
1013
|
|
|
1014
1014
|
Download a firmware binary
|
|
1015
1015
|
|
|
@@ -1025,7 +1025,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1025
1025
|
|
|
1026
1026
|
### sendPublicKey
|
|
1027
1027
|
|
|
1028
|
-
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/
|
|
1028
|
+
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L849-L863 "Source code on GitHub")
|
|
1029
1029
|
|
|
1030
1030
|
Send a new device public key to the Particle Cloud
|
|
1031
1031
|
|
|
@@ -1043,7 +1043,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1043
1043
|
|
|
1044
1044
|
### callFunction
|
|
1045
1045
|
|
|
1046
|
-
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/
|
|
1046
|
+
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L877-L882 "Source code on GitHub")
|
|
1047
1047
|
|
|
1048
1048
|
Call a device function
|
|
1049
1049
|
|
|
@@ -1062,7 +1062,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1062
1062
|
|
|
1063
1063
|
### getEventStream
|
|
1064
1064
|
|
|
1065
|
-
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/
|
|
1065
|
+
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L895-L920 "Source code on GitHub")
|
|
1066
1066
|
|
|
1067
1067
|
Get a stream of events
|
|
1068
1068
|
|
|
@@ -1080,7 +1080,7 @@ emit 'event' events.
|
|
|
1080
1080
|
|
|
1081
1081
|
### publishEvent
|
|
1082
1082
|
|
|
1083
|
-
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/
|
|
1083
|
+
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L934-L938 "Source code on GitHub")
|
|
1084
1084
|
|
|
1085
1085
|
Publish a event to the Particle Cloud
|
|
1086
1086
|
|
|
@@ -1099,7 +1099,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1099
1099
|
|
|
1100
1100
|
### createWebhook
|
|
1101
1101
|
|
|
1102
|
-
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/
|
|
1102
|
+
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L965-L987 "Source code on GitHub")
|
|
1103
1103
|
|
|
1104
1104
|
Create a webhook
|
|
1105
1105
|
|
|
@@ -1131,7 +1131,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1131
1131
|
|
|
1132
1132
|
### deleteWebhook
|
|
1133
1133
|
|
|
1134
|
-
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/
|
|
1134
|
+
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L999-L1002 "Source code on GitHub")
|
|
1135
1135
|
|
|
1136
1136
|
Delete a webhook
|
|
1137
1137
|
|
|
@@ -1148,7 +1148,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1148
1148
|
|
|
1149
1149
|
### listWebhooks
|
|
1150
1150
|
|
|
1151
|
-
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
1151
|
+
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1013-L1016 "Source code on GitHub")
|
|
1152
1152
|
|
|
1153
1153
|
List all webhooks owned by the account or product
|
|
1154
1154
|
|
|
@@ -1164,7 +1164,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1164
1164
|
|
|
1165
1165
|
### createIntegration
|
|
1166
1166
|
|
|
1167
|
-
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/
|
|
1167
|
+
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1033-L1037 "Source code on GitHub")
|
|
1168
1168
|
|
|
1169
1169
|
Create an integration to send events to an external service
|
|
1170
1170
|
|
|
@@ -1185,7 +1185,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1185
1185
|
|
|
1186
1186
|
### editIntegration
|
|
1187
1187
|
|
|
1188
|
-
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/
|
|
1188
|
+
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1055-L1059 "Source code on GitHub")
|
|
1189
1189
|
|
|
1190
1190
|
Edit an integration to send events to an external service
|
|
1191
1191
|
|
|
@@ -1207,7 +1207,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1207
1207
|
|
|
1208
1208
|
### deleteIntegration
|
|
1209
1209
|
|
|
1210
|
-
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/
|
|
1210
|
+
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1072-L1075 "Source code on GitHub")
|
|
1211
1211
|
|
|
1212
1212
|
Delete an integration to send events to an external service
|
|
1213
1213
|
|
|
@@ -1224,7 +1224,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1224
1224
|
|
|
1225
1225
|
### listIntegrations
|
|
1226
1226
|
|
|
1227
|
-
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/
|
|
1227
|
+
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1086-L1089 "Source code on GitHub")
|
|
1228
1228
|
|
|
1229
1229
|
List all integrations owned by the account or product
|
|
1230
1230
|
|
|
@@ -1240,7 +1240,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1240
1240
|
|
|
1241
1241
|
### getUserInfo
|
|
1242
1242
|
|
|
1243
|
-
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
1243
|
+
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1099-L1101 "Source code on GitHub")
|
|
1244
1244
|
|
|
1245
1245
|
Get details about the current user
|
|
1246
1246
|
|
|
@@ -1255,7 +1255,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1255
1255
|
|
|
1256
1256
|
### setUserInfo
|
|
1257
1257
|
|
|
1258
|
-
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/
|
|
1258
|
+
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1112-L1115 "Source code on GitHub")
|
|
1259
1259
|
|
|
1260
1260
|
Set details on the current user
|
|
1261
1261
|
|
|
@@ -1271,7 +1271,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1271
1271
|
|
|
1272
1272
|
### changeUsername
|
|
1273
1273
|
|
|
1274
|
-
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/
|
|
1274
|
+
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1128-L1136 "Source code on GitHub")
|
|
1275
1275
|
|
|
1276
1276
|
Change username (i.e, email)
|
|
1277
1277
|
|
|
@@ -1289,7 +1289,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1289
1289
|
|
|
1290
1290
|
### changeUserPassword
|
|
1291
1291
|
|
|
1292
|
-
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/
|
|
1292
|
+
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1149-L1157 "Source code on GitHub")
|
|
1293
1293
|
|
|
1294
1294
|
Change user's password
|
|
1295
1295
|
|
|
@@ -1307,7 +1307,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1307
1307
|
|
|
1308
1308
|
### listSIMs
|
|
1309
1309
|
|
|
1310
|
-
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/
|
|
1310
|
+
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1173-L1177 "Source code on GitHub")
|
|
1311
1311
|
|
|
1312
1312
|
List SIM cards owned by a user or product
|
|
1313
1313
|
|
|
@@ -1328,7 +1328,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1328
1328
|
|
|
1329
1329
|
### getSIMDataUsage
|
|
1330
1330
|
|
|
1331
|
-
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/
|
|
1331
|
+
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1189-L1195 "Source code on GitHub")
|
|
1332
1332
|
|
|
1333
1333
|
Get data usage for one SIM card for the current billing period
|
|
1334
1334
|
|
|
@@ -1345,7 +1345,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1345
1345
|
|
|
1346
1346
|
### getFleetDataUsage
|
|
1347
1347
|
|
|
1348
|
-
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/
|
|
1348
|
+
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1206-L1213 "Source code on GitHub")
|
|
1349
1349
|
|
|
1350
1350
|
Get data usage for all SIM cards in a product the current billing period
|
|
1351
1351
|
|
|
@@ -1361,7 +1361,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1361
1361
|
|
|
1362
1362
|
### checkSIM
|
|
1363
1363
|
|
|
1364
|
-
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/
|
|
1364
|
+
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1224-L1226 "Source code on GitHub")
|
|
1365
1365
|
|
|
1366
1366
|
Check SIM status
|
|
1367
1367
|
|
|
@@ -1377,7 +1377,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1377
1377
|
|
|
1378
1378
|
### activateSIM
|
|
1379
1379
|
|
|
1380
|
-
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/
|
|
1380
|
+
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1241-L1251 "Source code on GitHub")
|
|
1381
1381
|
|
|
1382
1382
|
Activate and add SIM cards to an account or product
|
|
1383
1383
|
|
|
@@ -1397,7 +1397,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1397
1397
|
|
|
1398
1398
|
### deactivateSIM
|
|
1399
1399
|
|
|
1400
|
-
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/
|
|
1400
|
+
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1263-L1267 "Source code on GitHub")
|
|
1401
1401
|
|
|
1402
1402
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
1403
1403
|
|
|
@@ -1414,7 +1414,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1414
1414
|
|
|
1415
1415
|
### reactivateSIM
|
|
1416
1416
|
|
|
1417
|
-
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/
|
|
1417
|
+
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1280-L1284 "Source code on GitHub")
|
|
1418
1418
|
|
|
1419
1419
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
1420
1420
|
|
|
@@ -1432,7 +1432,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1432
1432
|
|
|
1433
1433
|
### updateSIM
|
|
1434
1434
|
|
|
1435
|
-
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/
|
|
1435
|
+
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1297-L1301 "Source code on GitHub")
|
|
1436
1436
|
|
|
1437
1437
|
Update SIM card data limit
|
|
1438
1438
|
|
|
@@ -1450,7 +1450,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1450
1450
|
|
|
1451
1451
|
### removeSIM
|
|
1452
1452
|
|
|
1453
|
-
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/
|
|
1453
|
+
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1313-L1316 "Source code on GitHub")
|
|
1454
1454
|
|
|
1455
1455
|
Remove a SIM card from an account so it can be activated by a different account
|
|
1456
1456
|
|
|
@@ -1467,7 +1467,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1467
1467
|
|
|
1468
1468
|
### listBuildTargets
|
|
1469
1469
|
|
|
1470
|
-
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/
|
|
1470
|
+
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1327-L1330 "Source code on GitHub")
|
|
1471
1471
|
|
|
1472
1472
|
List valid build targets to be used for compiling
|
|
1473
1473
|
|
|
@@ -1483,7 +1483,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1483
1483
|
|
|
1484
1484
|
### listLibraries
|
|
1485
1485
|
|
|
1486
|
-
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/
|
|
1486
|
+
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1356-L1373 "Source code on GitHub")
|
|
1487
1487
|
|
|
1488
1488
|
List firmware libraries
|
|
1489
1489
|
|
|
@@ -1512,7 +1512,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1512
1512
|
|
|
1513
1513
|
### getLibrary
|
|
1514
1514
|
|
|
1515
|
-
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/
|
|
1515
|
+
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1389-L1397 "Source code on GitHub")
|
|
1516
1516
|
|
|
1517
1517
|
Get firmware library details
|
|
1518
1518
|
|
|
@@ -1529,7 +1529,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1529
1529
|
|
|
1530
1530
|
### getLibraryVersions
|
|
1531
1531
|
|
|
1532
|
-
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/
|
|
1532
|
+
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1410-L1418 "Source code on GitHub")
|
|
1533
1533
|
|
|
1534
1534
|
Firmware library details for each version
|
|
1535
1535
|
|
|
@@ -1547,7 +1547,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1547
1547
|
|
|
1548
1548
|
### contributeLibrary
|
|
1549
1549
|
|
|
1550
|
-
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/
|
|
1550
|
+
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1430-L1443 "Source code on GitHub")
|
|
1551
1551
|
|
|
1552
1552
|
Contribute a new library version from a compressed archive
|
|
1553
1553
|
|
|
@@ -1564,7 +1564,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1564
1564
|
|
|
1565
1565
|
### publishLibrary
|
|
1566
1566
|
|
|
1567
|
-
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/
|
|
1567
|
+
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1454-L1463 "Source code on GitHub")
|
|
1568
1568
|
|
|
1569
1569
|
Publish the latest version of a library to the public
|
|
1570
1570
|
|
|
@@ -1580,7 +1580,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1580
1580
|
|
|
1581
1581
|
### deleteLibrary
|
|
1582
1582
|
|
|
1583
|
-
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/
|
|
1583
|
+
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1475-L1483 "Source code on GitHub")
|
|
1584
1584
|
|
|
1585
1585
|
Delete one version of a library or an entire private library
|
|
1586
1586
|
|
|
@@ -1597,7 +1597,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1597
1597
|
|
|
1598
1598
|
### downloadFile
|
|
1599
1599
|
|
|
1600
|
-
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
1600
|
+
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1493-L1495 "Source code on GitHub")
|
|
1601
1601
|
|
|
1602
1602
|
Download an external file that may not be on the API
|
|
1603
1603
|
|
|
@@ -1612,7 +1612,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1612
1612
|
|
|
1613
1613
|
### listOAuthClients
|
|
1614
1614
|
|
|
1615
|
-
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/
|
|
1615
|
+
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1506-L1509 "Source code on GitHub")
|
|
1616
1616
|
|
|
1617
1617
|
List OAuth client created by the account
|
|
1618
1618
|
|
|
@@ -1628,7 +1628,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1628
1628
|
|
|
1629
1629
|
### createOAuthClient
|
|
1630
1630
|
|
|
1631
|
-
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/
|
|
1631
|
+
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1524-L1528 "Source code on GitHub")
|
|
1632
1632
|
|
|
1633
1633
|
Create an OAuth client
|
|
1634
1634
|
|
|
@@ -1648,7 +1648,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1648
1648
|
|
|
1649
1649
|
### updateOAuthClient
|
|
1650
1650
|
|
|
1651
|
-
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/
|
|
1651
|
+
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1542-L1546 "Source code on GitHub")
|
|
1652
1652
|
|
|
1653
1653
|
Update an OAuth client
|
|
1654
1654
|
|
|
@@ -1667,7 +1667,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1667
1667
|
|
|
1668
1668
|
### deleteOAuthClient
|
|
1669
1669
|
|
|
1670
|
-
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/
|
|
1670
|
+
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1558-L1561 "Source code on GitHub")
|
|
1671
1671
|
|
|
1672
1672
|
Delete an OAuth client
|
|
1673
1673
|
|
|
@@ -1684,7 +1684,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1684
1684
|
|
|
1685
1685
|
### listProducts
|
|
1686
1686
|
|
|
1687
|
-
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
1687
|
+
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1571-L1573 "Source code on GitHub")
|
|
1688
1688
|
|
|
1689
1689
|
List products the account has access to
|
|
1690
1690
|
|
|
@@ -1699,7 +1699,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1699
1699
|
|
|
1700
1700
|
### getProduct
|
|
1701
1701
|
|
|
1702
|
-
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/
|
|
1702
|
+
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1584-L1586 "Source code on GitHub")
|
|
1703
1703
|
|
|
1704
1704
|
Get detailed information about a product
|
|
1705
1705
|
|
|
@@ -1715,7 +1715,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1715
1715
|
|
|
1716
1716
|
### listProductFirmware
|
|
1717
1717
|
|
|
1718
|
-
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/
|
|
1718
|
+
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1597-L1599 "Source code on GitHub")
|
|
1719
1719
|
|
|
1720
1720
|
List product firmware versions
|
|
1721
1721
|
|
|
@@ -1731,7 +1731,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1731
1731
|
|
|
1732
1732
|
### uploadProductFirmware
|
|
1733
1733
|
|
|
1734
|
-
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/
|
|
1734
|
+
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1615-L1631 "Source code on GitHub")
|
|
1735
1735
|
|
|
1736
1736
|
List product firmware versions
|
|
1737
1737
|
|
|
@@ -1752,7 +1752,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1752
1752
|
|
|
1753
1753
|
### getProductFirmware
|
|
1754
1754
|
|
|
1755
|
-
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/
|
|
1755
|
+
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1643-L1650 "Source code on GitHub")
|
|
1756
1756
|
|
|
1757
1757
|
Get information about a product firmware version
|
|
1758
1758
|
|
|
@@ -1769,7 +1769,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1769
1769
|
|
|
1770
1770
|
### updateProductFirmware
|
|
1771
1771
|
|
|
1772
|
-
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/
|
|
1772
|
+
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1664-L1667 "Source code on GitHub")
|
|
1773
1773
|
|
|
1774
1774
|
Update information for a product firmware version
|
|
1775
1775
|
|
|
@@ -1788,7 +1788,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1788
1788
|
|
|
1789
1789
|
### downloadProductFirmware
|
|
1790
1790
|
|
|
1791
|
-
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/
|
|
1791
|
+
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1679-L1688 "Source code on GitHub")
|
|
1792
1792
|
|
|
1793
1793
|
Download a product firmware binary
|
|
1794
1794
|
|
|
@@ -1805,7 +1805,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1805
1805
|
|
|
1806
1806
|
### releaseProductFirmware
|
|
1807
1807
|
|
|
1808
|
-
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/
|
|
1808
|
+
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1700-L1703 "Source code on GitHub")
|
|
1809
1809
|
|
|
1810
1810
|
Release a product firmware version as the default version
|
|
1811
1811
|
|
|
@@ -1822,7 +1822,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1822
1822
|
|
|
1823
1823
|
### listTeamMembers
|
|
1824
1824
|
|
|
1825
|
-
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/
|
|
1825
|
+
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1714-L1721 "Source code on GitHub")
|
|
1826
1826
|
|
|
1827
1827
|
List product team members
|
|
1828
1828
|
|
|
@@ -1838,7 +1838,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1838
1838
|
|
|
1839
1839
|
### inviteTeamMember
|
|
1840
1840
|
|
|
1841
|
-
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/
|
|
1841
|
+
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1733-L1741 "Source code on GitHub")
|
|
1842
1842
|
|
|
1843
1843
|
Invite Particle user to a product team
|
|
1844
1844
|
|
|
@@ -1855,7 +1855,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1855
1855
|
|
|
1856
1856
|
### removeTeamMember
|
|
1857
1857
|
|
|
1858
|
-
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/
|
|
1858
|
+
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1753-L1760 "Source code on GitHub")
|
|
1859
1859
|
|
|
1860
1860
|
Remove Particle user to a product team
|
|
1861
1861
|
|
|
@@ -1872,7 +1872,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1872
1872
|
|
|
1873
1873
|
### lookupSerialNumber
|
|
1874
1874
|
|
|
1875
|
-
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/
|
|
1875
|
+
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1771-L1778 "Source code on GitHub")
|
|
1876
1876
|
|
|
1877
1877
|
Fetch details about a serial number
|
|
1878
1878
|
|
|
@@ -1888,7 +1888,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1888
1888
|
|
|
1889
1889
|
### createMeshNetwork
|
|
1890
1890
|
|
|
1891
|
-
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/
|
|
1891
|
+
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1791-L1799 "Source code on GitHub")
|
|
1892
1892
|
|
|
1893
1893
|
Create a mesh network
|
|
1894
1894
|
|
|
@@ -1906,7 +1906,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1906
1906
|
|
|
1907
1907
|
### removeMeshNetwork
|
|
1908
1908
|
|
|
1909
|
-
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/
|
|
1909
|
+
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1810-L1812 "Source code on GitHub")
|
|
1910
1910
|
|
|
1911
1911
|
Remove a mesh network.
|
|
1912
1912
|
|
|
@@ -1922,7 +1922,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1922
1922
|
|
|
1923
1923
|
### listMeshNetworks
|
|
1924
1924
|
|
|
1925
|
-
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/
|
|
1925
|
+
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1824-L1827 "Source code on GitHub")
|
|
1926
1926
|
|
|
1927
1927
|
List all mesh networks
|
|
1928
1928
|
|
|
@@ -1939,7 +1939,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1939
1939
|
|
|
1940
1940
|
### getMeshNetwork
|
|
1941
1941
|
|
|
1942
|
-
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/
|
|
1942
|
+
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1838-L1840 "Source code on GitHub")
|
|
1943
1943
|
|
|
1944
1944
|
Get information about a mesh network.
|
|
1945
1945
|
|
|
@@ -1955,7 +1955,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1955
1955
|
|
|
1956
1956
|
### updateMeshNetwork
|
|
1957
1957
|
|
|
1958
|
-
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/
|
|
1958
|
+
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1853-L1861 "Source code on GitHub")
|
|
1959
1959
|
|
|
1960
1960
|
Modify a mesh network.
|
|
1961
1961
|
|
|
@@ -1973,7 +1973,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1973
1973
|
|
|
1974
1974
|
### addMeshNetworkDevice
|
|
1975
1975
|
|
|
1976
|
-
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/
|
|
1976
|
+
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1873-L1882 "Source code on GitHub")
|
|
1977
1977
|
|
|
1978
1978
|
Add a device to a mesh network.
|
|
1979
1979
|
|
|
@@ -1990,7 +1990,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
1990
1990
|
|
|
1991
1991
|
### removeMeshNetworkDevice
|
|
1992
1992
|
|
|
1993
|
-
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/
|
|
1993
|
+
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1894-L1910 "Source code on GitHub")
|
|
1994
1994
|
|
|
1995
1995
|
Remove a device from a mesh network.
|
|
1996
1996
|
|
|
@@ -2007,7 +2007,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2007
2007
|
|
|
2008
2008
|
### listMeshNetworkDevices
|
|
2009
2009
|
|
|
2010
|
-
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/
|
|
2010
|
+
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1924-L1933 "Source code on GitHub")
|
|
2011
2011
|
|
|
2012
2012
|
List all devices of a mesh network.
|
|
2013
2013
|
|
|
@@ -2026,7 +2026,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2026
2026
|
|
|
2027
2027
|
### getProductConfiguration
|
|
2028
2028
|
|
|
2029
|
-
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/
|
|
2029
|
+
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1944-L1951 "Source code on GitHub")
|
|
2030
2030
|
|
|
2031
2031
|
Get product configuration
|
|
2032
2032
|
|
|
@@ -2042,7 +2042,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2042
2042
|
|
|
2043
2043
|
### getProductConfigurationSchema
|
|
2044
2044
|
|
|
2045
|
-
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/
|
|
2045
|
+
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1962-L1970 "Source code on GitHub")
|
|
2046
2046
|
|
|
2047
2047
|
Get product configuration schema
|
|
2048
2048
|
|
|
@@ -2058,7 +2058,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2058
2058
|
|
|
2059
2059
|
### getProductDeviceConfiguration
|
|
2060
2060
|
|
|
2061
|
-
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/
|
|
2061
|
+
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1982-L1989 "Source code on GitHub")
|
|
2062
2062
|
|
|
2063
2063
|
Get product device's configuration
|
|
2064
2064
|
|
|
@@ -2075,7 +2075,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2075
2075
|
|
|
2076
2076
|
### getProductDeviceConfigurationSchema
|
|
2077
2077
|
|
|
2078
|
-
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/
|
|
2078
|
+
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2001-L2009 "Source code on GitHub")
|
|
2079
2079
|
|
|
2080
2080
|
Get product device's configuration schema
|
|
2081
2081
|
|
|
@@ -2092,7 +2092,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2092
2092
|
|
|
2093
2093
|
### setProductConfiguration
|
|
2094
2094
|
|
|
2095
|
-
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/
|
|
2095
|
+
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2021-L2029 "Source code on GitHub")
|
|
2096
2096
|
|
|
2097
2097
|
Set product configuration
|
|
2098
2098
|
|
|
@@ -2109,7 +2109,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2109
2109
|
|
|
2110
2110
|
### setProductDeviceConfiguration
|
|
2111
2111
|
|
|
2112
|
-
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/
|
|
2112
|
+
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2042-L2050 "Source code on GitHub")
|
|
2113
2113
|
|
|
2114
2114
|
Set product configuration for a specific device within the product
|
|
2115
2115
|
|
|
@@ -2127,7 +2127,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2127
2127
|
|
|
2128
2128
|
### getProductLocations
|
|
2129
2129
|
|
|
2130
|
-
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/
|
|
2130
|
+
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2069-L2086 "Source code on GitHub")
|
|
2131
2131
|
|
|
2132
2132
|
Query location for devices within a product
|
|
2133
2133
|
|
|
@@ -2151,7 +2151,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2151
2151
|
|
|
2152
2152
|
### getProductDeviceLocations
|
|
2153
2153
|
|
|
2154
|
-
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/
|
|
2154
|
+
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2103-L2115 "Source code on GitHub")
|
|
2155
2155
|
|
|
2156
2156
|
Query location for one device within a product
|
|
2157
2157
|
|
|
@@ -2169,155 +2169,155 @@ Query location for one device within a product
|
|
|
2169
2169
|
|
|
2170
2170
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
2171
2171
|
|
|
2172
|
-
###
|
|
2172
|
+
### createLogicFunction
|
|
2173
2173
|
|
|
2174
|
-
[src/Particle.js:2135-2143](https://github.com/particle-iot/particle-api-js/blob/
|
|
2174
|
+
[src/Particle.js:2135-2143](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2135-L2143 "Source code on GitHub")
|
|
2175
2175
|
|
|
2176
|
-
Creates a new logic
|
|
2176
|
+
Creates a new logic function in the specified organization using the provided function data.
|
|
2177
2177
|
|
|
2178
|
-
When you create a logic
|
|
2179
|
-
start being handled by the
|
|
2178
|
+
When you create a logic function with Event logic triggers, events will immediately
|
|
2179
|
+
start being handled by the function code.
|
|
2180
2180
|
|
|
2181
|
-
When you create a
|
|
2181
|
+
When you create a Scheduled logic trigger, it will immediately be scheduled at the next time
|
|
2182
2182
|
according to the cron and start_at properties.
|
|
2183
2183
|
|
|
2184
2184
|
**Parameters**
|
|
2185
2185
|
|
|
2186
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic
|
|
2186
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
2187
2187
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2188
2188
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
|
|
2189
|
-
- `options.
|
|
2189
|
+
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the function details.
|
|
2190
2190
|
- `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.
|
|
2191
2191
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2192
2192
|
|
|
2193
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic
|
|
2193
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic function data.
|
|
2194
2194
|
|
|
2195
|
-
###
|
|
2195
|
+
### getLogicFunction
|
|
2196
2196
|
|
|
2197
|
-
[src/Particle.js:2157-2164](https://github.com/particle-iot/particle-api-js/blob/
|
|
2197
|
+
[src/Particle.js:2157-2164](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2157-L2164 "Source code on GitHub")
|
|
2198
2198
|
|
|
2199
|
-
Get a logic
|
|
2199
|
+
Get a logic function in the specified organization by logic function ID.
|
|
2200
2200
|
|
|
2201
2201
|
**Parameters**
|
|
2202
2202
|
|
|
2203
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic
|
|
2203
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
2204
2204
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2205
2205
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
|
|
2206
|
-
- `options.
|
|
2206
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
2207
2207
|
- `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.
|
|
2208
2208
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2209
2209
|
|
|
2210
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified logic
|
|
2210
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified logic function data.
|
|
2211
2211
|
|
|
2212
|
-
###
|
|
2212
|
+
### updateLogicFunction
|
|
2213
2213
|
|
|
2214
|
-
[src/Particle.js:2181-2189](https://github.com/particle-iot/particle-api-js/blob/
|
|
2214
|
+
[src/Particle.js:2181-2189](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2181-L2189 "Source code on GitHub")
|
|
2215
2215
|
|
|
2216
|
-
Updates an existing logic
|
|
2216
|
+
Updates an existing logic function in the specified organization using the provided function data.
|
|
2217
2217
|
|
|
2218
|
-
If you include an id on a
|
|
2218
|
+
If you include an id on a logic trigger, it will update the logic trigger in place.
|
|
2219
2219
|
|
|
2220
2220
|
**Parameters**
|
|
2221
2221
|
|
|
2222
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic
|
|
2222
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
2223
2223
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2224
2224
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
2225
|
-
- `options.
|
|
2226
|
-
- `options.
|
|
2225
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
2226
|
+
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the logic function details.
|
|
2227
2227
|
- `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.
|
|
2228
2228
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
2229
2229
|
|
|
2230
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the updated logic
|
|
2230
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the updated logic function data.
|
|
2231
2231
|
|
|
2232
|
-
###
|
|
2232
|
+
### deleteLogicFunction
|
|
2233
2233
|
|
|
2234
|
-
[src/Particle.js:2203-2210](https://github.com/particle-iot/particle-api-js/blob/
|
|
2234
|
+
[src/Particle.js:2203-2210](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2203-L2210 "Source code on GitHub")
|
|
2235
2235
|
|
|
2236
|
-
Deletes a logic
|
|
2236
|
+
Deletes a logic function in the specified organization by logic function ID.
|
|
2237
2237
|
|
|
2238
2238
|
**Parameters**
|
|
2239
2239
|
|
|
2240
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic
|
|
2240
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
2241
2241
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2242
2242
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
2243
|
-
- `options.
|
|
2243
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
2244
2244
|
- `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.
|
|
2245
2245
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
2246
2246
|
|
|
2247
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an object containing the deleted
|
|
2247
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an object containing the deleted logic function ID.
|
|
2248
2248
|
|
|
2249
|
-
###
|
|
2249
|
+
### listLogicFunctions
|
|
2250
2250
|
|
|
2251
|
-
[src/Particle.js:2223-2230](https://github.com/particle-iot/particle-api-js/blob/
|
|
2251
|
+
[src/Particle.js:2223-2230](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2223-L2230 "Source code on GitHub")
|
|
2252
2252
|
|
|
2253
|
-
Lists all logic
|
|
2253
|
+
Lists all logic functions in the specified organization.
|
|
2254
2254
|
|
|
2255
2255
|
**Parameters**
|
|
2256
2256
|
|
|
2257
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic
|
|
2257
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
2258
2258
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
2259
2259
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
2260
2260
|
- `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.
|
|
2261
2261
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
2262
2262
|
|
|
2263
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic
|
|
2263
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic functions data.
|
|
2264
2264
|
|
|
2265
|
-
###
|
|
2265
|
+
### listLogicRuns
|
|
2266
2266
|
|
|
2267
|
-
[src/Particle.js:2244-2251](https://github.com/particle-iot/particle-api-js/blob/
|
|
2267
|
+
[src/Particle.js:2244-2251](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2244-L2251 "Source code on GitHub")
|
|
2268
2268
|
|
|
2269
|
-
Lists all
|
|
2269
|
+
Lists all logic runs for the specified logic function.
|
|
2270
2270
|
|
|
2271
2271
|
**Parameters**
|
|
2272
2272
|
|
|
2273
2273
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2274
2274
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2275
2275
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
2276
|
-
- `options.
|
|
2276
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic runs.
|
|
2277
2277
|
- `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.
|
|
2278
2278
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2279
2279
|
|
|
2280
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of
|
|
2280
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic run data.
|
|
2281
2281
|
|
|
2282
|
-
###
|
|
2282
|
+
### getLogicRun
|
|
2283
2283
|
|
|
2284
|
-
[src/Particle.js:2266-2273](https://github.com/particle-iot/particle-api-js/blob/
|
|
2284
|
+
[src/Particle.js:2266-2273](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2266-L2273 "Source code on GitHub")
|
|
2285
2285
|
|
|
2286
|
-
Retrieves a
|
|
2286
|
+
Retrieves a logic run by its ID for the specified logic function.
|
|
2287
2287
|
|
|
2288
2288
|
**Parameters**
|
|
2289
2289
|
|
|
2290
2290
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2291
2291
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2292
2292
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
2293
|
-
- `options.
|
|
2294
|
-
- `options.
|
|
2293
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run.
|
|
2294
|
+
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run to retrieve.
|
|
2295
2295
|
- `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.
|
|
2296
2296
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2297
2297
|
|
|
2298
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of
|
|
2298
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic run data for the specified logic run ID.
|
|
2299
2299
|
|
|
2300
|
-
###
|
|
2300
|
+
### getLogicRunLogs
|
|
2301
2301
|
|
|
2302
|
-
[src/Particle.js:2288-2295](https://github.com/particle-iot/particle-api-js/blob/
|
|
2302
|
+
[src/Particle.js:2288-2295](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2288-L2295 "Source code on GitHub")
|
|
2303
2303
|
|
|
2304
|
-
Retrieves the logs for a
|
|
2304
|
+
Retrieves the logs for a logic run by its ID for the specified logic function.
|
|
2305
2305
|
|
|
2306
2306
|
**Parameters**
|
|
2307
2307
|
|
|
2308
2308
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
2309
2309
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
2310
2310
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
2311
|
-
- `options.
|
|
2312
|
-
- `options.
|
|
2311
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run logs.
|
|
2312
|
+
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run for which to retrieve the logs.
|
|
2313
2313
|
- `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.
|
|
2314
2314
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
2315
2315
|
|
|
2316
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the logs for the specified
|
|
2316
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the logs for the specified logic run ID.
|
|
2317
2317
|
|
|
2318
2318
|
### createLedger
|
|
2319
2319
|
|
|
2320
|
-
[src/Particle.js:2310-2318](https://github.com/particle-iot/particle-api-js/blob/
|
|
2320
|
+
[src/Particle.js:2310-2318](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2310-L2318 "Source code on GitHub")
|
|
2321
2321
|
|
|
2322
2322
|
Creates a new ledger definition in the specified organization.
|
|
2323
2323
|
|
|
@@ -2335,7 +2335,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2335
2335
|
|
|
2336
2336
|
### getLedger
|
|
2337
2337
|
|
|
2338
|
-
[src/Particle.js:2332-2339](https://github.com/particle-iot/particle-api-js/blob/
|
|
2338
|
+
[src/Particle.js:2332-2339](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2332-L2339 "Source code on GitHub")
|
|
2339
2339
|
|
|
2340
2340
|
Get a ledger definition in the specified organization by ledger name.
|
|
2341
2341
|
|
|
@@ -2352,7 +2352,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2352
2352
|
|
|
2353
2353
|
### updateLedger
|
|
2354
2354
|
|
|
2355
|
-
[src/Particle.js:2354-2362](https://github.com/particle-iot/particle-api-js/blob/
|
|
2355
|
+
[src/Particle.js:2354-2362](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2354-L2362 "Source code on GitHub")
|
|
2356
2356
|
|
|
2357
2357
|
Updates an existing ledger definition in the specified organization.
|
|
2358
2358
|
|
|
@@ -2370,7 +2370,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2370
2370
|
|
|
2371
2371
|
### archiveLedger
|
|
2372
2372
|
|
|
2373
|
-
[src/Particle.js:2376-2383](https://github.com/particle-iot/particle-api-js/blob/
|
|
2373
|
+
[src/Particle.js:2376-2383](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2376-L2383 "Source code on GitHub")
|
|
2374
2374
|
|
|
2375
2375
|
Archives a ledger definition in the specified organization by ledger name.
|
|
2376
2376
|
|
|
@@ -2387,7 +2387,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2387
2387
|
|
|
2388
2388
|
### listLedgers
|
|
2389
2389
|
|
|
2390
|
-
[src/Particle.js:2396-2403](https://github.com/particle-iot/particle-api-js/blob/
|
|
2390
|
+
[src/Particle.js:2396-2403](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2396-L2403 "Source code on GitHub")
|
|
2391
2391
|
|
|
2392
2392
|
Lists all ledger definitions in the specified organization.
|
|
2393
2393
|
|
|
@@ -2403,7 +2403,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2403
2403
|
|
|
2404
2404
|
### getLedgerInstance
|
|
2405
2405
|
|
|
2406
|
-
[src/Particle.js:2418-2425](https://github.com/particle-iot/particle-api-js/blob/
|
|
2406
|
+
[src/Particle.js:2418-2425](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2418-L2425 "Source code on GitHub")
|
|
2407
2407
|
|
|
2408
2408
|
Get ledger instance data.
|
|
2409
2409
|
|
|
@@ -2421,7 +2421,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2421
2421
|
|
|
2422
2422
|
### setLedgerInstance
|
|
2423
2423
|
|
|
2424
|
-
[src/Particle.js:2442-2450](https://github.com/particle-iot/particle-api-js/blob/
|
|
2424
|
+
[src/Particle.js:2442-2450](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2442-L2450 "Source code on GitHub")
|
|
2425
2425
|
|
|
2426
2426
|
Set ledger instance data.
|
|
2427
2427
|
|
|
@@ -2441,7 +2441,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2441
2441
|
|
|
2442
2442
|
### deleteLedgerInstance
|
|
2443
2443
|
|
|
2444
|
-
[src/Particle.js:2465-2472](https://github.com/particle-iot/particle-api-js/blob/
|
|
2444
|
+
[src/Particle.js:2465-2472](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2465-L2472 "Source code on GitHub")
|
|
2445
2445
|
|
|
2446
2446
|
Delete a ledger instance in the specified organization by ledger name.
|
|
2447
2447
|
|
|
@@ -2459,7 +2459,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2459
2459
|
|
|
2460
2460
|
### listLedgerInstances
|
|
2461
2461
|
|
|
2462
|
-
[src/Particle.js:2486-2493](https://github.com/particle-iot/particle-api-js/blob/
|
|
2462
|
+
[src/Particle.js:2486-2493](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2486-L2493 "Source code on GitHub")
|
|
2463
2463
|
|
|
2464
2464
|
Lists ledger instances.
|
|
2465
2465
|
|
|
@@ -2476,7 +2476,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2476
2476
|
|
|
2477
2477
|
### setDefaultAuth
|
|
2478
2478
|
|
|
2479
|
-
[src/Particle.js:2500-2506](https://github.com/particle-iot/particle-api-js/blob/
|
|
2479
|
+
[src/Particle.js:2500-2506](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2500-L2506 "Source code on GitHub")
|
|
2480
2480
|
|
|
2481
2481
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
2482
2482
|
|
|
@@ -2489,7 +2489,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
2489
2489
|
|
|
2490
2490
|
### get
|
|
2491
2491
|
|
|
2492
|
-
[src/Particle.js:2538-2542](https://github.com/particle-iot/particle-api-js/blob/
|
|
2492
|
+
[src/Particle.js:2538-2542](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2538-L2542 "Source code on GitHub")
|
|
2493
2493
|
|
|
2494
2494
|
Make a GET request
|
|
2495
2495
|
|
|
@@ -2506,7 +2506,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2506
2506
|
|
|
2507
2507
|
### head
|
|
2508
2508
|
|
|
2509
|
-
[src/Particle.js:2554-2558](https://github.com/particle-iot/particle-api-js/blob/
|
|
2509
|
+
[src/Particle.js:2554-2558](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2554-L2558 "Source code on GitHub")
|
|
2510
2510
|
|
|
2511
2511
|
Make a HEAD request
|
|
2512
2512
|
|
|
@@ -2523,7 +2523,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2523
2523
|
|
|
2524
2524
|
### post
|
|
2525
2525
|
|
|
2526
|
-
[src/Particle.js:2570-2574](https://github.com/particle-iot/particle-api-js/blob/
|
|
2526
|
+
[src/Particle.js:2570-2574](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2570-L2574 "Source code on GitHub")
|
|
2527
2527
|
|
|
2528
2528
|
Make a POST request
|
|
2529
2529
|
|
|
@@ -2540,7 +2540,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2540
2540
|
|
|
2541
2541
|
### put
|
|
2542
2542
|
|
|
2543
|
-
[src/Particle.js:2586-2590](https://github.com/particle-iot/particle-api-js/blob/
|
|
2543
|
+
[src/Particle.js:2586-2590](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2586-L2590 "Source code on GitHub")
|
|
2544
2544
|
|
|
2545
2545
|
Make a PUT request
|
|
2546
2546
|
|
|
@@ -2557,7 +2557,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2557
2557
|
|
|
2558
2558
|
### delete
|
|
2559
2559
|
|
|
2560
|
-
[src/Particle.js:2602-2606](https://github.com/particle-iot/particle-api-js/blob/
|
|
2560
|
+
[src/Particle.js:2602-2606](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2602-L2606 "Source code on GitHub")
|
|
2561
2561
|
|
|
2562
2562
|
Make a DELETE request
|
|
2563
2563
|
|
|
@@ -2574,7 +2574,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2574
2574
|
|
|
2575
2575
|
### request
|
|
2576
2576
|
|
|
2577
|
-
[src/Particle.js:2623-2627](https://github.com/particle-iot/particle-api-js/blob/
|
|
2577
|
+
[src/Particle.js:2623-2627](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2623-L2627 "Source code on GitHub")
|
|
2578
2578
|
|
|
2579
2579
|
**Parameters**
|
|
2580
2580
|
|
|
@@ -2594,7 +2594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2594
2594
|
|
|
2595
2595
|
## Particle
|
|
2596
2596
|
|
|
2597
|
-
[src/Particle.js:23-2639](https://github.com/particle-iot/particle-api-js/blob/
|
|
2597
|
+
[src/Particle.js:23-2639](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L23-L2639 "Source code on GitHub")
|
|
2598
2598
|
|
|
2599
2599
|
**Parameters**
|
|
2600
2600
|
|
|
@@ -2602,7 +2602,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2602
2602
|
|
|
2603
2603
|
### constructor
|
|
2604
2604
|
|
|
2605
|
-
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/
|
|
2605
|
+
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L31-L40 "Source code on GitHub")
|
|
2606
2606
|
|
|
2607
2607
|
Contructor for the Cloud API wrapper.
|
|
2608
2608
|
|
|
@@ -2614,7 +2614,7 @@ Create a new Particle object and call methods below on it.
|
|
|
2614
2614
|
|
|
2615
2615
|
### login
|
|
2616
2616
|
|
|
2617
|
-
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/
|
|
2617
|
+
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L77-L94 "Source code on GitHub")
|
|
2618
2618
|
|
|
2619
2619
|
Login to Particle Cloud using an existing Particle acccount.
|
|
2620
2620
|
|
|
@@ -2631,7 +2631,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2631
2631
|
|
|
2632
2632
|
### sendOtp
|
|
2633
2633
|
|
|
2634
|
-
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/
|
|
2634
|
+
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L105-L121 "Source code on GitHub")
|
|
2635
2635
|
|
|
2636
2636
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
2637
2637
|
|
|
@@ -2647,7 +2647,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2647
2647
|
|
|
2648
2648
|
### enableMfa
|
|
2649
2649
|
|
|
2650
|
-
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/
|
|
2650
|
+
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L131-L133 "Source code on GitHub")
|
|
2651
2651
|
|
|
2652
2652
|
Enable MFA on the currently logged in user
|
|
2653
2653
|
|
|
@@ -2662,7 +2662,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2662
2662
|
|
|
2663
2663
|
### confirmMfa
|
|
2664
2664
|
|
|
2665
|
-
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/
|
|
2665
|
+
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L146-L160 "Source code on GitHub")
|
|
2666
2666
|
|
|
2667
2667
|
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.
|
|
2668
2668
|
|
|
@@ -2680,7 +2680,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2680
2680
|
|
|
2681
2681
|
### disableMfa
|
|
2682
2682
|
|
|
2683
|
-
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/
|
|
2683
|
+
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L171-L179 "Source code on GitHub")
|
|
2684
2684
|
|
|
2685
2685
|
Disable MFA for the user.
|
|
2686
2686
|
|
|
@@ -2696,7 +2696,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2696
2696
|
|
|
2697
2697
|
### createCustomer
|
|
2698
2698
|
|
|
2699
|
-
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/
|
|
2699
|
+
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L191-L207 "Source code on GitHub")
|
|
2700
2700
|
|
|
2701
2701
|
Create Customer for Product.
|
|
2702
2702
|
|
|
@@ -2713,7 +2713,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2713
2713
|
|
|
2714
2714
|
### loginAsClientOwner
|
|
2715
2715
|
|
|
2716
|
-
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/
|
|
2716
|
+
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L216-L230 "Source code on GitHub")
|
|
2717
2717
|
|
|
2718
2718
|
Login to Particle Cloud using an OAuth client.
|
|
2719
2719
|
|
|
@@ -2727,7 +2727,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2727
2727
|
|
|
2728
2728
|
### createUser
|
|
2729
2729
|
|
|
2730
|
-
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/
|
|
2730
|
+
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L242-L253 "Source code on GitHub")
|
|
2731
2731
|
|
|
2732
2732
|
Create a user account for the Particle Cloud
|
|
2733
2733
|
|
|
@@ -2744,7 +2744,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2744
2744
|
|
|
2745
2745
|
### verifyUser
|
|
2746
2746
|
|
|
2747
|
-
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/
|
|
2747
|
+
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L263-L270 "Source code on GitHub")
|
|
2748
2748
|
|
|
2749
2749
|
Verify new user account via verification email
|
|
2750
2750
|
|
|
@@ -2759,7 +2759,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2759
2759
|
|
|
2760
2760
|
### resetPassword
|
|
2761
2761
|
|
|
2762
|
-
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/
|
|
2762
|
+
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L280-L287 "Source code on GitHub")
|
|
2763
2763
|
|
|
2764
2764
|
Send reset password email for a Particle Cloud user account
|
|
2765
2765
|
|
|
@@ -2774,7 +2774,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2774
2774
|
|
|
2775
2775
|
### deleteAccessToken
|
|
2776
2776
|
|
|
2777
|
-
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/
|
|
2777
|
+
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L299-L307 "Source code on GitHub")
|
|
2778
2778
|
|
|
2779
2779
|
Revoke an access token
|
|
2780
2780
|
|
|
@@ -2791,7 +2791,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2791
2791
|
|
|
2792
2792
|
### deleteCurrentAccessToken
|
|
2793
2793
|
|
|
2794
|
-
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/
|
|
2794
|
+
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L317-L324 "Source code on GitHub")
|
|
2795
2795
|
|
|
2796
2796
|
Revoke the current session access token
|
|
2797
2797
|
|
|
@@ -2806,7 +2806,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2806
2806
|
|
|
2807
2807
|
### deleteActiveAccessTokens
|
|
2808
2808
|
|
|
2809
|
-
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/
|
|
2809
|
+
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L334-L341 "Source code on GitHub")
|
|
2810
2810
|
|
|
2811
2811
|
Revoke all active access tokens
|
|
2812
2812
|
|
|
@@ -2821,7 +2821,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2821
2821
|
|
|
2822
2822
|
### deleteUser
|
|
2823
2823
|
|
|
2824
|
-
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/
|
|
2824
|
+
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L352-L360 "Source code on GitHub")
|
|
2825
2825
|
|
|
2826
2826
|
Delete the current user
|
|
2827
2827
|
|
|
@@ -2837,7 +2837,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2837
2837
|
|
|
2838
2838
|
### listAccessTokens
|
|
2839
2839
|
|
|
2840
|
-
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/
|
|
2840
|
+
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L372-L380 "Source code on GitHub")
|
|
2841
2841
|
|
|
2842
2842
|
List all valid access tokens for a Particle Cloud account
|
|
2843
2843
|
|
|
@@ -2854,7 +2854,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2854
2854
|
|
|
2855
2855
|
### trackingIdentity
|
|
2856
2856
|
|
|
2857
|
-
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/
|
|
2857
|
+
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L392-L400 "Source code on GitHub")
|
|
2858
2858
|
|
|
2859
2859
|
Retrieves the information that is used to identify the current login for tracking.
|
|
2860
2860
|
|
|
@@ -2871,7 +2871,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2871
2871
|
|
|
2872
2872
|
### listDevices
|
|
2873
2873
|
|
|
2874
|
-
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/
|
|
2874
|
+
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L418-L437 "Source code on GitHub")
|
|
2875
2875
|
|
|
2876
2876
|
List devices claimed to the account or product
|
|
2877
2877
|
|
|
@@ -2894,7 +2894,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2894
2894
|
|
|
2895
2895
|
### getDevice
|
|
2896
2896
|
|
|
2897
|
-
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/
|
|
2897
|
+
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L449-L452 "Source code on GitHub")
|
|
2898
2898
|
|
|
2899
2899
|
Get detailed informationa about a device
|
|
2900
2900
|
|
|
@@ -2911,7 +2911,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2911
2911
|
|
|
2912
2912
|
### claimDevice
|
|
2913
2913
|
|
|
2914
|
-
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/
|
|
2914
|
+
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L464-L475 "Source code on GitHub")
|
|
2915
2915
|
|
|
2916
2916
|
Claim a device to the account. The device must be online and unclaimed.
|
|
2917
2917
|
|
|
@@ -2928,7 +2928,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2928
2928
|
|
|
2929
2929
|
### addDeviceToProduct
|
|
2930
2930
|
|
|
2931
|
-
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/
|
|
2931
|
+
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L489-L507 "Source code on GitHub")
|
|
2932
2932
|
|
|
2933
2933
|
Add a device to a product or move device out of quarantine.
|
|
2934
2934
|
|
|
@@ -2947,7 +2947,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2947
2947
|
|
|
2948
2948
|
### removeDevice
|
|
2949
2949
|
|
|
2950
|
-
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/
|
|
2950
|
+
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L520-L524 "Source code on GitHub")
|
|
2951
2951
|
|
|
2952
2952
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
2953
2953
|
|
|
@@ -2965,7 +2965,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2965
2965
|
|
|
2966
2966
|
### removeDeviceOwner
|
|
2967
2967
|
|
|
2968
|
-
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/
|
|
2968
|
+
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L536-L539 "Source code on GitHub")
|
|
2969
2969
|
|
|
2970
2970
|
Unclaim a product device its the owner, but keep it in the product
|
|
2971
2971
|
|
|
@@ -2982,7 +2982,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
2982
2982
|
|
|
2983
2983
|
### renameDevice
|
|
2984
2984
|
|
|
2985
|
-
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/
|
|
2985
|
+
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L552-L554 "Source code on GitHub")
|
|
2986
2986
|
|
|
2987
2987
|
Rename a device
|
|
2988
2988
|
|
|
@@ -3000,7 +3000,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3000
3000
|
|
|
3001
3001
|
### signalDevice
|
|
3002
3002
|
|
|
3003
|
-
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/
|
|
3003
|
+
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L567-L569 "Source code on GitHub")
|
|
3004
3004
|
|
|
3005
3005
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
3006
3006
|
|
|
@@ -3018,7 +3018,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3018
3018
|
|
|
3019
3019
|
### setDeviceNotes
|
|
3020
3020
|
|
|
3021
|
-
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/
|
|
3021
|
+
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L582-L584 "Source code on GitHub")
|
|
3022
3022
|
|
|
3023
3023
|
Store some notes about device
|
|
3024
3024
|
|
|
@@ -3036,7 +3036,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3036
3036
|
|
|
3037
3037
|
### markAsDevelopmentDevice
|
|
3038
3038
|
|
|
3039
|
-
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/
|
|
3039
|
+
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L597-L599 "Source code on GitHub")
|
|
3040
3040
|
|
|
3041
3041
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
3042
3042
|
|
|
@@ -3054,7 +3054,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3054
3054
|
|
|
3055
3055
|
### lockDeviceProductFirmware
|
|
3056
3056
|
|
|
3057
|
-
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/
|
|
3057
|
+
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L613-L615 "Source code on GitHub")
|
|
3058
3058
|
|
|
3059
3059
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
3060
3060
|
|
|
@@ -3073,7 +3073,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3073
3073
|
|
|
3074
3074
|
### unlockDeviceProductFirmware
|
|
3075
3075
|
|
|
3076
|
-
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/
|
|
3076
|
+
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L627-L629 "Source code on GitHub")
|
|
3077
3077
|
|
|
3078
3078
|
Mark device as receiving automatic firmware updates
|
|
3079
3079
|
|
|
@@ -3090,7 +3090,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3090
3090
|
|
|
3091
3091
|
### updateDevice
|
|
3092
3092
|
|
|
3093
|
-
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/
|
|
3093
|
+
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L648-L660 "Source code on GitHub")
|
|
3094
3094
|
|
|
3095
3095
|
Update multiple device attributes at the same time
|
|
3096
3096
|
|
|
@@ -3114,7 +3114,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3114
3114
|
|
|
3115
3115
|
### provisionDevice
|
|
3116
3116
|
|
|
3117
|
-
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/
|
|
3117
|
+
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L671-L679 "Source code on GitHub")
|
|
3118
3118
|
|
|
3119
3119
|
Provision a new device for products that allow self-provisioning
|
|
3120
3120
|
|
|
@@ -3130,7 +3130,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3130
3130
|
|
|
3131
3131
|
### getClaimCode
|
|
3132
3132
|
|
|
3133
|
-
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/
|
|
3133
|
+
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L693-L696 "Source code on GitHub")
|
|
3134
3134
|
|
|
3135
3135
|
Generate a claim code to use in the device claiming process.
|
|
3136
3136
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -3149,7 +3149,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3149
3149
|
|
|
3150
3150
|
### getVariable
|
|
3151
3151
|
|
|
3152
|
-
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/
|
|
3152
|
+
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L728-L734 "Source code on GitHub")
|
|
3153
3153
|
|
|
3154
3154
|
Get the value of a device variable
|
|
3155
3155
|
|
|
@@ -3167,7 +3167,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3167
3167
|
|
|
3168
3168
|
### flashDevice
|
|
3169
3169
|
|
|
3170
|
-
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
3170
|
+
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L748-L759 "Source code on GitHub")
|
|
3171
3171
|
|
|
3172
3172
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
3173
3173
|
|
|
@@ -3186,7 +3186,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3186
3186
|
|
|
3187
3187
|
### flashTinker
|
|
3188
3188
|
|
|
3189
|
-
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/
|
|
3189
|
+
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L770-L785 "Source code on GitHub")
|
|
3190
3190
|
|
|
3191
3191
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
3192
3192
|
|
|
@@ -3202,7 +3202,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3202
3202
|
|
|
3203
3203
|
### compileCode
|
|
3204
3204
|
|
|
3205
|
-
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/
|
|
3205
|
+
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L798-L816 "Source code on GitHub")
|
|
3206
3206
|
|
|
3207
3207
|
Compile firmware using the Particle Cloud
|
|
3208
3208
|
|
|
@@ -3220,7 +3220,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3220
3220
|
|
|
3221
3221
|
### downloadFirmwareBinary
|
|
3222
3222
|
|
|
3223
|
-
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/
|
|
3223
|
+
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L827-L836 "Source code on GitHub")
|
|
3224
3224
|
|
|
3225
3225
|
Download a firmware binary
|
|
3226
3226
|
|
|
@@ -3236,7 +3236,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3236
3236
|
|
|
3237
3237
|
### sendPublicKey
|
|
3238
3238
|
|
|
3239
|
-
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/
|
|
3239
|
+
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L849-L863 "Source code on GitHub")
|
|
3240
3240
|
|
|
3241
3241
|
Send a new device public key to the Particle Cloud
|
|
3242
3242
|
|
|
@@ -3254,7 +3254,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3254
3254
|
|
|
3255
3255
|
### callFunction
|
|
3256
3256
|
|
|
3257
|
-
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/
|
|
3257
|
+
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L877-L882 "Source code on GitHub")
|
|
3258
3258
|
|
|
3259
3259
|
Call a device function
|
|
3260
3260
|
|
|
@@ -3273,7 +3273,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3273
3273
|
|
|
3274
3274
|
### getEventStream
|
|
3275
3275
|
|
|
3276
|
-
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/
|
|
3276
|
+
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L895-L920 "Source code on GitHub")
|
|
3277
3277
|
|
|
3278
3278
|
Get a stream of events
|
|
3279
3279
|
|
|
@@ -3291,7 +3291,7 @@ emit 'event' events.
|
|
|
3291
3291
|
|
|
3292
3292
|
### publishEvent
|
|
3293
3293
|
|
|
3294
|
-
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/
|
|
3294
|
+
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L934-L938 "Source code on GitHub")
|
|
3295
3295
|
|
|
3296
3296
|
Publish a event to the Particle Cloud
|
|
3297
3297
|
|
|
@@ -3310,7 +3310,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3310
3310
|
|
|
3311
3311
|
### createWebhook
|
|
3312
3312
|
|
|
3313
|
-
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/
|
|
3313
|
+
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L965-L987 "Source code on GitHub")
|
|
3314
3314
|
|
|
3315
3315
|
Create a webhook
|
|
3316
3316
|
|
|
@@ -3342,7 +3342,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3342
3342
|
|
|
3343
3343
|
### deleteWebhook
|
|
3344
3344
|
|
|
3345
|
-
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/
|
|
3345
|
+
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L999-L1002 "Source code on GitHub")
|
|
3346
3346
|
|
|
3347
3347
|
Delete a webhook
|
|
3348
3348
|
|
|
@@ -3359,7 +3359,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3359
3359
|
|
|
3360
3360
|
### listWebhooks
|
|
3361
3361
|
|
|
3362
|
-
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
3362
|
+
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1013-L1016 "Source code on GitHub")
|
|
3363
3363
|
|
|
3364
3364
|
List all webhooks owned by the account or product
|
|
3365
3365
|
|
|
@@ -3375,7 +3375,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3375
3375
|
|
|
3376
3376
|
### createIntegration
|
|
3377
3377
|
|
|
3378
|
-
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/
|
|
3378
|
+
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1033-L1037 "Source code on GitHub")
|
|
3379
3379
|
|
|
3380
3380
|
Create an integration to send events to an external service
|
|
3381
3381
|
|
|
@@ -3396,7 +3396,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3396
3396
|
|
|
3397
3397
|
### editIntegration
|
|
3398
3398
|
|
|
3399
|
-
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/
|
|
3399
|
+
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1055-L1059 "Source code on GitHub")
|
|
3400
3400
|
|
|
3401
3401
|
Edit an integration to send events to an external service
|
|
3402
3402
|
|
|
@@ -3418,7 +3418,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3418
3418
|
|
|
3419
3419
|
### deleteIntegration
|
|
3420
3420
|
|
|
3421
|
-
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/
|
|
3421
|
+
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1072-L1075 "Source code on GitHub")
|
|
3422
3422
|
|
|
3423
3423
|
Delete an integration to send events to an external service
|
|
3424
3424
|
|
|
@@ -3435,7 +3435,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3435
3435
|
|
|
3436
3436
|
### listIntegrations
|
|
3437
3437
|
|
|
3438
|
-
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/
|
|
3438
|
+
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1086-L1089 "Source code on GitHub")
|
|
3439
3439
|
|
|
3440
3440
|
List all integrations owned by the account or product
|
|
3441
3441
|
|
|
@@ -3451,7 +3451,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3451
3451
|
|
|
3452
3452
|
### getUserInfo
|
|
3453
3453
|
|
|
3454
|
-
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
3454
|
+
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1099-L1101 "Source code on GitHub")
|
|
3455
3455
|
|
|
3456
3456
|
Get details about the current user
|
|
3457
3457
|
|
|
@@ -3466,7 +3466,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3466
3466
|
|
|
3467
3467
|
### setUserInfo
|
|
3468
3468
|
|
|
3469
|
-
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/
|
|
3469
|
+
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1112-L1115 "Source code on GitHub")
|
|
3470
3470
|
|
|
3471
3471
|
Set details on the current user
|
|
3472
3472
|
|
|
@@ -3482,7 +3482,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3482
3482
|
|
|
3483
3483
|
### changeUsername
|
|
3484
3484
|
|
|
3485
|
-
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/
|
|
3485
|
+
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1128-L1136 "Source code on GitHub")
|
|
3486
3486
|
|
|
3487
3487
|
Change username (i.e, email)
|
|
3488
3488
|
|
|
@@ -3500,7 +3500,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3500
3500
|
|
|
3501
3501
|
### changeUserPassword
|
|
3502
3502
|
|
|
3503
|
-
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/
|
|
3503
|
+
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1149-L1157 "Source code on GitHub")
|
|
3504
3504
|
|
|
3505
3505
|
Change user's password
|
|
3506
3506
|
|
|
@@ -3518,7 +3518,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3518
3518
|
|
|
3519
3519
|
### listSIMs
|
|
3520
3520
|
|
|
3521
|
-
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/
|
|
3521
|
+
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1173-L1177 "Source code on GitHub")
|
|
3522
3522
|
|
|
3523
3523
|
List SIM cards owned by a user or product
|
|
3524
3524
|
|
|
@@ -3539,7 +3539,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3539
3539
|
|
|
3540
3540
|
### getSIMDataUsage
|
|
3541
3541
|
|
|
3542
|
-
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/
|
|
3542
|
+
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1189-L1195 "Source code on GitHub")
|
|
3543
3543
|
|
|
3544
3544
|
Get data usage for one SIM card for the current billing period
|
|
3545
3545
|
|
|
@@ -3556,7 +3556,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3556
3556
|
|
|
3557
3557
|
### getFleetDataUsage
|
|
3558
3558
|
|
|
3559
|
-
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/
|
|
3559
|
+
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1206-L1213 "Source code on GitHub")
|
|
3560
3560
|
|
|
3561
3561
|
Get data usage for all SIM cards in a product the current billing period
|
|
3562
3562
|
|
|
@@ -3572,7 +3572,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3572
3572
|
|
|
3573
3573
|
### checkSIM
|
|
3574
3574
|
|
|
3575
|
-
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/
|
|
3575
|
+
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1224-L1226 "Source code on GitHub")
|
|
3576
3576
|
|
|
3577
3577
|
Check SIM status
|
|
3578
3578
|
|
|
@@ -3588,7 +3588,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3588
3588
|
|
|
3589
3589
|
### activateSIM
|
|
3590
3590
|
|
|
3591
|
-
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/
|
|
3591
|
+
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1241-L1251 "Source code on GitHub")
|
|
3592
3592
|
|
|
3593
3593
|
Activate and add SIM cards to an account or product
|
|
3594
3594
|
|
|
@@ -3608,7 +3608,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3608
3608
|
|
|
3609
3609
|
### deactivateSIM
|
|
3610
3610
|
|
|
3611
|
-
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/
|
|
3611
|
+
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1263-L1267 "Source code on GitHub")
|
|
3612
3612
|
|
|
3613
3613
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
3614
3614
|
|
|
@@ -3625,7 +3625,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3625
3625
|
|
|
3626
3626
|
### reactivateSIM
|
|
3627
3627
|
|
|
3628
|
-
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/
|
|
3628
|
+
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1280-L1284 "Source code on GitHub")
|
|
3629
3629
|
|
|
3630
3630
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
3631
3631
|
|
|
@@ -3643,7 +3643,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3643
3643
|
|
|
3644
3644
|
### updateSIM
|
|
3645
3645
|
|
|
3646
|
-
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/
|
|
3646
|
+
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1297-L1301 "Source code on GitHub")
|
|
3647
3647
|
|
|
3648
3648
|
Update SIM card data limit
|
|
3649
3649
|
|
|
@@ -3661,7 +3661,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3661
3661
|
|
|
3662
3662
|
### removeSIM
|
|
3663
3663
|
|
|
3664
|
-
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/
|
|
3664
|
+
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1313-L1316 "Source code on GitHub")
|
|
3665
3665
|
|
|
3666
3666
|
Remove a SIM card from an account so it can be activated by a different account
|
|
3667
3667
|
|
|
@@ -3678,7 +3678,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3678
3678
|
|
|
3679
3679
|
### listBuildTargets
|
|
3680
3680
|
|
|
3681
|
-
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/
|
|
3681
|
+
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1327-L1330 "Source code on GitHub")
|
|
3682
3682
|
|
|
3683
3683
|
List valid build targets to be used for compiling
|
|
3684
3684
|
|
|
@@ -3694,7 +3694,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3694
3694
|
|
|
3695
3695
|
### listLibraries
|
|
3696
3696
|
|
|
3697
|
-
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/
|
|
3697
|
+
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1356-L1373 "Source code on GitHub")
|
|
3698
3698
|
|
|
3699
3699
|
List firmware libraries
|
|
3700
3700
|
|
|
@@ -3723,7 +3723,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3723
3723
|
|
|
3724
3724
|
### getLibrary
|
|
3725
3725
|
|
|
3726
|
-
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/
|
|
3726
|
+
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1389-L1397 "Source code on GitHub")
|
|
3727
3727
|
|
|
3728
3728
|
Get firmware library details
|
|
3729
3729
|
|
|
@@ -3740,7 +3740,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3740
3740
|
|
|
3741
3741
|
### getLibraryVersions
|
|
3742
3742
|
|
|
3743
|
-
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/
|
|
3743
|
+
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1410-L1418 "Source code on GitHub")
|
|
3744
3744
|
|
|
3745
3745
|
Firmware library details for each version
|
|
3746
3746
|
|
|
@@ -3758,7 +3758,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3758
3758
|
|
|
3759
3759
|
### contributeLibrary
|
|
3760
3760
|
|
|
3761
|
-
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/
|
|
3761
|
+
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1430-L1443 "Source code on GitHub")
|
|
3762
3762
|
|
|
3763
3763
|
Contribute a new library version from a compressed archive
|
|
3764
3764
|
|
|
@@ -3775,7 +3775,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3775
3775
|
|
|
3776
3776
|
### publishLibrary
|
|
3777
3777
|
|
|
3778
|
-
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/
|
|
3778
|
+
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1454-L1463 "Source code on GitHub")
|
|
3779
3779
|
|
|
3780
3780
|
Publish the latest version of a library to the public
|
|
3781
3781
|
|
|
@@ -3791,7 +3791,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3791
3791
|
|
|
3792
3792
|
### deleteLibrary
|
|
3793
3793
|
|
|
3794
|
-
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/
|
|
3794
|
+
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1475-L1483 "Source code on GitHub")
|
|
3795
3795
|
|
|
3796
3796
|
Delete one version of a library or an entire private library
|
|
3797
3797
|
|
|
@@ -3808,7 +3808,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3808
3808
|
|
|
3809
3809
|
### downloadFile
|
|
3810
3810
|
|
|
3811
|
-
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
3811
|
+
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1493-L1495 "Source code on GitHub")
|
|
3812
3812
|
|
|
3813
3813
|
Download an external file that may not be on the API
|
|
3814
3814
|
|
|
@@ -3823,7 +3823,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3823
3823
|
|
|
3824
3824
|
### listOAuthClients
|
|
3825
3825
|
|
|
3826
|
-
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/
|
|
3826
|
+
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1506-L1509 "Source code on GitHub")
|
|
3827
3827
|
|
|
3828
3828
|
List OAuth client created by the account
|
|
3829
3829
|
|
|
@@ -3839,7 +3839,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3839
3839
|
|
|
3840
3840
|
### createOAuthClient
|
|
3841
3841
|
|
|
3842
|
-
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/
|
|
3842
|
+
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1524-L1528 "Source code on GitHub")
|
|
3843
3843
|
|
|
3844
3844
|
Create an OAuth client
|
|
3845
3845
|
|
|
@@ -3859,7 +3859,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3859
3859
|
|
|
3860
3860
|
### updateOAuthClient
|
|
3861
3861
|
|
|
3862
|
-
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/
|
|
3862
|
+
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1542-L1546 "Source code on GitHub")
|
|
3863
3863
|
|
|
3864
3864
|
Update an OAuth client
|
|
3865
3865
|
|
|
@@ -3878,7 +3878,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3878
3878
|
|
|
3879
3879
|
### deleteOAuthClient
|
|
3880
3880
|
|
|
3881
|
-
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/
|
|
3881
|
+
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1558-L1561 "Source code on GitHub")
|
|
3882
3882
|
|
|
3883
3883
|
Delete an OAuth client
|
|
3884
3884
|
|
|
@@ -3895,7 +3895,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3895
3895
|
|
|
3896
3896
|
### listProducts
|
|
3897
3897
|
|
|
3898
|
-
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
3898
|
+
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1571-L1573 "Source code on GitHub")
|
|
3899
3899
|
|
|
3900
3900
|
List products the account has access to
|
|
3901
3901
|
|
|
@@ -3910,7 +3910,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3910
3910
|
|
|
3911
3911
|
### getProduct
|
|
3912
3912
|
|
|
3913
|
-
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/
|
|
3913
|
+
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1584-L1586 "Source code on GitHub")
|
|
3914
3914
|
|
|
3915
3915
|
Get detailed information about a product
|
|
3916
3916
|
|
|
@@ -3926,7 +3926,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3926
3926
|
|
|
3927
3927
|
### listProductFirmware
|
|
3928
3928
|
|
|
3929
|
-
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/
|
|
3929
|
+
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1597-L1599 "Source code on GitHub")
|
|
3930
3930
|
|
|
3931
3931
|
List product firmware versions
|
|
3932
3932
|
|
|
@@ -3942,7 +3942,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3942
3942
|
|
|
3943
3943
|
### uploadProductFirmware
|
|
3944
3944
|
|
|
3945
|
-
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/
|
|
3945
|
+
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1615-L1631 "Source code on GitHub")
|
|
3946
3946
|
|
|
3947
3947
|
List product firmware versions
|
|
3948
3948
|
|
|
@@ -3963,7 +3963,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3963
3963
|
|
|
3964
3964
|
### getProductFirmware
|
|
3965
3965
|
|
|
3966
|
-
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/
|
|
3966
|
+
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1643-L1650 "Source code on GitHub")
|
|
3967
3967
|
|
|
3968
3968
|
Get information about a product firmware version
|
|
3969
3969
|
|
|
@@ -3980,7 +3980,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3980
3980
|
|
|
3981
3981
|
### updateProductFirmware
|
|
3982
3982
|
|
|
3983
|
-
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/
|
|
3983
|
+
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1664-L1667 "Source code on GitHub")
|
|
3984
3984
|
|
|
3985
3985
|
Update information for a product firmware version
|
|
3986
3986
|
|
|
@@ -3999,7 +3999,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
3999
3999
|
|
|
4000
4000
|
### downloadProductFirmware
|
|
4001
4001
|
|
|
4002
|
-
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/
|
|
4002
|
+
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1679-L1688 "Source code on GitHub")
|
|
4003
4003
|
|
|
4004
4004
|
Download a product firmware binary
|
|
4005
4005
|
|
|
@@ -4016,7 +4016,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4016
4016
|
|
|
4017
4017
|
### releaseProductFirmware
|
|
4018
4018
|
|
|
4019
|
-
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/
|
|
4019
|
+
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1700-L1703 "Source code on GitHub")
|
|
4020
4020
|
|
|
4021
4021
|
Release a product firmware version as the default version
|
|
4022
4022
|
|
|
@@ -4033,7 +4033,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4033
4033
|
|
|
4034
4034
|
### listTeamMembers
|
|
4035
4035
|
|
|
4036
|
-
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/
|
|
4036
|
+
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1714-L1721 "Source code on GitHub")
|
|
4037
4037
|
|
|
4038
4038
|
List product team members
|
|
4039
4039
|
|
|
@@ -4049,7 +4049,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4049
4049
|
|
|
4050
4050
|
### inviteTeamMember
|
|
4051
4051
|
|
|
4052
|
-
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/
|
|
4052
|
+
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1733-L1741 "Source code on GitHub")
|
|
4053
4053
|
|
|
4054
4054
|
Invite Particle user to a product team
|
|
4055
4055
|
|
|
@@ -4066,7 +4066,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4066
4066
|
|
|
4067
4067
|
### removeTeamMember
|
|
4068
4068
|
|
|
4069
|
-
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/
|
|
4069
|
+
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1753-L1760 "Source code on GitHub")
|
|
4070
4070
|
|
|
4071
4071
|
Remove Particle user to a product team
|
|
4072
4072
|
|
|
@@ -4083,7 +4083,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4083
4083
|
|
|
4084
4084
|
### lookupSerialNumber
|
|
4085
4085
|
|
|
4086
|
-
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/
|
|
4086
|
+
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1771-L1778 "Source code on GitHub")
|
|
4087
4087
|
|
|
4088
4088
|
Fetch details about a serial number
|
|
4089
4089
|
|
|
@@ -4099,7 +4099,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4099
4099
|
|
|
4100
4100
|
### createMeshNetwork
|
|
4101
4101
|
|
|
4102
|
-
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/
|
|
4102
|
+
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1791-L1799 "Source code on GitHub")
|
|
4103
4103
|
|
|
4104
4104
|
Create a mesh network
|
|
4105
4105
|
|
|
@@ -4117,7 +4117,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4117
4117
|
|
|
4118
4118
|
### removeMeshNetwork
|
|
4119
4119
|
|
|
4120
|
-
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/
|
|
4120
|
+
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1810-L1812 "Source code on GitHub")
|
|
4121
4121
|
|
|
4122
4122
|
Remove a mesh network.
|
|
4123
4123
|
|
|
@@ -4133,7 +4133,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4133
4133
|
|
|
4134
4134
|
### listMeshNetworks
|
|
4135
4135
|
|
|
4136
|
-
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/
|
|
4136
|
+
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1824-L1827 "Source code on GitHub")
|
|
4137
4137
|
|
|
4138
4138
|
List all mesh networks
|
|
4139
4139
|
|
|
@@ -4150,7 +4150,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4150
4150
|
|
|
4151
4151
|
### getMeshNetwork
|
|
4152
4152
|
|
|
4153
|
-
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/
|
|
4153
|
+
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1838-L1840 "Source code on GitHub")
|
|
4154
4154
|
|
|
4155
4155
|
Get information about a mesh network.
|
|
4156
4156
|
|
|
@@ -4166,7 +4166,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4166
4166
|
|
|
4167
4167
|
### updateMeshNetwork
|
|
4168
4168
|
|
|
4169
|
-
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/
|
|
4169
|
+
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1853-L1861 "Source code on GitHub")
|
|
4170
4170
|
|
|
4171
4171
|
Modify a mesh network.
|
|
4172
4172
|
|
|
@@ -4184,7 +4184,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4184
4184
|
|
|
4185
4185
|
### addMeshNetworkDevice
|
|
4186
4186
|
|
|
4187
|
-
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/
|
|
4187
|
+
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1873-L1882 "Source code on GitHub")
|
|
4188
4188
|
|
|
4189
4189
|
Add a device to a mesh network.
|
|
4190
4190
|
|
|
@@ -4201,7 +4201,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4201
4201
|
|
|
4202
4202
|
### removeMeshNetworkDevice
|
|
4203
4203
|
|
|
4204
|
-
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/
|
|
4204
|
+
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1894-L1910 "Source code on GitHub")
|
|
4205
4205
|
|
|
4206
4206
|
Remove a device from a mesh network.
|
|
4207
4207
|
|
|
@@ -4218,7 +4218,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4218
4218
|
|
|
4219
4219
|
### listMeshNetworkDevices
|
|
4220
4220
|
|
|
4221
|
-
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/
|
|
4221
|
+
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1924-L1933 "Source code on GitHub")
|
|
4222
4222
|
|
|
4223
4223
|
List all devices of a mesh network.
|
|
4224
4224
|
|
|
@@ -4237,7 +4237,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4237
4237
|
|
|
4238
4238
|
### getProductConfiguration
|
|
4239
4239
|
|
|
4240
|
-
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/
|
|
4240
|
+
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1944-L1951 "Source code on GitHub")
|
|
4241
4241
|
|
|
4242
4242
|
Get product configuration
|
|
4243
4243
|
|
|
@@ -4253,7 +4253,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4253
4253
|
|
|
4254
4254
|
### getProductConfigurationSchema
|
|
4255
4255
|
|
|
4256
|
-
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/
|
|
4256
|
+
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1962-L1970 "Source code on GitHub")
|
|
4257
4257
|
|
|
4258
4258
|
Get product configuration schema
|
|
4259
4259
|
|
|
@@ -4269,7 +4269,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4269
4269
|
|
|
4270
4270
|
### getProductDeviceConfiguration
|
|
4271
4271
|
|
|
4272
|
-
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/
|
|
4272
|
+
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1982-L1989 "Source code on GitHub")
|
|
4273
4273
|
|
|
4274
4274
|
Get product device's configuration
|
|
4275
4275
|
|
|
@@ -4286,7 +4286,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4286
4286
|
|
|
4287
4287
|
### getProductDeviceConfigurationSchema
|
|
4288
4288
|
|
|
4289
|
-
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/
|
|
4289
|
+
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2001-L2009 "Source code on GitHub")
|
|
4290
4290
|
|
|
4291
4291
|
Get product device's configuration schema
|
|
4292
4292
|
|
|
@@ -4303,7 +4303,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4303
4303
|
|
|
4304
4304
|
### setProductConfiguration
|
|
4305
4305
|
|
|
4306
|
-
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/
|
|
4306
|
+
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2021-L2029 "Source code on GitHub")
|
|
4307
4307
|
|
|
4308
4308
|
Set product configuration
|
|
4309
4309
|
|
|
@@ -4320,7 +4320,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4320
4320
|
|
|
4321
4321
|
### setProductDeviceConfiguration
|
|
4322
4322
|
|
|
4323
|
-
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/
|
|
4323
|
+
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2042-L2050 "Source code on GitHub")
|
|
4324
4324
|
|
|
4325
4325
|
Set product configuration for a specific device within the product
|
|
4326
4326
|
|
|
@@ -4338,7 +4338,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4338
4338
|
|
|
4339
4339
|
### getProductLocations
|
|
4340
4340
|
|
|
4341
|
-
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/
|
|
4341
|
+
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2069-L2086 "Source code on GitHub")
|
|
4342
4342
|
|
|
4343
4343
|
Query location for devices within a product
|
|
4344
4344
|
|
|
@@ -4362,7 +4362,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4362
4362
|
|
|
4363
4363
|
### getProductDeviceLocations
|
|
4364
4364
|
|
|
4365
|
-
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/
|
|
4365
|
+
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2103-L2115 "Source code on GitHub")
|
|
4366
4366
|
|
|
4367
4367
|
Query location for one device within a product
|
|
4368
4368
|
|
|
@@ -4380,155 +4380,155 @@ Query location for one device within a product
|
|
|
4380
4380
|
|
|
4381
4381
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
4382
4382
|
|
|
4383
|
-
###
|
|
4383
|
+
### createLogicFunction
|
|
4384
4384
|
|
|
4385
|
-
[src/Particle.js:2135-2143](https://github.com/particle-iot/particle-api-js/blob/
|
|
4385
|
+
[src/Particle.js:2135-2143](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2135-L2143 "Source code on GitHub")
|
|
4386
4386
|
|
|
4387
|
-
Creates a new logic
|
|
4387
|
+
Creates a new logic function in the specified organization using the provided function data.
|
|
4388
4388
|
|
|
4389
|
-
When you create a logic
|
|
4390
|
-
start being handled by the
|
|
4389
|
+
When you create a logic function with Event logic triggers, events will immediately
|
|
4390
|
+
start being handled by the function code.
|
|
4391
4391
|
|
|
4392
|
-
When you create a
|
|
4392
|
+
When you create a Scheduled logic trigger, it will immediately be scheduled at the next time
|
|
4393
4393
|
according to the cron and start_at properties.
|
|
4394
4394
|
|
|
4395
4395
|
**Parameters**
|
|
4396
4396
|
|
|
4397
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic
|
|
4397
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
4398
4398
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4399
4399
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
|
|
4400
|
-
- `options.
|
|
4400
|
+
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the function details.
|
|
4401
4401
|
- `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.
|
|
4402
4402
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
4403
4403
|
|
|
4404
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic
|
|
4404
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic function data.
|
|
4405
4405
|
|
|
4406
|
-
###
|
|
4406
|
+
### getLogicFunction
|
|
4407
4407
|
|
|
4408
|
-
[src/Particle.js:2157-2164](https://github.com/particle-iot/particle-api-js/blob/
|
|
4408
|
+
[src/Particle.js:2157-2164](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2157-L2164 "Source code on GitHub")
|
|
4409
4409
|
|
|
4410
|
-
Get a logic
|
|
4410
|
+
Get a logic function in the specified organization by logic function ID.
|
|
4411
4411
|
|
|
4412
4412
|
**Parameters**
|
|
4413
4413
|
|
|
4414
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic
|
|
4414
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
4415
4415
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4416
4416
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
|
|
4417
|
-
- `options.
|
|
4417
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
4418
4418
|
- `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.
|
|
4419
4419
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
4420
4420
|
|
|
4421
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified logic
|
|
4421
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified logic function data.
|
|
4422
4422
|
|
|
4423
|
-
###
|
|
4423
|
+
### updateLogicFunction
|
|
4424
4424
|
|
|
4425
|
-
[src/Particle.js:2181-2189](https://github.com/particle-iot/particle-api-js/blob/
|
|
4425
|
+
[src/Particle.js:2181-2189](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2181-L2189 "Source code on GitHub")
|
|
4426
4426
|
|
|
4427
|
-
Updates an existing logic
|
|
4427
|
+
Updates an existing logic function in the specified organization using the provided function data.
|
|
4428
4428
|
|
|
4429
|
-
If you include an id on a
|
|
4429
|
+
If you include an id on a logic trigger, it will update the logic trigger in place.
|
|
4430
4430
|
|
|
4431
4431
|
**Parameters**
|
|
4432
4432
|
|
|
4433
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic
|
|
4433
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
4434
4434
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4435
4435
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
4436
|
-
- `options.
|
|
4437
|
-
- `options.
|
|
4436
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
4437
|
+
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the logic function details.
|
|
4438
4438
|
- `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.
|
|
4439
4439
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
4440
4440
|
|
|
4441
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the updated logic
|
|
4441
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the updated logic function data.
|
|
4442
4442
|
|
|
4443
|
-
###
|
|
4443
|
+
### deleteLogicFunction
|
|
4444
4444
|
|
|
4445
|
-
[src/Particle.js:2203-2210](https://github.com/particle-iot/particle-api-js/blob/
|
|
4445
|
+
[src/Particle.js:2203-2210](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2203-L2210 "Source code on GitHub")
|
|
4446
4446
|
|
|
4447
|
-
Deletes a logic
|
|
4447
|
+
Deletes a logic function in the specified organization by logic function ID.
|
|
4448
4448
|
|
|
4449
4449
|
**Parameters**
|
|
4450
4450
|
|
|
4451
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic
|
|
4451
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
4452
4452
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4453
4453
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
4454
|
-
- `options.
|
|
4454
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
4455
4455
|
- `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.
|
|
4456
4456
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
4457
4457
|
|
|
4458
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an object containing the deleted
|
|
4458
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an object containing the deleted logic function ID.
|
|
4459
4459
|
|
|
4460
|
-
###
|
|
4460
|
+
### listLogicFunctions
|
|
4461
4461
|
|
|
4462
|
-
[src/Particle.js:2223-2230](https://github.com/particle-iot/particle-api-js/blob/
|
|
4462
|
+
[src/Particle.js:2223-2230](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2223-L2230 "Source code on GitHub")
|
|
4463
4463
|
|
|
4464
|
-
Lists all logic
|
|
4464
|
+
Lists all logic functions in the specified organization.
|
|
4465
4465
|
|
|
4466
4466
|
**Parameters**
|
|
4467
4467
|
|
|
4468
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic
|
|
4468
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
4469
4469
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
4470
4470
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
4471
4471
|
- `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.
|
|
4472
4472
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
4473
4473
|
|
|
4474
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic
|
|
4474
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic functions data.
|
|
4475
4475
|
|
|
4476
|
-
###
|
|
4476
|
+
### listLogicRuns
|
|
4477
4477
|
|
|
4478
|
-
[src/Particle.js:2244-2251](https://github.com/particle-iot/particle-api-js/blob/
|
|
4478
|
+
[src/Particle.js:2244-2251](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2244-L2251 "Source code on GitHub")
|
|
4479
4479
|
|
|
4480
|
-
Lists all
|
|
4480
|
+
Lists all logic runs for the specified logic function.
|
|
4481
4481
|
|
|
4482
4482
|
**Parameters**
|
|
4483
4483
|
|
|
4484
4484
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
4485
4485
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4486
4486
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
4487
|
-
- `options.
|
|
4487
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic runs.
|
|
4488
4488
|
- `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.
|
|
4489
4489
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
4490
4490
|
|
|
4491
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of
|
|
4491
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic run data.
|
|
4492
4492
|
|
|
4493
|
-
###
|
|
4493
|
+
### getLogicRun
|
|
4494
4494
|
|
|
4495
|
-
[src/Particle.js:2266-2273](https://github.com/particle-iot/particle-api-js/blob/
|
|
4495
|
+
[src/Particle.js:2266-2273](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2266-L2273 "Source code on GitHub")
|
|
4496
4496
|
|
|
4497
|
-
Retrieves a
|
|
4497
|
+
Retrieves a logic run by its ID for the specified logic function.
|
|
4498
4498
|
|
|
4499
4499
|
**Parameters**
|
|
4500
4500
|
|
|
4501
4501
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
4502
4502
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4503
4503
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
4504
|
-
- `options.
|
|
4505
|
-
- `options.
|
|
4504
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run.
|
|
4505
|
+
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run to retrieve.
|
|
4506
4506
|
- `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.
|
|
4507
4507
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
4508
4508
|
|
|
4509
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of
|
|
4509
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic run data for the specified logic run ID.
|
|
4510
4510
|
|
|
4511
|
-
###
|
|
4511
|
+
### getLogicRunLogs
|
|
4512
4512
|
|
|
4513
|
-
[src/Particle.js:2288-2295](https://github.com/particle-iot/particle-api-js/blob/
|
|
4513
|
+
[src/Particle.js:2288-2295](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2288-L2295 "Source code on GitHub")
|
|
4514
4514
|
|
|
4515
|
-
Retrieves the logs for a
|
|
4515
|
+
Retrieves the logs for a logic run by its ID for the specified logic function.
|
|
4516
4516
|
|
|
4517
4517
|
**Parameters**
|
|
4518
4518
|
|
|
4519
4519
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
4520
4520
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
4521
4521
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
4522
|
-
- `options.
|
|
4523
|
-
- `options.
|
|
4522
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run logs.
|
|
4523
|
+
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run for which to retrieve the logs.
|
|
4524
4524
|
- `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.
|
|
4525
4525
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
4526
4526
|
|
|
4527
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the logs for the specified
|
|
4527
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the logs for the specified logic run ID.
|
|
4528
4528
|
|
|
4529
4529
|
### createLedger
|
|
4530
4530
|
|
|
4531
|
-
[src/Particle.js:2310-2318](https://github.com/particle-iot/particle-api-js/blob/
|
|
4531
|
+
[src/Particle.js:2310-2318](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2310-L2318 "Source code on GitHub")
|
|
4532
4532
|
|
|
4533
4533
|
Creates a new ledger definition in the specified organization.
|
|
4534
4534
|
|
|
@@ -4546,7 +4546,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4546
4546
|
|
|
4547
4547
|
### getLedger
|
|
4548
4548
|
|
|
4549
|
-
[src/Particle.js:2332-2339](https://github.com/particle-iot/particle-api-js/blob/
|
|
4549
|
+
[src/Particle.js:2332-2339](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2332-L2339 "Source code on GitHub")
|
|
4550
4550
|
|
|
4551
4551
|
Get a ledger definition in the specified organization by ledger name.
|
|
4552
4552
|
|
|
@@ -4563,7 +4563,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4563
4563
|
|
|
4564
4564
|
### updateLedger
|
|
4565
4565
|
|
|
4566
|
-
[src/Particle.js:2354-2362](https://github.com/particle-iot/particle-api-js/blob/
|
|
4566
|
+
[src/Particle.js:2354-2362](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2354-L2362 "Source code on GitHub")
|
|
4567
4567
|
|
|
4568
4568
|
Updates an existing ledger definition in the specified organization.
|
|
4569
4569
|
|
|
@@ -4581,7 +4581,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4581
4581
|
|
|
4582
4582
|
### archiveLedger
|
|
4583
4583
|
|
|
4584
|
-
[src/Particle.js:2376-2383](https://github.com/particle-iot/particle-api-js/blob/
|
|
4584
|
+
[src/Particle.js:2376-2383](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2376-L2383 "Source code on GitHub")
|
|
4585
4585
|
|
|
4586
4586
|
Archives a ledger definition in the specified organization by ledger name.
|
|
4587
4587
|
|
|
@@ -4598,7 +4598,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4598
4598
|
|
|
4599
4599
|
### listLedgers
|
|
4600
4600
|
|
|
4601
|
-
[src/Particle.js:2396-2403](https://github.com/particle-iot/particle-api-js/blob/
|
|
4601
|
+
[src/Particle.js:2396-2403](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2396-L2403 "Source code on GitHub")
|
|
4602
4602
|
|
|
4603
4603
|
Lists all ledger definitions in the specified organization.
|
|
4604
4604
|
|
|
@@ -4614,7 +4614,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4614
4614
|
|
|
4615
4615
|
### getLedgerInstance
|
|
4616
4616
|
|
|
4617
|
-
[src/Particle.js:2418-2425](https://github.com/particle-iot/particle-api-js/blob/
|
|
4617
|
+
[src/Particle.js:2418-2425](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2418-L2425 "Source code on GitHub")
|
|
4618
4618
|
|
|
4619
4619
|
Get ledger instance data.
|
|
4620
4620
|
|
|
@@ -4632,7 +4632,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4632
4632
|
|
|
4633
4633
|
### setLedgerInstance
|
|
4634
4634
|
|
|
4635
|
-
[src/Particle.js:2442-2450](https://github.com/particle-iot/particle-api-js/blob/
|
|
4635
|
+
[src/Particle.js:2442-2450](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2442-L2450 "Source code on GitHub")
|
|
4636
4636
|
|
|
4637
4637
|
Set ledger instance data.
|
|
4638
4638
|
|
|
@@ -4652,7 +4652,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4652
4652
|
|
|
4653
4653
|
### deleteLedgerInstance
|
|
4654
4654
|
|
|
4655
|
-
[src/Particle.js:2465-2472](https://github.com/particle-iot/particle-api-js/blob/
|
|
4655
|
+
[src/Particle.js:2465-2472](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2465-L2472 "Source code on GitHub")
|
|
4656
4656
|
|
|
4657
4657
|
Delete a ledger instance in the specified organization by ledger name.
|
|
4658
4658
|
|
|
@@ -4670,7 +4670,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4670
4670
|
|
|
4671
4671
|
### listLedgerInstances
|
|
4672
4672
|
|
|
4673
|
-
[src/Particle.js:2486-2493](https://github.com/particle-iot/particle-api-js/blob/
|
|
4673
|
+
[src/Particle.js:2486-2493](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2486-L2493 "Source code on GitHub")
|
|
4674
4674
|
|
|
4675
4675
|
Lists ledger instances.
|
|
4676
4676
|
|
|
@@ -4687,7 +4687,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4687
4687
|
|
|
4688
4688
|
### setDefaultAuth
|
|
4689
4689
|
|
|
4690
|
-
[src/Particle.js:2500-2506](https://github.com/particle-iot/particle-api-js/blob/
|
|
4690
|
+
[src/Particle.js:2500-2506](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2500-L2506 "Source code on GitHub")
|
|
4691
4691
|
|
|
4692
4692
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
4693
4693
|
|
|
@@ -4700,7 +4700,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
4700
4700
|
|
|
4701
4701
|
### get
|
|
4702
4702
|
|
|
4703
|
-
[src/Particle.js:2538-2542](https://github.com/particle-iot/particle-api-js/blob/
|
|
4703
|
+
[src/Particle.js:2538-2542](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2538-L2542 "Source code on GitHub")
|
|
4704
4704
|
|
|
4705
4705
|
Make a GET request
|
|
4706
4706
|
|
|
@@ -4717,7 +4717,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4717
4717
|
|
|
4718
4718
|
### head
|
|
4719
4719
|
|
|
4720
|
-
[src/Particle.js:2554-2558](https://github.com/particle-iot/particle-api-js/blob/
|
|
4720
|
+
[src/Particle.js:2554-2558](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2554-L2558 "Source code on GitHub")
|
|
4721
4721
|
|
|
4722
4722
|
Make a HEAD request
|
|
4723
4723
|
|
|
@@ -4734,7 +4734,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4734
4734
|
|
|
4735
4735
|
### post
|
|
4736
4736
|
|
|
4737
|
-
[src/Particle.js:2570-2574](https://github.com/particle-iot/particle-api-js/blob/
|
|
4737
|
+
[src/Particle.js:2570-2574](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2570-L2574 "Source code on GitHub")
|
|
4738
4738
|
|
|
4739
4739
|
Make a POST request
|
|
4740
4740
|
|
|
@@ -4751,7 +4751,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4751
4751
|
|
|
4752
4752
|
### put
|
|
4753
4753
|
|
|
4754
|
-
[src/Particle.js:2586-2590](https://github.com/particle-iot/particle-api-js/blob/
|
|
4754
|
+
[src/Particle.js:2586-2590](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2586-L2590 "Source code on GitHub")
|
|
4755
4755
|
|
|
4756
4756
|
Make a PUT request
|
|
4757
4757
|
|
|
@@ -4768,7 +4768,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4768
4768
|
|
|
4769
4769
|
### delete
|
|
4770
4770
|
|
|
4771
|
-
[src/Particle.js:2602-2606](https://github.com/particle-iot/particle-api-js/blob/
|
|
4771
|
+
[src/Particle.js:2602-2606](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2602-L2606 "Source code on GitHub")
|
|
4772
4772
|
|
|
4773
4773
|
Make a DELETE request
|
|
4774
4774
|
|
|
@@ -4785,7 +4785,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4785
4785
|
|
|
4786
4786
|
### request
|
|
4787
4787
|
|
|
4788
|
-
[src/Particle.js:2623-2627](https://github.com/particle-iot/particle-api-js/blob/
|
|
4788
|
+
[src/Particle.js:2623-2627](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2623-L2627 "Source code on GitHub")
|
|
4789
4789
|
|
|
4790
4790
|
**Parameters**
|
|
4791
4791
|
|
|
@@ -4805,7 +4805,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4805
4805
|
|
|
4806
4806
|
## Particle
|
|
4807
4807
|
|
|
4808
|
-
[src/Particle.js:23-2639](https://github.com/particle-iot/particle-api-js/blob/
|
|
4808
|
+
[src/Particle.js:23-2639](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L23-L2639 "Source code on GitHub")
|
|
4809
4809
|
|
|
4810
4810
|
Particle Cloud API wrapper.
|
|
4811
4811
|
|
|
@@ -4821,7 +4821,7 @@ Most Particle methods take a single unnamed argument object documented as
|
|
|
4821
4821
|
|
|
4822
4822
|
### constructor
|
|
4823
4823
|
|
|
4824
|
-
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/
|
|
4824
|
+
[src/Particle.js:31-40](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L31-L40 "Source code on GitHub")
|
|
4825
4825
|
|
|
4826
4826
|
Contructor for the Cloud API wrapper.
|
|
4827
4827
|
|
|
@@ -4833,7 +4833,7 @@ Create a new Particle object and call methods below on it.
|
|
|
4833
4833
|
|
|
4834
4834
|
### login
|
|
4835
4835
|
|
|
4836
|
-
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/
|
|
4836
|
+
[src/Particle.js:77-94](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L77-L94 "Source code on GitHub")
|
|
4837
4837
|
|
|
4838
4838
|
Login to Particle Cloud using an existing Particle acccount.
|
|
4839
4839
|
|
|
@@ -4850,7 +4850,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4850
4850
|
|
|
4851
4851
|
### sendOtp
|
|
4852
4852
|
|
|
4853
|
-
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/
|
|
4853
|
+
[src/Particle.js:105-121](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L105-L121 "Source code on GitHub")
|
|
4854
4854
|
|
|
4855
4855
|
If login failed with an 'mfa_required' error, this must be called with a valid OTP code to login
|
|
4856
4856
|
|
|
@@ -4866,7 +4866,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4866
4866
|
|
|
4867
4867
|
### enableMfa
|
|
4868
4868
|
|
|
4869
|
-
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/
|
|
4869
|
+
[src/Particle.js:131-133](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L131-L133 "Source code on GitHub")
|
|
4870
4870
|
|
|
4871
4871
|
Enable MFA on the currently logged in user
|
|
4872
4872
|
|
|
@@ -4881,7 +4881,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4881
4881
|
|
|
4882
4882
|
### confirmMfa
|
|
4883
4883
|
|
|
4884
|
-
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/
|
|
4884
|
+
[src/Particle.js:146-160](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L146-L160 "Source code on GitHub")
|
|
4885
4885
|
|
|
4886
4886
|
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.
|
|
4887
4887
|
|
|
@@ -4899,7 +4899,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4899
4899
|
|
|
4900
4900
|
### disableMfa
|
|
4901
4901
|
|
|
4902
|
-
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/
|
|
4902
|
+
[src/Particle.js:171-179](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L171-L179 "Source code on GitHub")
|
|
4903
4903
|
|
|
4904
4904
|
Disable MFA for the user.
|
|
4905
4905
|
|
|
@@ -4915,7 +4915,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4915
4915
|
|
|
4916
4916
|
### createCustomer
|
|
4917
4917
|
|
|
4918
|
-
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/
|
|
4918
|
+
[src/Particle.js:191-207](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L191-L207 "Source code on GitHub")
|
|
4919
4919
|
|
|
4920
4920
|
Create Customer for Product.
|
|
4921
4921
|
|
|
@@ -4932,7 +4932,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4932
4932
|
|
|
4933
4933
|
### loginAsClientOwner
|
|
4934
4934
|
|
|
4935
|
-
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/
|
|
4935
|
+
[src/Particle.js:216-230](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L216-L230 "Source code on GitHub")
|
|
4936
4936
|
|
|
4937
4937
|
Login to Particle Cloud using an OAuth client.
|
|
4938
4938
|
|
|
@@ -4946,7 +4946,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4946
4946
|
|
|
4947
4947
|
### createUser
|
|
4948
4948
|
|
|
4949
|
-
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/
|
|
4949
|
+
[src/Particle.js:242-253](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L242-L253 "Source code on GitHub")
|
|
4950
4950
|
|
|
4951
4951
|
Create a user account for the Particle Cloud
|
|
4952
4952
|
|
|
@@ -4963,7 +4963,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4963
4963
|
|
|
4964
4964
|
### verifyUser
|
|
4965
4965
|
|
|
4966
|
-
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/
|
|
4966
|
+
[src/Particle.js:263-270](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L263-L270 "Source code on GitHub")
|
|
4967
4967
|
|
|
4968
4968
|
Verify new user account via verification email
|
|
4969
4969
|
|
|
@@ -4978,7 +4978,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4978
4978
|
|
|
4979
4979
|
### resetPassword
|
|
4980
4980
|
|
|
4981
|
-
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/
|
|
4981
|
+
[src/Particle.js:280-287](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L280-L287 "Source code on GitHub")
|
|
4982
4982
|
|
|
4983
4983
|
Send reset password email for a Particle Cloud user account
|
|
4984
4984
|
|
|
@@ -4993,7 +4993,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
4993
4993
|
|
|
4994
4994
|
### deleteAccessToken
|
|
4995
4995
|
|
|
4996
|
-
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/
|
|
4996
|
+
[src/Particle.js:299-307](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L299-L307 "Source code on GitHub")
|
|
4997
4997
|
|
|
4998
4998
|
Revoke an access token
|
|
4999
4999
|
|
|
@@ -5010,7 +5010,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5010
5010
|
|
|
5011
5011
|
### deleteCurrentAccessToken
|
|
5012
5012
|
|
|
5013
|
-
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/
|
|
5013
|
+
[src/Particle.js:317-324](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L317-L324 "Source code on GitHub")
|
|
5014
5014
|
|
|
5015
5015
|
Revoke the current session access token
|
|
5016
5016
|
|
|
@@ -5025,7 +5025,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5025
5025
|
|
|
5026
5026
|
### deleteActiveAccessTokens
|
|
5027
5027
|
|
|
5028
|
-
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/
|
|
5028
|
+
[src/Particle.js:334-341](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L334-L341 "Source code on GitHub")
|
|
5029
5029
|
|
|
5030
5030
|
Revoke all active access tokens
|
|
5031
5031
|
|
|
@@ -5040,7 +5040,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5040
5040
|
|
|
5041
5041
|
### deleteUser
|
|
5042
5042
|
|
|
5043
|
-
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/
|
|
5043
|
+
[src/Particle.js:352-360](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L352-L360 "Source code on GitHub")
|
|
5044
5044
|
|
|
5045
5045
|
Delete the current user
|
|
5046
5046
|
|
|
@@ -5056,7 +5056,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5056
5056
|
|
|
5057
5057
|
### listAccessTokens
|
|
5058
5058
|
|
|
5059
|
-
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/
|
|
5059
|
+
[src/Particle.js:372-380](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L372-L380 "Source code on GitHub")
|
|
5060
5060
|
|
|
5061
5061
|
List all valid access tokens for a Particle Cloud account
|
|
5062
5062
|
|
|
@@ -5073,7 +5073,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5073
5073
|
|
|
5074
5074
|
### trackingIdentity
|
|
5075
5075
|
|
|
5076
|
-
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/
|
|
5076
|
+
[src/Particle.js:392-400](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L392-L400 "Source code on GitHub")
|
|
5077
5077
|
|
|
5078
5078
|
Retrieves the information that is used to identify the current login for tracking.
|
|
5079
5079
|
|
|
@@ -5090,7 +5090,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5090
5090
|
|
|
5091
5091
|
### listDevices
|
|
5092
5092
|
|
|
5093
|
-
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/
|
|
5093
|
+
[src/Particle.js:418-437](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L418-L437 "Source code on GitHub")
|
|
5094
5094
|
|
|
5095
5095
|
List devices claimed to the account or product
|
|
5096
5096
|
|
|
@@ -5113,7 +5113,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5113
5113
|
|
|
5114
5114
|
### getDevice
|
|
5115
5115
|
|
|
5116
|
-
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/
|
|
5116
|
+
[src/Particle.js:449-452](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L449-L452 "Source code on GitHub")
|
|
5117
5117
|
|
|
5118
5118
|
Get detailed informationa about a device
|
|
5119
5119
|
|
|
@@ -5130,7 +5130,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5130
5130
|
|
|
5131
5131
|
### claimDevice
|
|
5132
5132
|
|
|
5133
|
-
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/
|
|
5133
|
+
[src/Particle.js:464-475](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L464-L475 "Source code on GitHub")
|
|
5134
5134
|
|
|
5135
5135
|
Claim a device to the account. The device must be online and unclaimed.
|
|
5136
5136
|
|
|
@@ -5147,7 +5147,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5147
5147
|
|
|
5148
5148
|
### addDeviceToProduct
|
|
5149
5149
|
|
|
5150
|
-
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/
|
|
5150
|
+
[src/Particle.js:489-507](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L489-L507 "Source code on GitHub")
|
|
5151
5151
|
|
|
5152
5152
|
Add a device to a product or move device out of quarantine.
|
|
5153
5153
|
|
|
@@ -5166,7 +5166,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5166
5166
|
|
|
5167
5167
|
### removeDevice
|
|
5168
5168
|
|
|
5169
|
-
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/
|
|
5169
|
+
[src/Particle.js:520-524](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L520-L524 "Source code on GitHub")
|
|
5170
5170
|
|
|
5171
5171
|
Unclaim / Remove a device from your account or product, or deny quarantine
|
|
5172
5172
|
|
|
@@ -5184,7 +5184,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5184
5184
|
|
|
5185
5185
|
### removeDeviceOwner
|
|
5186
5186
|
|
|
5187
|
-
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/
|
|
5187
|
+
[src/Particle.js:536-539](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L536-L539 "Source code on GitHub")
|
|
5188
5188
|
|
|
5189
5189
|
Unclaim a product device its the owner, but keep it in the product
|
|
5190
5190
|
|
|
@@ -5201,7 +5201,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5201
5201
|
|
|
5202
5202
|
### renameDevice
|
|
5203
5203
|
|
|
5204
|
-
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/
|
|
5204
|
+
[src/Particle.js:552-554](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L552-L554 "Source code on GitHub")
|
|
5205
5205
|
|
|
5206
5206
|
Rename a device
|
|
5207
5207
|
|
|
@@ -5219,7 +5219,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5219
5219
|
|
|
5220
5220
|
### signalDevice
|
|
5221
5221
|
|
|
5222
|
-
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/
|
|
5222
|
+
[src/Particle.js:567-569](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L567-L569 "Source code on GitHub")
|
|
5223
5223
|
|
|
5224
5224
|
Instruct the device to turn on/off the LED in a rainbow pattern
|
|
5225
5225
|
|
|
@@ -5237,7 +5237,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5237
5237
|
|
|
5238
5238
|
### setDeviceNotes
|
|
5239
5239
|
|
|
5240
|
-
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/
|
|
5240
|
+
[src/Particle.js:582-584](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L582-L584 "Source code on GitHub")
|
|
5241
5241
|
|
|
5242
5242
|
Store some notes about device
|
|
5243
5243
|
|
|
@@ -5255,7 +5255,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5255
5255
|
|
|
5256
5256
|
### markAsDevelopmentDevice
|
|
5257
5257
|
|
|
5258
|
-
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/
|
|
5258
|
+
[src/Particle.js:597-599](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L597-L599 "Source code on GitHub")
|
|
5259
5259
|
|
|
5260
5260
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
5261
5261
|
|
|
@@ -5273,7 +5273,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5273
5273
|
|
|
5274
5274
|
### lockDeviceProductFirmware
|
|
5275
5275
|
|
|
5276
|
-
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/
|
|
5276
|
+
[src/Particle.js:613-615](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L613-L615 "Source code on GitHub")
|
|
5277
5277
|
|
|
5278
5278
|
Mark device as being used in development of a product so it opts out of automatic firmware updates
|
|
5279
5279
|
|
|
@@ -5292,7 +5292,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5292
5292
|
|
|
5293
5293
|
### unlockDeviceProductFirmware
|
|
5294
5294
|
|
|
5295
|
-
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/
|
|
5295
|
+
[src/Particle.js:627-629](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L627-L629 "Source code on GitHub")
|
|
5296
5296
|
|
|
5297
5297
|
Mark device as receiving automatic firmware updates
|
|
5298
5298
|
|
|
@@ -5309,7 +5309,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5309
5309
|
|
|
5310
5310
|
### updateDevice
|
|
5311
5311
|
|
|
5312
|
-
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/
|
|
5312
|
+
[src/Particle.js:648-660](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L648-L660 "Source code on GitHub")
|
|
5313
5313
|
|
|
5314
5314
|
Update multiple device attributes at the same time
|
|
5315
5315
|
|
|
@@ -5333,7 +5333,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5333
5333
|
|
|
5334
5334
|
### provisionDevice
|
|
5335
5335
|
|
|
5336
|
-
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/
|
|
5336
|
+
[src/Particle.js:671-679](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L671-L679 "Source code on GitHub")
|
|
5337
5337
|
|
|
5338
5338
|
Provision a new device for products that allow self-provisioning
|
|
5339
5339
|
|
|
@@ -5349,7 +5349,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5349
5349
|
|
|
5350
5350
|
### getClaimCode
|
|
5351
5351
|
|
|
5352
|
-
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/
|
|
5352
|
+
[src/Particle.js:693-696](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L693-L696 "Source code on GitHub")
|
|
5353
5353
|
|
|
5354
5354
|
Generate a claim code to use in the device claiming process.
|
|
5355
5355
|
To generate a claim code for a product, the access token MUST belong to a
|
|
@@ -5368,7 +5368,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5368
5368
|
|
|
5369
5369
|
### getVariable
|
|
5370
5370
|
|
|
5371
|
-
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/
|
|
5371
|
+
[src/Particle.js:728-734](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L728-L734 "Source code on GitHub")
|
|
5372
5372
|
|
|
5373
5373
|
Get the value of a device variable
|
|
5374
5374
|
|
|
@@ -5386,7 +5386,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5386
5386
|
|
|
5387
5387
|
### flashDevice
|
|
5388
5388
|
|
|
5389
|
-
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/
|
|
5389
|
+
[src/Particle.js:748-759](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L748-L759 "Source code on GitHub")
|
|
5390
5390
|
|
|
5391
5391
|
Compile and flash application firmware to a device. Pass a pre-compiled binary to flash it directly to the device.
|
|
5392
5392
|
|
|
@@ -5405,7 +5405,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5405
5405
|
|
|
5406
5406
|
### flashTinker
|
|
5407
5407
|
|
|
5408
|
-
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/
|
|
5408
|
+
[src/Particle.js:770-785](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L770-L785 "Source code on GitHub")
|
|
5409
5409
|
|
|
5410
5410
|
DEPRECATED: Flash the Tinker application to a device. Instead compile and flash the Tinker source code.
|
|
5411
5411
|
|
|
@@ -5421,7 +5421,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5421
5421
|
|
|
5422
5422
|
### compileCode
|
|
5423
5423
|
|
|
5424
|
-
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/
|
|
5424
|
+
[src/Particle.js:798-816](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L798-L816 "Source code on GitHub")
|
|
5425
5425
|
|
|
5426
5426
|
Compile firmware using the Particle Cloud
|
|
5427
5427
|
|
|
@@ -5439,7 +5439,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5439
5439
|
|
|
5440
5440
|
### downloadFirmwareBinary
|
|
5441
5441
|
|
|
5442
|
-
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/
|
|
5442
|
+
[src/Particle.js:827-836](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L827-L836 "Source code on GitHub")
|
|
5443
5443
|
|
|
5444
5444
|
Download a firmware binary
|
|
5445
5445
|
|
|
@@ -5455,7 +5455,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5455
5455
|
|
|
5456
5456
|
### sendPublicKey
|
|
5457
5457
|
|
|
5458
|
-
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/
|
|
5458
|
+
[src/Particle.js:849-863](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L849-L863 "Source code on GitHub")
|
|
5459
5459
|
|
|
5460
5460
|
Send a new device public key to the Particle Cloud
|
|
5461
5461
|
|
|
@@ -5473,7 +5473,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5473
5473
|
|
|
5474
5474
|
### callFunction
|
|
5475
5475
|
|
|
5476
|
-
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/
|
|
5476
|
+
[src/Particle.js:877-882](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L877-L882 "Source code on GitHub")
|
|
5477
5477
|
|
|
5478
5478
|
Call a device function
|
|
5479
5479
|
|
|
@@ -5492,7 +5492,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5492
5492
|
|
|
5493
5493
|
### getEventStream
|
|
5494
5494
|
|
|
5495
|
-
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/
|
|
5495
|
+
[src/Particle.js:895-920](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L895-L920 "Source code on GitHub")
|
|
5496
5496
|
|
|
5497
5497
|
Get a stream of events
|
|
5498
5498
|
|
|
@@ -5510,7 +5510,7 @@ emit 'event' events.
|
|
|
5510
5510
|
|
|
5511
5511
|
### publishEvent
|
|
5512
5512
|
|
|
5513
|
-
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/
|
|
5513
|
+
[src/Particle.js:934-938](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L934-L938 "Source code on GitHub")
|
|
5514
5514
|
|
|
5515
5515
|
Publish a event to the Particle Cloud
|
|
5516
5516
|
|
|
@@ -5529,7 +5529,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5529
5529
|
|
|
5530
5530
|
### createWebhook
|
|
5531
5531
|
|
|
5532
|
-
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/
|
|
5532
|
+
[src/Particle.js:965-987](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L965-L987 "Source code on GitHub")
|
|
5533
5533
|
|
|
5534
5534
|
Create a webhook
|
|
5535
5535
|
|
|
@@ -5561,7 +5561,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5561
5561
|
|
|
5562
5562
|
### deleteWebhook
|
|
5563
5563
|
|
|
5564
|
-
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/
|
|
5564
|
+
[src/Particle.js:999-1002](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L999-L1002 "Source code on GitHub")
|
|
5565
5565
|
|
|
5566
5566
|
Delete a webhook
|
|
5567
5567
|
|
|
@@ -5578,7 +5578,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5578
5578
|
|
|
5579
5579
|
### listWebhooks
|
|
5580
5580
|
|
|
5581
|
-
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/
|
|
5581
|
+
[src/Particle.js:1013-1016](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1013-L1016 "Source code on GitHub")
|
|
5582
5582
|
|
|
5583
5583
|
List all webhooks owned by the account or product
|
|
5584
5584
|
|
|
@@ -5594,7 +5594,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5594
5594
|
|
|
5595
5595
|
### createIntegration
|
|
5596
5596
|
|
|
5597
|
-
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/
|
|
5597
|
+
[src/Particle.js:1033-1037](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1033-L1037 "Source code on GitHub")
|
|
5598
5598
|
|
|
5599
5599
|
Create an integration to send events to an external service
|
|
5600
5600
|
|
|
@@ -5615,7 +5615,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5615
5615
|
|
|
5616
5616
|
### editIntegration
|
|
5617
5617
|
|
|
5618
|
-
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/
|
|
5618
|
+
[src/Particle.js:1055-1059](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1055-L1059 "Source code on GitHub")
|
|
5619
5619
|
|
|
5620
5620
|
Edit an integration to send events to an external service
|
|
5621
5621
|
|
|
@@ -5637,7 +5637,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5637
5637
|
|
|
5638
5638
|
### deleteIntegration
|
|
5639
5639
|
|
|
5640
|
-
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/
|
|
5640
|
+
[src/Particle.js:1072-1075](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1072-L1075 "Source code on GitHub")
|
|
5641
5641
|
|
|
5642
5642
|
Delete an integration to send events to an external service
|
|
5643
5643
|
|
|
@@ -5654,7 +5654,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5654
5654
|
|
|
5655
5655
|
### listIntegrations
|
|
5656
5656
|
|
|
5657
|
-
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/
|
|
5657
|
+
[src/Particle.js:1086-1089](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1086-L1089 "Source code on GitHub")
|
|
5658
5658
|
|
|
5659
5659
|
List all integrations owned by the account or product
|
|
5660
5660
|
|
|
@@ -5670,7 +5670,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5670
5670
|
|
|
5671
5671
|
### getUserInfo
|
|
5672
5672
|
|
|
5673
|
-
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/
|
|
5673
|
+
[src/Particle.js:1099-1101](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1099-L1101 "Source code on GitHub")
|
|
5674
5674
|
|
|
5675
5675
|
Get details about the current user
|
|
5676
5676
|
|
|
@@ -5685,7 +5685,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5685
5685
|
|
|
5686
5686
|
### setUserInfo
|
|
5687
5687
|
|
|
5688
|
-
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/
|
|
5688
|
+
[src/Particle.js:1112-1115](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1112-L1115 "Source code on GitHub")
|
|
5689
5689
|
|
|
5690
5690
|
Set details on the current user
|
|
5691
5691
|
|
|
@@ -5701,7 +5701,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5701
5701
|
|
|
5702
5702
|
### changeUsername
|
|
5703
5703
|
|
|
5704
|
-
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/
|
|
5704
|
+
[src/Particle.js:1128-1136](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1128-L1136 "Source code on GitHub")
|
|
5705
5705
|
|
|
5706
5706
|
Change username (i.e, email)
|
|
5707
5707
|
|
|
@@ -5719,7 +5719,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5719
5719
|
|
|
5720
5720
|
### changeUserPassword
|
|
5721
5721
|
|
|
5722
|
-
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/
|
|
5722
|
+
[src/Particle.js:1149-1157](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1149-L1157 "Source code on GitHub")
|
|
5723
5723
|
|
|
5724
5724
|
Change user's password
|
|
5725
5725
|
|
|
@@ -5737,7 +5737,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5737
5737
|
|
|
5738
5738
|
### listSIMs
|
|
5739
5739
|
|
|
5740
|
-
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/
|
|
5740
|
+
[src/Particle.js:1173-1177](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1173-L1177 "Source code on GitHub")
|
|
5741
5741
|
|
|
5742
5742
|
List SIM cards owned by a user or product
|
|
5743
5743
|
|
|
@@ -5758,7 +5758,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5758
5758
|
|
|
5759
5759
|
### getSIMDataUsage
|
|
5760
5760
|
|
|
5761
|
-
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/
|
|
5761
|
+
[src/Particle.js:1189-1195](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1189-L1195 "Source code on GitHub")
|
|
5762
5762
|
|
|
5763
5763
|
Get data usage for one SIM card for the current billing period
|
|
5764
5764
|
|
|
@@ -5775,7 +5775,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5775
5775
|
|
|
5776
5776
|
### getFleetDataUsage
|
|
5777
5777
|
|
|
5778
|
-
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/
|
|
5778
|
+
[src/Particle.js:1206-1213](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1206-L1213 "Source code on GitHub")
|
|
5779
5779
|
|
|
5780
5780
|
Get data usage for all SIM cards in a product the current billing period
|
|
5781
5781
|
|
|
@@ -5791,7 +5791,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5791
5791
|
|
|
5792
5792
|
### checkSIM
|
|
5793
5793
|
|
|
5794
|
-
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/
|
|
5794
|
+
[src/Particle.js:1224-1226](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1224-L1226 "Source code on GitHub")
|
|
5795
5795
|
|
|
5796
5796
|
Check SIM status
|
|
5797
5797
|
|
|
@@ -5807,7 +5807,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5807
5807
|
|
|
5808
5808
|
### activateSIM
|
|
5809
5809
|
|
|
5810
|
-
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/
|
|
5810
|
+
[src/Particle.js:1241-1251](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1241-L1251 "Source code on GitHub")
|
|
5811
5811
|
|
|
5812
5812
|
Activate and add SIM cards to an account or product
|
|
5813
5813
|
|
|
@@ -5827,7 +5827,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5827
5827
|
|
|
5828
5828
|
### deactivateSIM
|
|
5829
5829
|
|
|
5830
|
-
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/
|
|
5830
|
+
[src/Particle.js:1263-1267](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1263-L1267 "Source code on GitHub")
|
|
5831
5831
|
|
|
5832
5832
|
Deactivate a SIM card so it doesn't incur data usage in future months.
|
|
5833
5833
|
|
|
@@ -5844,7 +5844,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5844
5844
|
|
|
5845
5845
|
### reactivateSIM
|
|
5846
5846
|
|
|
5847
|
-
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/
|
|
5847
|
+
[src/Particle.js:1280-1284](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1280-L1284 "Source code on GitHub")
|
|
5848
5848
|
|
|
5849
5849
|
Reactivate a SIM card the was deactivated or unpause a SIM card that was automatically paused
|
|
5850
5850
|
|
|
@@ -5862,7 +5862,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5862
5862
|
|
|
5863
5863
|
### updateSIM
|
|
5864
5864
|
|
|
5865
|
-
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/
|
|
5865
|
+
[src/Particle.js:1297-1301](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1297-L1301 "Source code on GitHub")
|
|
5866
5866
|
|
|
5867
5867
|
Update SIM card data limit
|
|
5868
5868
|
|
|
@@ -5880,7 +5880,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5880
5880
|
|
|
5881
5881
|
### removeSIM
|
|
5882
5882
|
|
|
5883
|
-
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/
|
|
5883
|
+
[src/Particle.js:1313-1316](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1313-L1316 "Source code on GitHub")
|
|
5884
5884
|
|
|
5885
5885
|
Remove a SIM card from an account so it can be activated by a different account
|
|
5886
5886
|
|
|
@@ -5897,7 +5897,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5897
5897
|
|
|
5898
5898
|
### listBuildTargets
|
|
5899
5899
|
|
|
5900
|
-
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/
|
|
5900
|
+
[src/Particle.js:1327-1330](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1327-L1330 "Source code on GitHub")
|
|
5901
5901
|
|
|
5902
5902
|
List valid build targets to be used for compiling
|
|
5903
5903
|
|
|
@@ -5913,7 +5913,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5913
5913
|
|
|
5914
5914
|
### listLibraries
|
|
5915
5915
|
|
|
5916
|
-
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/
|
|
5916
|
+
[src/Particle.js:1356-1373](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1356-L1373 "Source code on GitHub")
|
|
5917
5917
|
|
|
5918
5918
|
List firmware libraries
|
|
5919
5919
|
|
|
@@ -5942,7 +5942,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5942
5942
|
|
|
5943
5943
|
### getLibrary
|
|
5944
5944
|
|
|
5945
|
-
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/
|
|
5945
|
+
[src/Particle.js:1389-1397](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1389-L1397 "Source code on GitHub")
|
|
5946
5946
|
|
|
5947
5947
|
Get firmware library details
|
|
5948
5948
|
|
|
@@ -5959,7 +5959,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5959
5959
|
|
|
5960
5960
|
### getLibraryVersions
|
|
5961
5961
|
|
|
5962
|
-
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/
|
|
5962
|
+
[src/Particle.js:1410-1418](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1410-L1418 "Source code on GitHub")
|
|
5963
5963
|
|
|
5964
5964
|
Firmware library details for each version
|
|
5965
5965
|
|
|
@@ -5977,7 +5977,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5977
5977
|
|
|
5978
5978
|
### contributeLibrary
|
|
5979
5979
|
|
|
5980
|
-
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/
|
|
5980
|
+
[src/Particle.js:1430-1443](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1430-L1443 "Source code on GitHub")
|
|
5981
5981
|
|
|
5982
5982
|
Contribute a new library version from a compressed archive
|
|
5983
5983
|
|
|
@@ -5994,7 +5994,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
5994
5994
|
|
|
5995
5995
|
### publishLibrary
|
|
5996
5996
|
|
|
5997
|
-
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/
|
|
5997
|
+
[src/Particle.js:1454-1463](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1454-L1463 "Source code on GitHub")
|
|
5998
5998
|
|
|
5999
5999
|
Publish the latest version of a library to the public
|
|
6000
6000
|
|
|
@@ -6010,7 +6010,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6010
6010
|
|
|
6011
6011
|
### deleteLibrary
|
|
6012
6012
|
|
|
6013
|
-
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/
|
|
6013
|
+
[src/Particle.js:1475-1483](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1475-L1483 "Source code on GitHub")
|
|
6014
6014
|
|
|
6015
6015
|
Delete one version of a library or an entire private library
|
|
6016
6016
|
|
|
@@ -6027,7 +6027,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6027
6027
|
|
|
6028
6028
|
### downloadFile
|
|
6029
6029
|
|
|
6030
|
-
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/
|
|
6030
|
+
[src/Particle.js:1493-1495](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1493-L1495 "Source code on GitHub")
|
|
6031
6031
|
|
|
6032
6032
|
Download an external file that may not be on the API
|
|
6033
6033
|
|
|
@@ -6042,7 +6042,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6042
6042
|
|
|
6043
6043
|
### listOAuthClients
|
|
6044
6044
|
|
|
6045
|
-
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/
|
|
6045
|
+
[src/Particle.js:1506-1509](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1506-L1509 "Source code on GitHub")
|
|
6046
6046
|
|
|
6047
6047
|
List OAuth client created by the account
|
|
6048
6048
|
|
|
@@ -6058,7 +6058,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6058
6058
|
|
|
6059
6059
|
### createOAuthClient
|
|
6060
6060
|
|
|
6061
|
-
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/
|
|
6061
|
+
[src/Particle.js:1524-1528](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1524-L1528 "Source code on GitHub")
|
|
6062
6062
|
|
|
6063
6063
|
Create an OAuth client
|
|
6064
6064
|
|
|
@@ -6078,7 +6078,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6078
6078
|
|
|
6079
6079
|
### updateOAuthClient
|
|
6080
6080
|
|
|
6081
|
-
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/
|
|
6081
|
+
[src/Particle.js:1542-1546](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1542-L1546 "Source code on GitHub")
|
|
6082
6082
|
|
|
6083
6083
|
Update an OAuth client
|
|
6084
6084
|
|
|
@@ -6097,7 +6097,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6097
6097
|
|
|
6098
6098
|
### deleteOAuthClient
|
|
6099
6099
|
|
|
6100
|
-
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/
|
|
6100
|
+
[src/Particle.js:1558-1561](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1558-L1561 "Source code on GitHub")
|
|
6101
6101
|
|
|
6102
6102
|
Delete an OAuth client
|
|
6103
6103
|
|
|
@@ -6114,7 +6114,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6114
6114
|
|
|
6115
6115
|
### listProducts
|
|
6116
6116
|
|
|
6117
|
-
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/
|
|
6117
|
+
[src/Particle.js:1571-1573](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1571-L1573 "Source code on GitHub")
|
|
6118
6118
|
|
|
6119
6119
|
List products the account has access to
|
|
6120
6120
|
|
|
@@ -6129,7 +6129,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6129
6129
|
|
|
6130
6130
|
### getProduct
|
|
6131
6131
|
|
|
6132
|
-
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/
|
|
6132
|
+
[src/Particle.js:1584-1586](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1584-L1586 "Source code on GitHub")
|
|
6133
6133
|
|
|
6134
6134
|
Get detailed information about a product
|
|
6135
6135
|
|
|
@@ -6145,7 +6145,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6145
6145
|
|
|
6146
6146
|
### listProductFirmware
|
|
6147
6147
|
|
|
6148
|
-
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/
|
|
6148
|
+
[src/Particle.js:1597-1599](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1597-L1599 "Source code on GitHub")
|
|
6149
6149
|
|
|
6150
6150
|
List product firmware versions
|
|
6151
6151
|
|
|
@@ -6161,7 +6161,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6161
6161
|
|
|
6162
6162
|
### uploadProductFirmware
|
|
6163
6163
|
|
|
6164
|
-
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/
|
|
6164
|
+
[src/Particle.js:1615-1631](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1615-L1631 "Source code on GitHub")
|
|
6165
6165
|
|
|
6166
6166
|
List product firmware versions
|
|
6167
6167
|
|
|
@@ -6182,7 +6182,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6182
6182
|
|
|
6183
6183
|
### getProductFirmware
|
|
6184
6184
|
|
|
6185
|
-
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/
|
|
6185
|
+
[src/Particle.js:1643-1650](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1643-L1650 "Source code on GitHub")
|
|
6186
6186
|
|
|
6187
6187
|
Get information about a product firmware version
|
|
6188
6188
|
|
|
@@ -6199,7 +6199,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6199
6199
|
|
|
6200
6200
|
### updateProductFirmware
|
|
6201
6201
|
|
|
6202
|
-
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/
|
|
6202
|
+
[src/Particle.js:1664-1667](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1664-L1667 "Source code on GitHub")
|
|
6203
6203
|
|
|
6204
6204
|
Update information for a product firmware version
|
|
6205
6205
|
|
|
@@ -6218,7 +6218,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6218
6218
|
|
|
6219
6219
|
### downloadProductFirmware
|
|
6220
6220
|
|
|
6221
|
-
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/
|
|
6221
|
+
[src/Particle.js:1679-1688](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1679-L1688 "Source code on GitHub")
|
|
6222
6222
|
|
|
6223
6223
|
Download a product firmware binary
|
|
6224
6224
|
|
|
@@ -6235,7 +6235,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6235
6235
|
|
|
6236
6236
|
### releaseProductFirmware
|
|
6237
6237
|
|
|
6238
|
-
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/
|
|
6238
|
+
[src/Particle.js:1700-1703](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1700-L1703 "Source code on GitHub")
|
|
6239
6239
|
|
|
6240
6240
|
Release a product firmware version as the default version
|
|
6241
6241
|
|
|
@@ -6252,7 +6252,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6252
6252
|
|
|
6253
6253
|
### listTeamMembers
|
|
6254
6254
|
|
|
6255
|
-
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/
|
|
6255
|
+
[src/Particle.js:1714-1721](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1714-L1721 "Source code on GitHub")
|
|
6256
6256
|
|
|
6257
6257
|
List product team members
|
|
6258
6258
|
|
|
@@ -6268,7 +6268,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6268
6268
|
|
|
6269
6269
|
### inviteTeamMember
|
|
6270
6270
|
|
|
6271
|
-
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/
|
|
6271
|
+
[src/Particle.js:1733-1741](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1733-L1741 "Source code on GitHub")
|
|
6272
6272
|
|
|
6273
6273
|
Invite Particle user to a product team
|
|
6274
6274
|
|
|
@@ -6285,7 +6285,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6285
6285
|
|
|
6286
6286
|
### removeTeamMember
|
|
6287
6287
|
|
|
6288
|
-
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/
|
|
6288
|
+
[src/Particle.js:1753-1760](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1753-L1760 "Source code on GitHub")
|
|
6289
6289
|
|
|
6290
6290
|
Remove Particle user to a product team
|
|
6291
6291
|
|
|
@@ -6302,7 +6302,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6302
6302
|
|
|
6303
6303
|
### lookupSerialNumber
|
|
6304
6304
|
|
|
6305
|
-
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/
|
|
6305
|
+
[src/Particle.js:1771-1778](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1771-L1778 "Source code on GitHub")
|
|
6306
6306
|
|
|
6307
6307
|
Fetch details about a serial number
|
|
6308
6308
|
|
|
@@ -6318,7 +6318,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6318
6318
|
|
|
6319
6319
|
### createMeshNetwork
|
|
6320
6320
|
|
|
6321
|
-
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/
|
|
6321
|
+
[src/Particle.js:1791-1799](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1791-L1799 "Source code on GitHub")
|
|
6322
6322
|
|
|
6323
6323
|
Create a mesh network
|
|
6324
6324
|
|
|
@@ -6336,7 +6336,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6336
6336
|
|
|
6337
6337
|
### removeMeshNetwork
|
|
6338
6338
|
|
|
6339
|
-
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/
|
|
6339
|
+
[src/Particle.js:1810-1812](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1810-L1812 "Source code on GitHub")
|
|
6340
6340
|
|
|
6341
6341
|
Remove a mesh network.
|
|
6342
6342
|
|
|
@@ -6352,7 +6352,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6352
6352
|
|
|
6353
6353
|
### listMeshNetworks
|
|
6354
6354
|
|
|
6355
|
-
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/
|
|
6355
|
+
[src/Particle.js:1824-1827](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1824-L1827 "Source code on GitHub")
|
|
6356
6356
|
|
|
6357
6357
|
List all mesh networks
|
|
6358
6358
|
|
|
@@ -6369,7 +6369,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6369
6369
|
|
|
6370
6370
|
### getMeshNetwork
|
|
6371
6371
|
|
|
6372
|
-
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/
|
|
6372
|
+
[src/Particle.js:1838-1840](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1838-L1840 "Source code on GitHub")
|
|
6373
6373
|
|
|
6374
6374
|
Get information about a mesh network.
|
|
6375
6375
|
|
|
@@ -6385,7 +6385,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6385
6385
|
|
|
6386
6386
|
### updateMeshNetwork
|
|
6387
6387
|
|
|
6388
|
-
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/
|
|
6388
|
+
[src/Particle.js:1853-1861](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1853-L1861 "Source code on GitHub")
|
|
6389
6389
|
|
|
6390
6390
|
Modify a mesh network.
|
|
6391
6391
|
|
|
@@ -6403,7 +6403,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6403
6403
|
|
|
6404
6404
|
### addMeshNetworkDevice
|
|
6405
6405
|
|
|
6406
|
-
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/
|
|
6406
|
+
[src/Particle.js:1873-1882](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1873-L1882 "Source code on GitHub")
|
|
6407
6407
|
|
|
6408
6408
|
Add a device to a mesh network.
|
|
6409
6409
|
|
|
@@ -6420,7 +6420,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6420
6420
|
|
|
6421
6421
|
### removeMeshNetworkDevice
|
|
6422
6422
|
|
|
6423
|
-
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/
|
|
6423
|
+
[src/Particle.js:1894-1910](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1894-L1910 "Source code on GitHub")
|
|
6424
6424
|
|
|
6425
6425
|
Remove a device from a mesh network.
|
|
6426
6426
|
|
|
@@ -6437,7 +6437,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6437
6437
|
|
|
6438
6438
|
### listMeshNetworkDevices
|
|
6439
6439
|
|
|
6440
|
-
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/
|
|
6440
|
+
[src/Particle.js:1924-1933](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1924-L1933 "Source code on GitHub")
|
|
6441
6441
|
|
|
6442
6442
|
List all devices of a mesh network.
|
|
6443
6443
|
|
|
@@ -6456,7 +6456,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6456
6456
|
|
|
6457
6457
|
### getProductConfiguration
|
|
6458
6458
|
|
|
6459
|
-
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/
|
|
6459
|
+
[src/Particle.js:1944-1951](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1944-L1951 "Source code on GitHub")
|
|
6460
6460
|
|
|
6461
6461
|
Get product configuration
|
|
6462
6462
|
|
|
@@ -6472,7 +6472,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6472
6472
|
|
|
6473
6473
|
### getProductConfigurationSchema
|
|
6474
6474
|
|
|
6475
|
-
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/
|
|
6475
|
+
[src/Particle.js:1962-1970](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1962-L1970 "Source code on GitHub")
|
|
6476
6476
|
|
|
6477
6477
|
Get product configuration schema
|
|
6478
6478
|
|
|
@@ -6488,7 +6488,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6488
6488
|
|
|
6489
6489
|
### getProductDeviceConfiguration
|
|
6490
6490
|
|
|
6491
|
-
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/
|
|
6491
|
+
[src/Particle.js:1982-1989](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L1982-L1989 "Source code on GitHub")
|
|
6492
6492
|
|
|
6493
6493
|
Get product device's configuration
|
|
6494
6494
|
|
|
@@ -6505,7 +6505,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6505
6505
|
|
|
6506
6506
|
### getProductDeviceConfigurationSchema
|
|
6507
6507
|
|
|
6508
|
-
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/
|
|
6508
|
+
[src/Particle.js:2001-2009](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2001-L2009 "Source code on GitHub")
|
|
6509
6509
|
|
|
6510
6510
|
Get product device's configuration schema
|
|
6511
6511
|
|
|
@@ -6522,7 +6522,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6522
6522
|
|
|
6523
6523
|
### setProductConfiguration
|
|
6524
6524
|
|
|
6525
|
-
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/
|
|
6525
|
+
[src/Particle.js:2021-2029](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2021-L2029 "Source code on GitHub")
|
|
6526
6526
|
|
|
6527
6527
|
Set product configuration
|
|
6528
6528
|
|
|
@@ -6539,7 +6539,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6539
6539
|
|
|
6540
6540
|
### setProductDeviceConfiguration
|
|
6541
6541
|
|
|
6542
|
-
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/
|
|
6542
|
+
[src/Particle.js:2042-2050](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2042-L2050 "Source code on GitHub")
|
|
6543
6543
|
|
|
6544
6544
|
Set product configuration for a specific device within the product
|
|
6545
6545
|
|
|
@@ -6557,7 +6557,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6557
6557
|
|
|
6558
6558
|
### getProductLocations
|
|
6559
6559
|
|
|
6560
|
-
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/
|
|
6560
|
+
[src/Particle.js:2069-2086](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2069-L2086 "Source code on GitHub")
|
|
6561
6561
|
|
|
6562
6562
|
Query location for devices within a product
|
|
6563
6563
|
|
|
@@ -6581,7 +6581,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6581
6581
|
|
|
6582
6582
|
### getProductDeviceLocations
|
|
6583
6583
|
|
|
6584
|
-
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/
|
|
6584
|
+
[src/Particle.js:2103-2115](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2103-L2115 "Source code on GitHub")
|
|
6585
6585
|
|
|
6586
6586
|
Query location for one device within a product
|
|
6587
6587
|
|
|
@@ -6599,155 +6599,155 @@ Query location for one device within a product
|
|
|
6599
6599
|
|
|
6600
6600
|
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A promise
|
|
6601
6601
|
|
|
6602
|
-
###
|
|
6602
|
+
### createLogicFunction
|
|
6603
6603
|
|
|
6604
|
-
[src/Particle.js:2135-2143](https://github.com/particle-iot/particle-api-js/blob/
|
|
6604
|
+
[src/Particle.js:2135-2143](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2135-L2143 "Source code on GitHub")
|
|
6605
6605
|
|
|
6606
|
-
Creates a new logic
|
|
6606
|
+
Creates a new logic function in the specified organization using the provided function data.
|
|
6607
6607
|
|
|
6608
|
-
When you create a logic
|
|
6609
|
-
start being handled by the
|
|
6608
|
+
When you create a logic function with Event logic triggers, events will immediately
|
|
6609
|
+
start being handled by the function code.
|
|
6610
6610
|
|
|
6611
|
-
When you create a
|
|
6611
|
+
When you create a Scheduled logic trigger, it will immediately be scheduled at the next time
|
|
6612
6612
|
according to the cron and start_at properties.
|
|
6613
6613
|
|
|
6614
6614
|
**Parameters**
|
|
6615
6615
|
|
|
6616
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic
|
|
6616
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for creating the logic function.
|
|
6617
6617
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6618
6618
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
|
|
6619
|
-
- `options.
|
|
6619
|
+
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the function details.
|
|
6620
6620
|
- `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.
|
|
6621
6621
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
6622
6622
|
|
|
6623
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic
|
|
6623
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the created logic function data.
|
|
6624
6624
|
|
|
6625
|
-
###
|
|
6625
|
+
### getLogicFunction
|
|
6626
6626
|
|
|
6627
|
-
[src/Particle.js:2157-2164](https://github.com/particle-iot/particle-api-js/blob/
|
|
6627
|
+
[src/Particle.js:2157-2164](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2157-L2164 "Source code on GitHub")
|
|
6628
6628
|
|
|
6629
|
-
Get a logic
|
|
6629
|
+
Get a logic function in the specified organization by logic function ID.
|
|
6630
6630
|
|
|
6631
6631
|
**Parameters**
|
|
6632
6632
|
|
|
6633
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic
|
|
6633
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the logic function.
|
|
6634
6634
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6635
6635
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of the organization.
|
|
6636
|
-
- `options.
|
|
6636
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to retrieve.
|
|
6637
6637
|
- `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.
|
|
6638
6638
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
6639
6639
|
|
|
6640
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified logic
|
|
6640
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the specified logic function data.
|
|
6641
6641
|
|
|
6642
|
-
###
|
|
6642
|
+
### updateLogicFunction
|
|
6643
6643
|
|
|
6644
|
-
[src/Particle.js:2181-2189](https://github.com/particle-iot/particle-api-js/blob/
|
|
6644
|
+
[src/Particle.js:2181-2189](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2181-L2189 "Source code on GitHub")
|
|
6645
6645
|
|
|
6646
|
-
Updates an existing logic
|
|
6646
|
+
Updates an existing logic function in the specified organization using the provided function data.
|
|
6647
6647
|
|
|
6648
|
-
If you include an id on a
|
|
6648
|
+
If you include an id on a logic trigger, it will update the logic trigger in place.
|
|
6649
6649
|
|
|
6650
6650
|
**Parameters**
|
|
6651
6651
|
|
|
6652
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic
|
|
6652
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for updating the logic function.
|
|
6653
6653
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6654
6654
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
6655
|
-
- `options.
|
|
6656
|
-
- `options.
|
|
6655
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to update.
|
|
6656
|
+
- `options.logicFunction` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The logic function object containing the logic function details.
|
|
6657
6657
|
- `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.
|
|
6658
6658
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
6659
6659
|
|
|
6660
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the updated logic
|
|
6660
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the updated logic function data.
|
|
6661
6661
|
|
|
6662
|
-
###
|
|
6662
|
+
### deleteLogicFunction
|
|
6663
6663
|
|
|
6664
|
-
[src/Particle.js:2203-2210](https://github.com/particle-iot/particle-api-js/blob/
|
|
6664
|
+
[src/Particle.js:2203-2210](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2203-L2210 "Source code on GitHub")
|
|
6665
6665
|
|
|
6666
|
-
Deletes a logic
|
|
6666
|
+
Deletes a logic function in the specified organization by logic function ID.
|
|
6667
6667
|
|
|
6668
6668
|
**Parameters**
|
|
6669
6669
|
|
|
6670
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic
|
|
6670
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for deleting the logic function.
|
|
6671
6671
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6672
6672
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
6673
|
-
- `options.
|
|
6673
|
+
- `options.logicFunctionId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The ID of the logic function to delete.
|
|
6674
6674
|
- `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.
|
|
6675
6675
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
6676
6676
|
|
|
6677
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an object containing the deleted
|
|
6677
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an object containing the deleted logic function ID.
|
|
6678
6678
|
|
|
6679
|
-
###
|
|
6679
|
+
### listLogicFunctions
|
|
6680
6680
|
|
|
6681
|
-
[src/Particle.js:2223-2230](https://github.com/particle-iot/particle-api-js/blob/
|
|
6681
|
+
[src/Particle.js:2223-2230](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2223-L2230 "Source code on GitHub")
|
|
6682
6682
|
|
|
6683
|
-
Lists all logic
|
|
6683
|
+
Lists all logic functions in the specified organization.
|
|
6684
6684
|
|
|
6685
6685
|
**Parameters**
|
|
6686
6686
|
|
|
6687
|
-
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic
|
|
6687
|
+
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for listing logic functions.
|
|
6688
6688
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The authentication object with the API key.
|
|
6689
6689
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
6690
6690
|
- `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.
|
|
6691
6691
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context.
|
|
6692
6692
|
|
|
6693
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic
|
|
6693
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic functions data.
|
|
6694
6694
|
|
|
6695
|
-
###
|
|
6695
|
+
### listLogicRuns
|
|
6696
6696
|
|
|
6697
|
-
[src/Particle.js:2244-2251](https://github.com/particle-iot/particle-api-js/blob/
|
|
6697
|
+
[src/Particle.js:2244-2251](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2244-L2251 "Source code on GitHub")
|
|
6698
6698
|
|
|
6699
|
-
Lists all
|
|
6699
|
+
Lists all logic runs for the specified logic function.
|
|
6700
6700
|
|
|
6701
6701
|
**Parameters**
|
|
6702
6702
|
|
|
6703
6703
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
6704
6704
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6705
6705
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
6706
|
-
- `options.
|
|
6706
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic runs.
|
|
6707
6707
|
- `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.
|
|
6708
6708
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
6709
6709
|
|
|
6710
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of
|
|
6710
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic run data.
|
|
6711
6711
|
|
|
6712
|
-
###
|
|
6712
|
+
### getLogicRun
|
|
6713
6713
|
|
|
6714
|
-
[src/Particle.js:2266-2273](https://github.com/particle-iot/particle-api-js/blob/
|
|
6714
|
+
[src/Particle.js:2266-2273](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2266-L2273 "Source code on GitHub")
|
|
6715
6715
|
|
|
6716
|
-
Retrieves a
|
|
6716
|
+
Retrieves a logic run by its ID for the specified logic function.
|
|
6717
6717
|
|
|
6718
6718
|
**Parameters**
|
|
6719
6719
|
|
|
6720
6720
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
6721
6721
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6722
6722
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
6723
|
-
- `options.
|
|
6724
|
-
- `options.
|
|
6723
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run.
|
|
6724
|
+
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run to retrieve.
|
|
6725
6725
|
- `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.
|
|
6726
6726
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
6727
6727
|
|
|
6728
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of
|
|
6728
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to an array of logic run data for the specified logic run ID.
|
|
6729
6729
|
|
|
6730
|
-
###
|
|
6730
|
+
### getLogicRunLogs
|
|
6731
6731
|
|
|
6732
|
-
[src/Particle.js:2288-2295](https://github.com/particle-iot/particle-api-js/blob/
|
|
6732
|
+
[src/Particle.js:2288-2295](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2288-L2295 "Source code on GitHub")
|
|
6733
6733
|
|
|
6734
|
-
Retrieves the logs for a
|
|
6734
|
+
Retrieves the logs for a logic run by its ID for the specified logic function.
|
|
6735
6735
|
|
|
6736
6736
|
**Parameters**
|
|
6737
6737
|
|
|
6738
6738
|
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options for the request.
|
|
6739
6739
|
- `options.auth` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Access token
|
|
6740
6740
|
- `options.org` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The unique identifier of the organization.
|
|
6741
|
-
- `options.
|
|
6742
|
-
- `options.
|
|
6741
|
+
- `options.logicFunctionId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic function for which to retrieve the logic run logs.
|
|
6742
|
+
- `options.logicRunId` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** The ID of the logic run for which to retrieve the logs.
|
|
6743
6743
|
- `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.
|
|
6744
6744
|
- `options.context` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Request context
|
|
6745
6745
|
|
|
6746
|
-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the logs for the specified
|
|
6746
|
+
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<RequestResponse>** A promise that resolves to the logs for the specified logic run ID.
|
|
6747
6747
|
|
|
6748
6748
|
### createLedger
|
|
6749
6749
|
|
|
6750
|
-
[src/Particle.js:2310-2318](https://github.com/particle-iot/particle-api-js/blob/
|
|
6750
|
+
[src/Particle.js:2310-2318](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2310-L2318 "Source code on GitHub")
|
|
6751
6751
|
|
|
6752
6752
|
Creates a new ledger definition in the specified organization.
|
|
6753
6753
|
|
|
@@ -6765,7 +6765,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6765
6765
|
|
|
6766
6766
|
### getLedger
|
|
6767
6767
|
|
|
6768
|
-
[src/Particle.js:2332-2339](https://github.com/particle-iot/particle-api-js/blob/
|
|
6768
|
+
[src/Particle.js:2332-2339](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2332-L2339 "Source code on GitHub")
|
|
6769
6769
|
|
|
6770
6770
|
Get a ledger definition in the specified organization by ledger name.
|
|
6771
6771
|
|
|
@@ -6782,7 +6782,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6782
6782
|
|
|
6783
6783
|
### updateLedger
|
|
6784
6784
|
|
|
6785
|
-
[src/Particle.js:2354-2362](https://github.com/particle-iot/particle-api-js/blob/
|
|
6785
|
+
[src/Particle.js:2354-2362](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2354-L2362 "Source code on GitHub")
|
|
6786
6786
|
|
|
6787
6787
|
Updates an existing ledger definition in the specified organization.
|
|
6788
6788
|
|
|
@@ -6800,7 +6800,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6800
6800
|
|
|
6801
6801
|
### archiveLedger
|
|
6802
6802
|
|
|
6803
|
-
[src/Particle.js:2376-2383](https://github.com/particle-iot/particle-api-js/blob/
|
|
6803
|
+
[src/Particle.js:2376-2383](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2376-L2383 "Source code on GitHub")
|
|
6804
6804
|
|
|
6805
6805
|
Archives a ledger definition in the specified organization by ledger name.
|
|
6806
6806
|
|
|
@@ -6817,7 +6817,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6817
6817
|
|
|
6818
6818
|
### listLedgers
|
|
6819
6819
|
|
|
6820
|
-
[src/Particle.js:2396-2403](https://github.com/particle-iot/particle-api-js/blob/
|
|
6820
|
+
[src/Particle.js:2396-2403](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2396-L2403 "Source code on GitHub")
|
|
6821
6821
|
|
|
6822
6822
|
Lists all ledger definitions in the specified organization.
|
|
6823
6823
|
|
|
@@ -6833,7 +6833,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6833
6833
|
|
|
6834
6834
|
### getLedgerInstance
|
|
6835
6835
|
|
|
6836
|
-
[src/Particle.js:2418-2425](https://github.com/particle-iot/particle-api-js/blob/
|
|
6836
|
+
[src/Particle.js:2418-2425](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2418-L2425 "Source code on GitHub")
|
|
6837
6837
|
|
|
6838
6838
|
Get ledger instance data.
|
|
6839
6839
|
|
|
@@ -6851,7 +6851,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6851
6851
|
|
|
6852
6852
|
### setLedgerInstance
|
|
6853
6853
|
|
|
6854
|
-
[src/Particle.js:2442-2450](https://github.com/particle-iot/particle-api-js/blob/
|
|
6854
|
+
[src/Particle.js:2442-2450](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2442-L2450 "Source code on GitHub")
|
|
6855
6855
|
|
|
6856
6856
|
Set ledger instance data.
|
|
6857
6857
|
|
|
@@ -6871,7 +6871,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6871
6871
|
|
|
6872
6872
|
### deleteLedgerInstance
|
|
6873
6873
|
|
|
6874
|
-
[src/Particle.js:2465-2472](https://github.com/particle-iot/particle-api-js/blob/
|
|
6874
|
+
[src/Particle.js:2465-2472](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2465-L2472 "Source code on GitHub")
|
|
6875
6875
|
|
|
6876
6876
|
Delete a ledger instance in the specified organization by ledger name.
|
|
6877
6877
|
|
|
@@ -6889,7 +6889,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6889
6889
|
|
|
6890
6890
|
### listLedgerInstances
|
|
6891
6891
|
|
|
6892
|
-
[src/Particle.js:2486-2493](https://github.com/particle-iot/particle-api-js/blob/
|
|
6892
|
+
[src/Particle.js:2486-2493](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2486-L2493 "Source code on GitHub")
|
|
6893
6893
|
|
|
6894
6894
|
Lists ledger instances.
|
|
6895
6895
|
|
|
@@ -6906,7 +6906,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6906
6906
|
|
|
6907
6907
|
### setDefaultAuth
|
|
6908
6908
|
|
|
6909
|
-
[src/Particle.js:2500-2506](https://github.com/particle-iot/particle-api-js/blob/
|
|
6909
|
+
[src/Particle.js:2500-2506](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2500-L2506 "Source code on GitHub")
|
|
6910
6910
|
|
|
6911
6911
|
Set default auth token that will be used in each method if `auth` is not provided
|
|
6912
6912
|
|
|
@@ -6919,7 +6919,7 @@ Set default auth token that will be used in each method if `auth` is not provide
|
|
|
6919
6919
|
|
|
6920
6920
|
### get
|
|
6921
6921
|
|
|
6922
|
-
[src/Particle.js:2538-2542](https://github.com/particle-iot/particle-api-js/blob/
|
|
6922
|
+
[src/Particle.js:2538-2542](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2538-L2542 "Source code on GitHub")
|
|
6923
6923
|
|
|
6924
6924
|
Make a GET request
|
|
6925
6925
|
|
|
@@ -6936,7 +6936,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6936
6936
|
|
|
6937
6937
|
### head
|
|
6938
6938
|
|
|
6939
|
-
[src/Particle.js:2554-2558](https://github.com/particle-iot/particle-api-js/blob/
|
|
6939
|
+
[src/Particle.js:2554-2558](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2554-L2558 "Source code on GitHub")
|
|
6940
6940
|
|
|
6941
6941
|
Make a HEAD request
|
|
6942
6942
|
|
|
@@ -6953,7 +6953,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6953
6953
|
|
|
6954
6954
|
### post
|
|
6955
6955
|
|
|
6956
|
-
[src/Particle.js:2570-2574](https://github.com/particle-iot/particle-api-js/blob/
|
|
6956
|
+
[src/Particle.js:2570-2574](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2570-L2574 "Source code on GitHub")
|
|
6957
6957
|
|
|
6958
6958
|
Make a POST request
|
|
6959
6959
|
|
|
@@ -6970,7 +6970,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6970
6970
|
|
|
6971
6971
|
### put
|
|
6972
6972
|
|
|
6973
|
-
[src/Particle.js:2586-2590](https://github.com/particle-iot/particle-api-js/blob/
|
|
6973
|
+
[src/Particle.js:2586-2590](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2586-L2590 "Source code on GitHub")
|
|
6974
6974
|
|
|
6975
6975
|
Make a PUT request
|
|
6976
6976
|
|
|
@@ -6987,7 +6987,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
6987
6987
|
|
|
6988
6988
|
### delete
|
|
6989
6989
|
|
|
6990
|
-
[src/Particle.js:2602-2606](https://github.com/particle-iot/particle-api-js/blob/
|
|
6990
|
+
[src/Particle.js:2602-2606](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2602-L2606 "Source code on GitHub")
|
|
6991
6991
|
|
|
6992
6992
|
Make a DELETE request
|
|
6993
6993
|
|
|
@@ -7004,7 +7004,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
|
|
|
7004
7004
|
|
|
7005
7005
|
### request
|
|
7006
7006
|
|
|
7007
|
-
[src/Particle.js:2623-2627](https://github.com/particle-iot/particle-api-js/blob/
|
|
7007
|
+
[src/Particle.js:2623-2627](https://github.com/particle-iot/particle-api-js/blob/0237aa5d3bf7b659491c837cd6a405c0ba5e256f/src/Particle.js#L2623-L2627 "Source code on GitHub")
|
|
7008
7008
|
|
|
7009
7009
|
**Parameters**
|
|
7010
7010
|
|